Refer to the documentation of each add-on for additional installation and configuration information in conjunction with this documentation.
Each add-on bundle version is intended to run with a specific EBX® version and all its fix releases. Make sure that the EBX® and add-on bundle versions are compatible, otherwise the add-on registration will abort.
The web application deployment descriptor for the add-on module must specify that class definitions and resources from the web application are to be loaded in preference to classes from the parent and server classloaders.
For example, on WebSphere Application Server, this can be done by setting <context-priority-classloader>true</context-priority-classloader> in the web-app element of the deployment descriptor.
On WebLogic, include <prefer-web-inf-classes>true</prefer-web-inf-classes> in weblogic.xml.
See the documentation on class loading of your application server for more information.
The EBX® add-on common JAR file, named lib/ebx-addons.jar, must be copied in the library directory shared by all web applications.
The add-on log level can be managed in the main configuration file.
Registering an add-on makes its configuration available in the admin section. Add-on features are only available to end-users when the add-on is also activated.
To register a new EBX® add-on in the repository:
Navigate to the 'Administration' area.
Click the down-arrow in the navigation pane and select Technical configuration > Add-ons registration.
On the Registered add-ons page, click the + button to create a new entry.
Select the add-on you are registering.
Click on Save.
Unregistering an add-on will not delete any existing configuration, but will make it available in the UI until the add-on is registered again.
Activating an add-on makes its features available to the end-users. Only registered add-ons can be activated.
To activate an EBX® add-on in the repository:
Navigate to the 'Administration' area.
Click the down-arrow in the navigation pane and select Technical configuration > Add-ons registration.
Select the registered add-on you are activating and enable the 'Activation' field.
Click on Save.
To delete an add-on module from the EBX® repository:
Navigate to the 'Administration' area.
Click the down-arrow in the navigation pane and select Technical configuration > Add-ons registration.
On the Registered add-ons page, tick the box corresponding to the add-on to be deleted.
In the 'Actions' menu, select 'Delete'.
Close and purge the Administration datasets related to the previously used add-on, as well as the including dataspaces.
When an add-on is no longer deployed, a dataspace corresponding to the Administration dataset will then appear in the list of Reference children under the dataspaces. When an add-on module is no longer deployed, it is thus necessary to close/delete and purge manually all data/dataspaces related to the add-on.