Module Builder

The Module Builder is used for creating entirely new packages with multiple modules, which are then deployed in the DataEngine. The main functions of the Module Builder are the creation and configuration of new modules and packages. The Module Builder enables the creation of new modules and packages to develop customized data management solutions.

It is important to note that packages created with the Module Builder need to be deployed after saving. This ensures that the modules and packages you create are available in the DataEngine. However, be aware that the deployment action can reset any changes made in the Studio. Therefore, after making the first changes to a module in the Studio, you should not make any further adjustments to the corresponding package in the Module Builder and deploy it.

In addition to being deployed on the same instance, the created packages can also be downloaded and installed on other DataEngine instances. This allows you to use the modules and packages you create in different environments.

To access the Module Builder, navigate to the Admin area via the top navigation and select “Module Builder” under Developer Tools.

Check out the step-by-step guides for the core functions of the Module Builder:

• Create new packages
• Publish/export packages
• Duplicate packages
• Deploy packages
• Create new modules in packages
• Duplicate modules in packages
• Customize and configure modules

Here is a step-by-step guide for creating new packages in the Module Builder:

Step 1: Select “New Package”

• In the Module Builder, you will find the option to create a new package. Select this option to start the process.

Step 2: Assign a Name to the Package

• Give the package a name that is alphanumeric, begins with a letter, and contains no spaces. You have the option to edit this name at any time.

Step 3: Optionally Assign the Author’s Name

• If desired, you can add the name of the author who is creating the package.

Step 4: Choose a Key

• Set a 5-character alphanumeric key. Note that this key cannot be changed later.

Step 5: Optionally Provide a Brief Description of the Package’s Content

• If necessary, add a short description that explains the content or purpose of the package.

Step 6: Click “Save”

• After entering all the necessary information, click “Save” to create the new package.

Here is a step-by-step guide for publishing or exporting packages in the Module Builder:

Step 1: Open the Relevant Package

• Navigate to the package you want to publish or export by selecting it from the folder list or the central view in the Module Builder.

Step 2: Choose Between Publishing or Exporting

Decide whether you want to publish or export the package based on your use case.

• Publishing: Choose this option if you want to install the package on other DataEngine instances. Note that after publishing, the package can only be edited in the Studio.
• Exporting: Choose this option if you want to install the package on other DataEngine instances. Unlike publishing, the package can still be edited using the Module Builder after export.

By following these steps, you can successfully publish or export your packages in the Module Builder.

Here is a step-by-step guide for duplicating packages in the Module Builder:

Step 1: Open the Relevant Package

• Navigate to the package you want to duplicate by selecting it from the folder list or the central view in the Module Builder.

Step 2: Choose “Duplicate”

• After opening the package, select the “Duplicate” option. A new package will be created, which is an exact copy of the original package and can be edited immediately.

By following these steps, you can easily duplicate and further customize packages in the Module Builder.

Here is a step-by-step guide for deploying packages in the Module Builder:

Step 1: Open the Relevant Package

• Navigate to the package you want to deploy by selecting it from the folder list or the central view in the Module Builder.

Step 2: Ensure All Adjustments Are Saved

• Make sure that all adjustments made in the included modules have been saved.

Step 3: Save the Package

• To be sure, save the entire package again.

Step 4: Click “Deploy”

• Select the “Deploy” option to make the package available in your instance.

Step 5: Perform a “Quick Repair”

• Use the “Quick Repair” button in the top navigation bar to ensure that your package has been deployed correctly and all changes are effective.

By following these steps, you can ensure that your package is successfully deployed in the Module Builder.

Here is a step-by-step guide for creating new modules under a package in the Module Builder:

Step 1: Open the Relevant Package

• Navigate to the package where you want to create a new module by selecting it from the folder list or the central view in the Module Builder.

Step 2: Select “New Module”

• Click on the option to create a new module.

Step 3: Assign a Module Name

• Give the module a name. It must be alphanumeric, start with a letter, and contain no spaces. This value can be edited later.

Ttep 4: Assign a Label

Determine the name under which the module will be visible in the interface. This value can also be edited afterward.

Step 5: Import Settings

Decide if importing into this module should be generally possible. It is recommended to always activate this option, as it cannot be enabled later and the availability of import can also be controlled through permission management.

Step 6: Navigation Tabs

Enabled by default. Decides whether the module can be added as a navigation point in the menu.

Step 7: Select Type

Choose between Base and File:

• Base: Standard module with system fields that can be used to build any module.
• File: Module with preset functions for file uploads.

Step 8: Click “Save”

• Save the module and then begin configuring it.

By following these steps, you can successfully create and customize a new module under a package in the Module Builder.

Here is a step-by-step guide for duplicating a module under a package in the Module Builder:

Step 1: Open the Relevant Package

• Navigate to the package where the module you want to duplicate is located. You can do this through the folder list or the central view in the Module Builder.

Step 2: Select the Module to Duplicate

• Find the module you want to duplicate in the module list and select it.

Step 3: Click the “Duplicate” Button

• Click the “Duplicate” button to create a copy of the selected module.

By following these steps, you have successfully duplicated a module in the Module Builder. You can now further edit and customize the duplicated module.

In addition to the functions described above, you can also make further customizations in the Module Builder, similar to the Studio. However, all changes to packages in the Module Builder must be deployed; below is a list of available functions.

• Creation of Additional Fields:: Create new fields that become part of the core package and cannot be deleted from the Studio.
• Adjustment of Field Labels:: Adjust the labels of your fields. Note that in the Module Builder, you can only change labels upon creation. Adjustments of labels, including language variants via the list, are Studio customizations.
• Establishment of Relationships:: Create relationships between modules within a package. Relationships between modules across packages should be established via the Studio.
• Customization of Individual Layouts (Views):: Design the views of your modules so that everything is configured upon the deployment of the package.
• Customization of the Module’s Standard Subpanel:: In the Module Builder itself, you can only edit the standard subpanel, which is displayed under other modules when you create a relationship. The Studio guide for this is quite similar.