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.
Copy the add-on common JAR file (named lib/ebx-addons.jar) in the EBX® class-path; it must be accessible from the ebx.jar class-loader.
Copy the add-on common WAR file (named wars/ebx-addon-common.war) in the application server webapps folder or EAR as EBX® built-in web applications.
If an add-on is used, copy the EBX® add-on WAR file (named wars/ebx-addon-<name>.war) in the same folder or EAR as EBX® built-in web applications.
See Web applications, Deployment details and Installation notes for more information.
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 panel.
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 you want to delete.
In the Actions menu, select Delete.
Stop the application server.
Add the deleted add-on's module name (ebx-addon-<name>) to the ebx.module.undeployedModules property in your ebx.properties file. See declaring modules as undeployed for more information.
Remove the add-on's WAR file (ebx-addon-<name>.war) from the application server's webapps folder, or its EAR file if used as an EBX® built-in web application.
Restart the application server.
Close and purge the Administration datasets and dataspaces related to the deleted add-on.
When an add-on is no longer deployed, a dataspace corresponding to the Administration dataset displays in the list of Reference children under the dataspaces. This makes it necessary to close/delete and manually purge all data/dataspaces related to the add-on.