Cloud Software Group, Inc. EBX®
Documentation > Administration Guide > Installation & configuration
Navigation mode Documentation > Administration Guide > Installation & configuration

# Managing TIBCO EBX® add-ons

## Overview

The following sections cover:

- Add-on compatibility

- Deploying an add-on module

- Registering an add-on module

- Activating an add-on module

- Deleting an add-on module

Refer to each add-on's documentation for instructions on configuring and using the add-on.

## Add-on compatibility

Each Add-on Bundle is compatible with specific versions and fix releases of EBX®. However, beginning with version 6.1.0, the major and minor versions of add-ons and EBX® must be the same. For example, EBX® version 6.1.0 is only compatible with add-ons that are also version 6.1.0. If this is not the case, add-on registration is aborted. For other releases, the TIBCO EBX® Add-ons Versioning and Packaging Guide includes a version compatibility matrix. Go to the official documentation site and use the Bundle version menu to view the version of this guide that corresponds with your Add-on Bundle.

## Deploying an add-on module

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.

##### Note

The add-on log level can be managed in the main configuration file.

## Registering an add-on module

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:

1. Navigate to the 'Administration' area.

2. Click the down-arrow in the navigation pane and select Technical configuration > Add-ons registration.

3. On the Registered add-ons page, click the + button to create a new entry.

4. Select the add-on you are registering.

5. Click on Save.

##### Note

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 module

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:

1. Navigate to the 'Administration' area.

2. Click the down-arrow in the navigation pane and select Technical configuration > Add-ons registration.

3. Select the registered add-on you are activating and enable the 'Activation' field.

4. Click on Save.

## Deleting an add-on module

To delete an add-on module from the EBX® repository:

1. Navigate to the Administration panel.

2. Click the down-arrow in the navigation pane and select Technical configuration > Add-ons registration.

3. On the Registered add-ons page, tick the box corresponding to the add-on you want to delete.

4. In the Actions menu, select Delete.

5. Stop the application server.

6. 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.

7. 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.

8. Restart the application server.

9. 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.

Documentation > Administration Guide > Installation & configuration