34 Setting Up IM-WS

This chapter describes how to set up an IM-WS interworking module.

About IM-WS

IM-WS is a network-facing module that enables Oracle Communications Service Broker to receive messages from, and send messages to, Web services using Simple Object Access Protocol (SOAP) or Representative State Transfer (REST) protocol.

In conjunction with application-facing modules, IM-WS provides a solution for routing messages from applications to Web services.

IM-WS communicates with Web services as follows:

• Sending messages from IM-WS to a Web service:

  IM-WS receives a SAL message from an application-facing IM. For example, it might be an event notification submitted by an application and translated to the SAL format by an application-facing IM. IM-WS translates this message into a SOAP or REST message and send it to a Web service through the WS SSU.

  See the discussion on configuring the Web Services Signaling Server Unit in Oracle Communications Service Broker Signaling Server Units Configuration Guide for more information about setting up rules for routing messages to Web services.

• Sending messages from a Web service to IM-WS:

  IM-WS receives a SOAP message sent by a Web service through the WS SSU. IM-WS translates this message from SOAP or REST to a SAL message and sends it to the OE. The OE routes the message to an appropriate IM based on the orchestration logic.

  See the discussion on configuring the Web Services Signaling Server Unit in Oracle Communications Service Broker Signaling Server Units Configuration Guide for more information about setting up rules for routing messages to IM-WS instances.

To set up the communication between Web services and IM-WS, you need to configure the following parameters:

• Web service parameters, which define the Web service to which IM-WS sends a message. See "Configuring the Web Service Parameters" for more information.

• Monitoring parameters of IM-WS. See "Configuring Monitoring Parameters" for more information.

About IM-WS Setup

The process of IM-WS setup requires the following:

1. Adding an IM-WS to your Service Broker deployment. You can add as many modules of type IM-WS as you need. See "Adding an IM-WS to the Service Broker Deployment" for more information.

2. Configuring the IM-PSX GSM MAP. See the following sections for more information:

   • Configuring the Web Service Parameters

   • Configuring Monitoring Parameters

Adding an IM-WS to the Service Broker Deployment

To add an IM-WS:

1. In the domain navigation pane, expand the OCSB node.

2. Expand the Processing Tier node.

3. Expand the Interworking Modules node.

4. Select IM Management.

5. On the bottom of the IM Management pane, click New.

6. In the New window, fill out the fields as follows:

   • In the Type list, select IMWS.

   • In the Version list, select the required version.

   • In the Name field, enter a name for this module as it should appear in the list of modules. In this field, you can only use lower case letters (a-z), upper case letters (A-Z), numbers (0-9), and underscores (_). If you attempt to use a character which is not allowed, Service Broker displays the error message and prompts you to enter a different name.

7. Click OK.

8. In the notification window that reminds you to commit the changes, click OK.

9. To add the new IM-WS to your deployment, in the Change Center pane, click Commit.

   A new module of type IM-WS is now added to your Service Broker deployment. The new module is displayed in the domain navigation pane under the Interworking Modules node.

Configuring the Web Service Parameters

To route a message sent by an application to a Web service and translated to the SAL format by an application-facing IM, IM-WS translates the SAL message into a SOAP or REST message. You can specify the parameters that IM-WS sets in the SOAP or REST message using the Administration Console.

To configure Web service parameters:

1. In the domain navigation pane, expand OCSB.

2. Expand Processing Tier.

3. Expand Interworking Modules.

4. Select the instance of IM-WS that you want to configure.

   The IM-WS configuration pane appears.

5. In the IM-WS configuration pane, click the Web Service tab.

6. Fill in the fields described in Table 34-1.

   Table 34-1 Web Service Parameters

   Field	Descriptions
   Web Service Alias	Specifies the address of the Web service to which IM-WS sends the request. Service Broker resolves the alias into a physical address of a Web service based on the configuration of outgoing routing rules of the WS SSU. See the discussion on configuring the Web Services Signaling Server Unit in Oracle Communications Service Broker Signaling Server Units Configuration Guide.
   Web Service Type	Specifies the type of the Web service to which IM-WS sends the request. Possible values: SOAP REST Default value: SOAP
   Web Service Body Type	Specifies the content type of the message body that IM-WS sends. If the message is an event notification, set this parameter to eventnotification.

   
   

Configuring Monitoring Parameters

The Monitoring tab enables you to define how Runtime MBeans and notifications operate for an IM-WS. For more information about configuring monitoring, see "Configuring Service Broker Monitoring" in "Monitoring Service Broker Using Runtime MBeans" in Oracle Communications Service Broker System Administrator's Guide.