This documentation is for WSO2 ESB version 4.5.0. View documentation for the latest release.

Engaging and Disengaging Modules

A Module is an archive file that bundles a set of classes, related libraries and third party library dependencies. After uploading a module to the system, you can engage it to activate a module for your services. The WSO2 Carbon provides a user friendly interface to #engage, #disengage and configure modules.



Engaging Modules

If the module is not already engaged, use this option to engage the module.

Tip

The "WS-Addressing" module is always globally engaged.

Modules can be engaged on two levels:

  • Service level - A module will be engaged only for a certain service.
  • Global Level - A module will be engaged for all the services.

Follow the instructions below to engage a module on a global level.

1. Sign in. Enter your user name and password to log on to the ESB Management Console.

2. Click on "Main" in the left menu to access the "Manage" menu.

3. In the "Manage" menu, click on "List" under "Modules."

4. The "Deployed Modules" page appears.

5. Select a module to engage from the "Modules" list and click "Engage."

6. Click "OK" in the "WSO2 Carbon" window.

7. The engaged module appears in the "Globally Engaged Modules" list.


Disengaging Modules

If a module is already engaged, you can disengage this module.

Follow the instructions below to disengage a module on a global level.

1. Sign in. Enter your user name and password to log on to the ESB Management Console.

2. Click on "Main" in the left menu to access the "Manage" menu.

3. In the "Manage" menu, click on "List" under "Modules."

4. The "Deployed Modules" page appears.

5. Select a module to disengage from the "Modules" list and click "Disengage."

6. Confirm your request in "WSO2 Carbon" window. Click "Yes."

7. The window which confirms the disengagement appears. Click "OK."