Modules

Location: Site Configuration > Site Configuration > Modules

An EBMS site consists of modules. This section looks at the general module management from the site-wide perspective. That involves creating new modules, translating module names into different site languages, making modules inactive (or making inactive modules active again), as well as exporting active modules from the site to XML format and importing them back again.

All modules that you create are listed on the page where you can sort them by any of the criteria specified when creating a module (i.e. the name of the module, type of the module, the module’s sort order on the Portal page), as well as by the name of the user who created a particular module and the date when it was created.

Create Module

To add a new module to your site, follow these steps:

1. On the toolbar, click Create Module.

2. In the dialog box that opens, select the type of the module in the Type list.

3. In the Name box, type a name for the module.

4. In the Sorting selectbox, type a number that will determine the position of the module among other modules on the Portal page.

5. If you have chosen type “Module” (the most frequently used), you can also specify the Template. 

The template allows to create module with some predefined settings. It is possible to select from 2 configuration templates on Module creation, that define whether the module will contain media data or not. Note, that Module can be reconfigured later if needed.

Change Module Sort Order

New created modules are placed in the bottom of the list.

Changing of module sort order is possible by using "Change Sort Order" button or Up/Down arrows in modules list.

“Change Sort Order” button opens a pop-up window with a table with 2 columns: input box for order index and Name of a module, and Re-Number, Cancel, OK buttons.

Re-Number button resorts modules but doesn't save resorted list, OK button resorts modules, save the result and closes the window

Make Module Inactive  

Some of the modules you create may become obsolete with time when you no longer need them. So as not to clutter your site with such useless modules, you can “hide” them by making them inactive. Inactive module are not available to the user and do not appear on the Portal page.

To make an active module inactive, follow these steps:

1. Click the Edit icon next to the module that you want to make inactive.

2. In the dialog box that opens, click Make Inactive on the toolbar.

Inactive modules are listed on a separate tab, where their names appear highlighted in red, to indicate their ’inactive’ status. Note that you can edit the settings of inactive modules and sort them on the page just like you do active modules.

Re-activate Module

If a module that you have once made inactive happens to be useful again, you can “revive” it by making it active. To make an inactive module active again, go to the Inactive Modules tab, locate the module you want to reactivate, click the Edit icon next to it, and then click Re-activate Module on the toolbar of the dialog box that opens.

You can edit the settings of both active and inactive modules. To edit the settings of a module, follow these steps:

1. Click the Edit icon next to the name of the module that you want to edit.

2. In the dialog box that opens, make your changes and click OK to save them.

Delete Module

It is possible to delete obsolete modules on corresponding site that are not in use for some period of time.The main difference between inactivation and deletion of modules is that you won't be able to reactivate and "show" deleted module in system as well as all associated data and files will be cleaned up after module deletion to not overload file system and DB.

Active and Inactive modules can be deleted.

To delete module, follow these steps:

1. Click the Edit icon next to the module that you want to delete

2. In the dialog box that opens, click Delete Module on the toolbar.

3. Submit module deletion in modal

Note: You should be aware that module deletion will clear associated files and data and may impact entities in webapp that  are connected with or referenced to the deleted module!

Export/Import Modules

You can export and import active modules of a site in the form of XML files. To export one or more modules, follow these steps:

1. On the toolbar, click Export Modules.

2. In the dialog box that opens: 

   • To download generated XML file: select the checkboxes next to the modules that you want to export, and then click OK;

   • To save XML as Blueprints: elect the checkboxes next to the modules that you want to export and the checkboxes next to the "Save as Blueprint", enter name of the Blueprint, and then click OK.

   

To import modules, follow these steps:

1. On the toolbar, click Import Modules.

2. In the dialog box that opens

   1. To import module from the uploaded XML file: specify the path to the XML file containing the module(s) that you want to import, or click From File to locate the file, and then click Import;

   2. To import module from Blueprints list: click From Blueprint, select Blueprint from the list, and then click Import.

   

If imported XML/Blueprint doesn't have enough data to recreate all structure (e.g., there are calculations or module links, pointed to another, not included in the xml, module or Access Rights etc) - then User has to match them on real entities from the site/system which the xml importing to.

After the matching, import starts.

Blueprint: Metadata Module

New checkbox "Metadata" is added to Module settings.

If a Metadata module is selected in the Export window, the config of the module will be exported along with its data (file fields values are out of scope). Files with data are exported together with config xml file as a zip archive. If the zip file is uploaded to import, config and data of included modules will be imported.

If there are ModuleLinkOptions in configuration, they are always included in config xml. If those ModuleLinkOptions are items from a Metadata module and the Metadata module is exported too (with data), then ModuleLinkOptions items will be imported first, then all other items from the Metadata module will be imported.

Metadata module items are exported as an xml file (individual for every Metadata module) and imported to the corresponding new target module by Encodify usual FieldImport engine.

Blueprint: UMM custom fields

There is a checkbox "Export Custom UMM Fields" in Export Modules window. It appears if UM Module is configured for the site and it has Custom fields.

•  If "Export Custom UMM Fields" is checked, all UMM Custom fields are exported inside  xml node.

• If "Export Custom UMM Fields" is not checked, only linked UMM Custom fields are exported inside  xml node (those have fields in exported module linked to). So, if there are linked Custom UMM Fields they always are exported.

There is a checkbox "Import Custom UMM Fields" in Import Modules window, above Matching Entities section. It appears if UMM configured in the target site and import xml has all Custom fields (not only linked).

• If UMM Custom field should be imported (there is in xml) but the same field already exists in the target site UMM, field copy is not created. "The same field" means "the same name, Field Type and Field Data". If only names are equal, a new field is created (imported) with a suffix like "(1)". 

• If "Import Custom UMM Fields" is not checked, only linked UMM Custom fields from  xml node are imported to target site UMM ("linked" means if field from imported module has link to UMM).

• if UMM configured in the target site and import xml has only linked Custom fields, then "Import Custom UMM Fields" checkbox doesn't appear, all linked Custom fields are imported automatically.

• if UMM is not configured in the target site and import xml has UMM config with Custom fields, then not linked Custom fields are ignored, but linked Custom fields are shown in Matching Entities list. User can assign them to the right field in the right module.

• If the imported module has a link to a Custom UMM field and an option of this field is used in imported module configuration - in this case, the Custom UMM field can't be automatically created during import because OptionModuleLink should be created too. OptionModuleLink is an item in linked module and can't be created (at least in the current implementation), only configuration can be created, not data. Therefore, both, Linked Field Definition and OptionModuleLink (item) should be matched by Configurator during import. Doesn't matter if Linked Field is in UMModule or in a regular module. If OptionModuleLink (item) doesn't exist in External Entities list, Linked Field Definition can be created automatically during import. 

• if User selects UMM as a usual module and exports it, it will be imported as the usual module, not like UMM. To see "Import Custom UMM Fields" checkbox in the described scenario, don't export UMM from the source site as a usual module (uncheck checkbox near Users module in the list of modules for export).

If the purpose to move the whole site with all modules + UMM to a new one:

Steps-1

1. Go to Site Configuration > Modules > Click on Export Modules button

2. Select all the modules EXCEPT module "Users" > Select "Export Custom UMM Fields" checkbox > Export

3. Create new site >  Enable UMM in it

4. Go to Site Configuration > Modules > Click on

Steps-2:

1. Export all the modules from the site with "Export Custom UMM Fields" checkbox selected.

2. Create a new site ( don't enable UMM on it! ).

3. Import exported modules on the site. After import, enable the imported Users module as UMM on the target site.

"Import Custom UMM Fields" checkbox appears if UMM from the exported site should be merged with UMM on the target site.
If UMM should only be copied to the target site, it should be exported and imported as a usual module and later configured as UMM on the target site.

Note! Next sections in Module settings are still not covered by export/import:

• Field Dependencies

• Proofing

• External File Structure

• Menu Elements: file area

• Comments

• Email Notification

• Actions "Send to connected service", "Scheduled report", and "Notification by query"

• Print Templates

• Workflow: CopyTo mapping; User Groups (only Access Rights are done)

• AdBuilder settings

• Briefing settings

• Access right settings for Apps

• Access right settings for Rules

Limitations:

1. Action Filters with Titles, Divisions, Users, Regions, Sub Regions, and Countries should be completed after import manually by Configurator. Аfter import, this Filter will not appear in Action Filters and should be created manually;

2. Module with Enabled Order Basket with Module Storage can be imported to the site where such module already exist. So there will be 2 modules with enabled Order Basket although only one such module can be created manually. Option "Enable Order Basket with Module Storage" should be disabled in one of the modules manually by Configurator after import;

3. For HTTP Actions:

   1. HTTP_AUTHENTICATE_WITH_CONNECTED_SERVICE property always should be completed manually after import;

   2. HTTP_URL is always exported as an empty string, it should be changed after import manually by Configurator;

4. Only xml structure of Import Settings can be exported/imported: Template File is exported, no data from Template File;

5. "Send to connected service" actions cannot be exported/imported;

6. Empty date format replaces by null in Import settings of imported module;

7. Scheduled Import action cannot be exported/imported with other module settings;

8. Some modules cannot be imported (Error executing SQL task);

9. Error occurs on exporting modules from some sites (NullPointerException);

10. Imported rules contain incorrect information;

11. Incorrect number of items get exported if Link to item was used in various configuration settings;

12. Item is missing in the actions filter of the imported module if contains empty fields.

Translate Module Names

If you need module names to be translated to the language that you specify in Site Settings or User Settings, you can enter translations of module names by entering translated name of each module for English or Danish language.

To enter translations for module names follow the below described steps:

1. Go to Site Configuration>Site Configuration>Modules.

2. On the top bar, click Module Name Translations.

3. In the Translation window that opens, there are two tabs where you enter translations for module names for two languages English and Danish.

4. Click the tab with the language you want to enter module translations for. On the left pane you will see the list of module names in the original language. Enter the translation to the required language for each module name on the left pane.

5. Click Save Translations. Now that the translations are created, you will have module names translated when you change the language for the site or a user.