Install and Manage Modules

A Module contains all the libraries files that are required to communicate with a given technology (SQL Databases, NoSQL Databases, Cloud Platforms…​). This includes JDBC drivers, API libraries, libraries dependencies, etc.

Modules are uniquely identified through their name and can be reused in multiple metadata.

When To Use Modules

Using a module is mandatory to communicate with any technology requiring some libraries for communication. The Semarchy xDI Designer will help you to select and create modules when necessary.

New Metadata

When creating a new metadata, if the related technology requires it, the creation wizard includes a step to select the Module to use. For more details, refer to Create a Metadata.

Existing Metadata

The module used by a metadata can be edited by modifying the Module property in the Properties view of the root node of this metadata.

The Metadata Modules Manager assigns a module to a set of metadata.

Scripting Process Actions

If a Scripting Process Action requires additional libraries, a module can be selected from the Properties view of this action.

Manage Modules

You can review and edit modules using the Module Manager.

To access it, go to Utilities  Module Manager. Modules Manager

Create new modules

To create a new module:

  1. Click the Module creation button button. The Module Selection/Creation window opens.

  2. Select a module Type.

  3. In the Details panel, add any required libraries by selecting them from the Third Party Pack dropdown, or click the add library button to add a new user library from disk.

  4. Click Finish.

Review or edit modules

To review and edit an existing module:

  1. Double-click the module’s name in the Modules list of the Module Manager. The Module Selection/Creation window opens.

  2. Review the list of libraries in the Details panel.

  3. To add a new user library, click the add library button button.

  4. To remove a user library, select it from the Users Files section of the libraries list and click the remove library button button.

Delete modules

To delete a module: Select it from the modules list of the Module Manager and then click the remove module button button.

Missing libraries

When adding or editing a module, the Module Selection/Creation window shows the following message if more software libraries are needed for the module to run:

This module requires additional libraries, please select a third party pack if available and / or add libraries manually.

Many modules are bundled with in xDI components, and can be selected from the Third Party Pack dropdown list in the Details panel. However, some libraries cannot be included in xDI components for licensing reasons. They may be found on vendor website for that technology, or bundled with the technology itself.

After retrieving a third-party library, add it by clicking the add library button button in the Details panel.