Defining Collaboration Client Connectivity Components for a Master Index (Repository)

In the Collaboration client projects for external systems sharing data with the master index application, the Connectivity Map contains business logic and information about how data is transferred between the master index application and external systems.

Note - Before you can add the master index application to the client Connectivity Maps, you need to create and Environment and deployment profile for the master index server project, and then build the project. This adds the master index external application to the Connectivity Map Editor toolbar under the External System icon. Instructions for creating the Environment are under Building an Environment. Instructions for building and deploying the master index server project are under Deploying the Master Index (Repository) Server Project in Deploying Master Indexes (Repository) .

The following topics describe how to create a Connectivity Map for a Collaboration client project, add and configure map components, and then connect those components.

• Adding Master Index Methods to a Java Collaboration

• Creating the Collaboration Client Project Connectivity Map

• Connecting Collaboration Client Connectivity Map Components

• Adding the JMS Topic to the Collaboration Client Connectivity Map

• Configuring the Outbound Collaboration

Adding Master Index Methods to a Java Collaboration

This topic describes how to incorporate the master index method OTD into Java Collaborations for external systems. For a complete reference of the methods included in the master index OTD, see Working with the Master Index Java API (Repository) in Understanding Sun Master Index Processing (Repository). You can use additional master index methods, which are described in the Javadocs provided with Sun Master Index.

To Add Master Index Methods to a Java Collaboration

Before You Begin

Before beginning this procedure, create the OTD for the incoming messages.

1. Create the Java Collaboration for the Collaboration client project using the Collaboration Wizard ( right-click the project, point to New, and then select Collaboration Definition (Java)).
2. Enter information into the wizard as it applies to the external systems in the project.
3. In step 3 of the Collaboration Definition Wizard (Select OTDs), select the input OTD, the output OTD, and the master index method OTD.

   Note - The master index method OTD is contained in the master index project and is named after the master index application.

4. When you complete the wizard, do the following using the Collaboration Editor (Java) to define custom processing using the master index API:
   1. In the left panel of the Business Rules Designer, right-click the master index method OTD.

      A list of available methods appears.

   2. Select the desired method from the list.
   3. Create any necessary variables for the method, and then map the input, output, and variables to the method.
5. When you are done defining the processing rules, save the Collaboration.

Creating the Collaboration Client Project Connectivity Map

To define connectivity between the master index application and external systems, you need to include the master index application in the Connectivity Maps of the Collaboration client projects.

Note - Before beginning this procedure make sure an external application component is defined for an application that sends information to the master index application (source system) and optionally for an application that receives information from the master index application (destination system). For testing purposes, you can use File Adapters instead of external application Adapters for the source and destination systems.

To Create a Collaboration Client Connectivity Map

Before You Begin

Build the master index server project in order to create the master index External System to add to the client Connectivity Map.

1. In the Projects window, right-click the project to which you want to add the Connectivity Map.
2. Point to New, and then click Connectivity Map.

   A Connectivity Map icon is added to the project and the Connectivity Map Editor appears.

3. Enter a new name for the Connectivity Map, and then press Enter.
4. On the Connectivity Map Editor toolbar, click the down arrow next to the External Applications icon and select the check box next to the name of the External Application that will send messages to the master index application.

   The External Application icon appears in the Connectivity Map Editor toolbar.

5. Drag the External Application icon from the Connectivity Map Editor toolbar to the canvas.
6. If your data flow includes a destination External Application, repeat the previous two steps for the destination application, placing the icon to the far right of the source External Application icon.
7. Drag the Java Collaboration that references the master index method OTD onto the Connectivity Map Editor canvas between the source and destination External Applications.
8. On the Connectivity Map Editor toolbar, click the down arrow next to the External Applications icon and select the check box next to the name of the master index application you want to integrate.

   The master index application icon appears in the Connectivity Map Editor toolbar.

9. Drag the master index application icon from the Connectivity Map Editor toolbar onto the canvas to the lower right of the Collaboration icon.
10. Save the Connectivity Map.

Connecting Collaboration Client Connectivity Map Components

Once you create the components of a Connectivity Map, you need to link them to define the flow of data through the system. Before you connect the components, make sure you have completed all of the steps in Creating the Collaboration Client Project Connectivity Map.

To Connect Connectivity Map Components

1. In the Connectivity Map, double-click the Service icon to display the Service Binding dialog box.
2. Drag the source system from the Implemented Services box in the Service Binding dialog box to the external source system icon on the canvas.
3. Drag the master index application from the Invoked Services box in the Service Binding dialog box to the master index application icon on the canvas.
4. If you defined a destination system, drag the appropriate service from the Invoked Services box in the Service Binding dialog box to the external destination system icon on the canvas.
5. Close the Service Binding dialog box.
6. Double-click the icons to the source and destination systems to configure the Adapters.
7. Save and close the Connectivity Map.

Adding the JMS Topic to the Collaboration Client Connectivity Map

If you defined a JMS Topic in the master index server Connectivity Map, you need to add the topic to the Collaboration client Connectivity Map in order to publish the messages to external systems. This involves adding the JMS Topic and associated components to the Connectivity Map and configuring the Collaboration for the connected Service.

Before beginning this procedure, make sure the server project contains a JMS Topic (this is described in Creating the Master Index Server Connectivity Map.

To Add the JMS Topic to the Connectivity Map

1. In the Collaboration client project, check out the Connectivity Map and then open it in the Connectivity Map Editor.
2. Drag the JMS Topic from the master index server project (in the Projects window) to the Connectivity Map Editor and place it below the existing Connectivity Map components.
3. Drag a Service from the Connectivity Map Editor toolbar to the right of the JMS Topic on the canvas.
4. Drag an External Application of the appropriate type from the Connectivity Map Editor toolbar and place it to the right of the new Service on the canvas (for testing purposes, you can use a File External Application).
5. In the Connectivity Map Editor, place the cursor over the arrow to the right of the Topic icon until the cursor turns into a hand, and then drag it into the Service to connect the two objects.
6. Repeat step 5 to connect the Service to the external system.
7. Configure the JMS Client Connection.
8. Double-click the External Application Adapter to configure the location and parameter settings.
9. Save the Connectivity Map, and continue to Configuring the Outbound Collaboration.

Configuring the Outbound Collaboration

Once you create the JMS Topic in the Connectivity Map, you need to configure the Java Collaboration that processes messages from the master index JMS Topic. Before you begin, make sure you have completed all of the steps in Adding the JMS Topic to the Collaboration Client Connectivity Map.

To Configure the Outbound Collaboration for the JMS Topic

1. In the Projects window, right-click the Collaboration client project.
2. Point to New, and then select Collaboration Definition (Java).
3. Enter information into the Collaboration Definition Wizard, with the following guidelines:

   • For the Web Service Type, select the existing JMS receive type (navigate to CAPS Components Library\Enterprise Service Bus\JMS and select receive).

   • Select the appropriate outbound OTD for the external systems in the project (for testing with a File External Application, select the FileClient OTD).

4. Configure the Collaboration to map data from the JMS Topic to the external system.
5. Save the Collaboration to the Repository.
6. Open the Collaboration client Connectivity Map, and then drag the newly created Collaboration onto the Service connected to the JMS Topic.
7. Save the Connectivity Map to the Repository.