Installing Adapters and Plugins Manually

Adapters that are not included as standard, as well as adapters or plugins that you have created yourself, can be installed manually in X4 BPMS.

How to install adapters manually

1. Unpack the ZIP folder of the adapter.

2. Copy the folder of the adapter to the <server_directory>\wildfly\modules\de\softproject\x4\adapter folder.

3. Make sure that the <resource-root path="" /> paths in the <resources> element in the module.xml file in the <server_directory>\wildfly\modules\de\softproject\x4\adapter\<name of the adapter>\main folder match the names in the *.jar files.
   Example using the BAM Log Adapter:

   1. Names of the *.jar files:

      

   2. Content of the module.xml file:

      

4. Add the adapter name to the module.xml file in the <server_directory>\wildfly\modules\de\softproject\plugins\main folder:

   1. Open the module.xml file in the folder <server_directory>\wildfly\modules\de\softproject\plugins\main.

   2. Copy the adapter name in the <dependencies> tag:

      <module name="de.softproject.x4.adapter.<name of the adapter>" export="true"/>

Note on the path and name of the adapter in the module.xml file:

The path below <server_directory>\wildfly\modules... corresponds dot-separated instead of slash-separated to the name of the adapter in the module.xml file.

Example:

Path: <server_directory>\wildfly\modules\de\softproject\x4\adapter​\CustomAdapter

Name of the adapter in the module.xml file: de.softproject.x4.adapter.CustomAdapter

c. Save the module.xml file.

5. Start Keycloak, the X4 Server, and the X4 Designer.

The adapter can now be selected and used in the X4 Designer.

Note on the subfolders in <server_directory>\wildfly\modules\de\softproject