Engaging and Disengaging Modules

After adding a module to the system, you can engage it to activate a module for your services. WSO2 Carbon provides a user friendly interface to engage and disengage modules.

Modules can be engaged on two levels:

• Global Level - Engaged for all services.
• Service Level - Engaged only for a certain service.
• Operation Level - Engaged only for a certain operation.

Global-Level Module Engagement/Disengagement

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

1. Log on to the product's management console and select Modules -> List in the Main tab.

2. The Deployed Modules page appears. Select a module to engage from the Modules list and click Engage.

3. Click OK.

4. The engaged module appears in the Globally Engaged Modules list.

5. Once engaged, the module can be disengaged simply by clicking the disengage link associated with each engaged module.

6. Confirm your request by clicking Yes.

If successful, you will get a disengagement confirmation message.

Service-Level Module Engagement/Disengagement

Modules can be engaged to a selected service through the service's dashboard. Follow the instructions below to engage modules to a service.

1. Log on to the product's management console and select List under Services.

2. The Deployed Services screen appears. Click on the necessary service. For example,

3. The Service Dashboard page appears. Click Modules in the Quality of Service Configuration panel.

4. The Engage Modules to Service page appears. From that, choose a module to add. The module management feature provides the following modules, which you can engage into your service:

• WSO2xfer-3.20 - Is an implementation of WS-Transfer.
• WSO2mex-3.20 - Provides MetadataExchange services for any services that the module is engaged.
• rampart-1.61-wso2v1 - Provides the WS-Security and WS-SecureConversation functionalities for Axis2, based on Apache WSS4J, Apache XML-Security and Apache Rahas implementations.
• rahas-1.61-wso2v1 - Is used to STS enable a service, where it adds the RequestSecurityToken operation to a service that the module is engaged to.
• sandesha2-3.20 - Implements WS-Reliable Messaging.

5. Click on the Engage button to add a module to the list of Currently Engaged Modules.

6. Once engaged, the module can be disengaged by clicking the icon before each engaged module in the Currently Engaged Modules panel.

7. Confirm your request by clicking Yes.

If successful, you will get a disengagement confirmation message.

Operation-Level Module Engagement/Disengagement

Modules can be engaged for a selected operation through the service dashboard of a selected service. Follow the instructions below to access and engage operation-level modules.

1. Log on to the product's management console and select List under Services.

2. The Deployed Services page appears. Click on a service to view its dashboard. For example,

3. The Service Dashboard page appears. Click Operations in the Quality of Service Configuration panel.

4. The Operations of Service page appears.

5. Click one operation to view its Operation Dashboard page and select the Modules link in the Quality of Service Configuration panel in the operation's dashboard.

6. The Engage Module to Operation window appears using which you can engage modules.

7. Once engaged, the module can be disengaged by clicking the icon before each engaged module in the Currently Engaged Modules panel.

8. Confirm your request by clicking Yes.

If successful, you will get a disengagement confirmation message.