Instant Messaging Adapter Suite

Implementing the IM Adapter Suite

Default Grammar File

The provided grammar file for the IM adapter is an XML-format file that describes the behavior of the IM Command Processor service. The file, grammar.xml, is located in the data/xmpp directory of your Sterling B2B Integrator installation directory.

You can copy and modify this file as necessary in order to define the commands to be used. This enables the Command Processor to match the correct business processes to commands received in an IM session. If you use a different grammar file or change the location of the file, you must modify the IMCommandProcessor business process to reflect the filename or path change.

The contents of the default grammar file are as follows:

<grammar> 
<pattern value="get [a-z]* log" result="IM_GET_LOG"/> 
<pattern value="show [a-z]*" result="IM_SHOW_COMMAND"/> 
<pattern value="bye" result="IM_EXIT"/> 
<pattern value="default" result="IM_DEFAULT"/> 
</grammar> 

Example Commands

The following table provides examples of commands that will execute the IM_GET_LOG business process and commands that will not:

Configuring Instant Messaging Adapter Suite Services

Several of the IM Adapter Suite services require configuration.

Configuring the IM Begin Session Service

To configure the IM Begin Session service, you must specify field settings in Sterling B2B Integrator:

Configuring the IM Begin Chat Service

To configure the IM Begin Chat service, you must specify field settings in the GPM:

Configuring the IM Send Message Service

To configure the IM Send Message service, you must specify field settings in the GPM:

Configuring the IM Grammar Loader Service

To configure the IM Grammar Loader service, you must specify field settings in the GPM:

Configuring the IM Command Processor Service

To configure the IM Command Processor service, you must specify field settings in the GPM:

Instant Messaging Adapter Suite Business Processes

The following table describes the predefined business processes associated with the IM Adapter Suite:

Example Business Process Models

This section contains two examples, a simple connect-chat-disconnect business process that you can build and use to test your IM connections, and a more complex example.

Business Process Example 1 – Simple

The following figure shows the business process in the Graphical Process Modeler:

The BPML for the business process would be similar to the following example:

<process name="default">
  <sequence>
    <operation name="IM Begin Session Service">
      <participant name="IMBeginSession"/>
      <output message="IMBeginSessionInputMessage">
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
    <operation name="IM Begin Chat Service">
      <participant name="IMBeginChat_Instance"/>
      <output message="IMBeginChatInputMessage">
        <assign to="IMChatTo">myuserid,TomR_Billing,WarehouseUser1</assign>
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
    <operation name="IM End Chat Service">
      <participant name="IMEndChat_Instance"/>
      <output message="IMEndChatInputMessage">
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
    <operation name="IM End Session Service">
      <participant name="IMEndSession_Instance"/>
      <output message="IMEndSessionInputMessage">
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation>
  </sequence> 
</process>

Business Process Example 2 – Complex

This example corresponds with the sample business process IMCommandProcessLoop.bp provided with your installation of Sterling B2B Integrator. To use the provided process model and this example, use a configured instance of the IM Begin Session service to call the process.

The following figure shows a similar business process model in the GPM. Because of the length of the business process, the figure is broken down into three separate sections here for ease of viewing:

Section 1

Section 2

Section 3