5 Managing Interworking Modules

Each deployment of Oracle Communications Service Broker is a composition of various interworking modules, as required by the specific solution. This chapter describes how you can deploy, activate, and deactivate interworking modules in your deployment:

• Managing Interworking Modules with the Administration Console

• Managing Interworking Modules with JavaMBeans

• Defining a Default IM-ASF Module

Managing Interworking Modules with the Administration Console

You can manage Interworking Modules, including adding, activating, deactivating, and removing Interworking Module instances, by using the IM Configuration screen.

Accessing the IM Management Configuration Screen

To access the IM Management Configuration screen:

• On the Domain Navigation pane, select OCSB > Processing Tier > Interworking Modules > IM Management. The IM Configuration screen is displayed in the Configuration pane.

The IM Management Configuration screen displays a list of Interworking Module instances deployed in the system. Information about each module instance is presented in the fields described in Table 5-1:

Table 5-1 Configuration Page Fields

Field	Description
Instance Name	Specifies a name of the module instance
Module Type	Specifies a type of the module instance and a protocol that the module instance uses. A module type has the following format: <module>_<protocol>. Possible values: IMSCFCAP1 IMSCFCAP2 IMSCFCAP3 IMSCFCAP4 IMSCFWIN1 IMSCFWIN2 IMSCFINAP IMSCFAIN01 IMSCFAIN02 IMASF RIMASF IMOCF IMSSFCAP1 IMSSFCAP2 IMSSFCAP3 IMSSFWIN1 IMSSFWIN2 IMSSFINAP IMSSFAIN01 IMSSFAIN02
Version	Specifies a version of the module instance
State	Specifies a state of the module instance. Possible values: Active Inactive

The IM Configuration screen enables you to perform the following actions:

• Adding a new Interworking Module instance

• Activating an Interworking Module instance

• Deactivating an Interworking Module instance

• Removing an Interworking Module instance

  Note:

  After adding a new Interworking Module you have to first click the Commit button in the Change Center before you can start configuring the Interworking Module.

Managing Interworking Modules with JavaMBeans

Service Broker provides a set of MBeans that exposes attributes and operations for configuring interworking modules through JMX shown on Figure 5-1.

Figure 5-1 Interworking Modules Management MBean Hierarchy

The following sections provide reference information for the interworking modules management configuration MBeans.

DeploymentsMBean

DeploymentsMBean is a container for instances of DeploymentMBean. Each instance of DeploymentMBean represents an individual interworking module.

Factory Method

Created automatically

Attributes

None

Operations

void addDeployment(string ModuleName, string Version, string Name)

Adds a new instance of an interworking module. Table 5-2 explains the parameters with which you need to invoke the operation.

Table 5-2 Parameters Required to Create a Deployment

Parameter	Description
ModuleName	Specifies a type of the module instance and a protocol that the module instance uses. A module type has the following format: <module><protocol>. Possible values: IMSCFCAP1 IMSCFCAP2 IMSCFCAP3 IMSCFCAP4 IMSCFWIN1 IMSCFWIN2 IMSCFINAP IMSCFAIN01 IMSCFAIN02 IMASF RIMASF IMOCF IMSSFCAP1 IMSSFCAP2 IMSSFCAP3 IMSSFWIN1 IMSSFWIN2 IMSSFINAP IMSSFAIN01 IMSSFAIN02
Version	Specifies a version of the module instance
InstanceName	Specifies a unique name for the interworking module instance.

void removeDeployment(string ModuleName, string Version, string ModuleInstanceName)

Removes an instance of an interworking module. For more information on the parameters required for this operation, see Table 5-2.

void activateDeployment(string ModuleName, string Version, string ModuleInstanceName)

Activate an instance of an interworking module. For more information on the parameters required for this operation, see Table 5-2.

void deactivateDeployment(string ModuleName, string Version, string ModuleInstanceName)

Deactivates an instance of an interworking module. For more information on the parameters required for this operation, see Table 5-2.

DeploymentMBean

Each instance of DeploymentMBean represents an individual interworking module and defines configuration parameters for this module.

Factory Method

Deployments.addDeployment()

Attributes

• DeploymentStatus

• Family

• Name

• Version

For more information on these attributes, see Table 5-1.

Operations

void activate()

Activates the instance of an interworking module

void deactivate()

Deactivates the instance of an interworking module

Defining a Default IM-ASF Module

It is recommended to have a special instance of IM-ASF, a default IM-ASF instance named "IMASF_default", in every system.

To understand why you should create a default IM-ASF module instance, see "Supporting Orchestration with Non-Configured Application".

IM-ASF enables Service Broker to interact with an application. Typically, one instance of IM-ASF can interact with one application. You can define an application with which an instance of IM-ASF communicates by defining the alias of this application address.

When the Orchestration Engine needs to route a session to an application, one of the following can happen:

• The Orchestration Engine needs to route the session to an application registered in Service Broker.

  In this case, the Orchestration Engine routes the session through an IM-ASF instance which is specifically configured to communicate with the registered application.

  When receiving the session, the IM-ASF instance forwards the session to the registered application.

• The Orchestration Engine needs to route the session to an application that is not registered in Service Broker.

  In this case, the Orchestration Engine routes the session through a special default IM-ASF instance named "IMASF_default".

  The role of the default IM-ASF is to forward sessions, which are intended to non-registered applications, the application address specified inside the session request, in the application address field.

To define the special instance of default IM-ASF, use the IM Management configuration screen or the DeploymentsMBean, and create a new module instance of type "IMASF" and name "IMASF_default".