Defining Connectivity Components for a Master Index (Repository)

Defining connectivity components begins with creating a graphical representation of the connectivity components (the Connectivity Map). You must define connectivity components for the master index project and for any client projects that reference the master index application. The topics listed below describe how to define connectivity components for master index server and client projects, including Collaborations, Business Processes, Services, JMS Topics, and so on. Perform these tasks to configure connectivity for the master index application and connected systems.

• Defining Master Index (Repository) Server Connectivity Components

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

• Defining Business Process Client Connectivity Components

Defining Master Index (Repository) Server Connectivity Components

In the master index server project, the Connectivity Map contains business logic and information about how data is processed in the master index application. The following topics describe how to create a Connectivity Map for the master index project, add components to the map, and then connect those components.

• Creating the Master Index Server Connectivity Map

• Connecting Master Index Server Connectivity Map Components

Creating the Master Index Server Connectivity Map

Follow these steps to create and add components to the master index server Connectivity Map.

To Create the Master Index Server Connectivity Map

1. In the Projects window, right-click the master index server 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 name for the Connectivity Map, and press Enter.
4. Drag the MasterIndex.Web.Application icon from the Projects window onto the Connectivity Map Editor canvas.
5. Drag the MasterIndex.Application icon from the Projects window onto the canvas to the right of the web application icon.
6. (Optional) To add an Oracle Adapter or SQL Server Adapter for database connectivity, do the following:
   1. On the Connectivity Map Editor toolbar, click the External Applications icon.
   2. From the drop-down list, select the check box for Oracle External Application or SQL Server External Application.

      A new icon appears on the toolbar.

   3. Drag the new icon from the toolbar onto the canvas to the right of the MasterIndex.Application icon.
   4. Enter a name for the External System and then press Enter.
7. (Optional) To add a Topic to publish messages from the master index application to external systems, do the following:
   1. On the Connectivity Map Editor toolbar, click the Topic icon and then drag it onto the canvas to the right of the MasterIndex.Application icon.
   2. Enter a name for the Topic and then press Enter.
8. Save the Connectivity Map to the Repository.

Connecting Master Index Server Connectivity Map Components

Once you create the components of a Connectivity Map, you must link them to define the flow of data within the application. Before you connect the components, make sure you complete all of the steps in Creating the Master Index Server Connectivity Map and have the master index Connectivity Map visible on the Connectivity Map Editor.

To Connect Master Index Server Connectivity Map Components

1. In the Connectivity Map Editor, double-click the MasterIndex.Application icon.

   The Service Binding dialog box appears.

2. Place the cursor over the arrow to the right of the MasterIndex.Web.Application icon in the Connectivity Map until the cursor turns into a hand.
3. Click the arrow and drag it to the connector next to Implemented Services on the Service Binding dialog box.
4. If the Connectivity Map contains a database Adapter, configure the Adapter by doing the following:
   1. Click the database service under Invoked Services on the Service Binding dialog box and drag it to the Oracle External Application or SQL Server External Application icon.
   2. Double-click the Adapter icon on the new connector bar.
   3. On the Connections dialog box, click OK.
   4. On the Properties window, enter the properties or accept the default values (for more information, see the user’s guide for the Adapter you are using).
   5. Click OK.
5. If the Connectivity Map contains a JMS Topic, configure the Topic by doing the following:
   1. Click and drag “JMSDestination” from the Invoked Services box to the Topic icon in the Connectivity Map.
   2. Double-click the JMS Client Connection icon on the new connector bar.
   3. Configure the JMS Client Connection.
6. Close the Service Binding dialog box, and then save the Connectivity Map to the Repository.

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.

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 Oracle Java CAPS Master Index Processing (Repository). You can use additional master index methods, which are described in the Javadocs provided with Oracle Java CAPS 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.

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.

Defining Business Process Client Connectivity Components

In Business Process client projects, the Connectivity Map contains business logic and information about how data is transferred between the master index application and external systems through a Business Process. The Business Process defines how data is transformed before being sent to the master index application.

The following topics describe how to incorporate master index methods into a Business Process, create the Connectivity Map, and then add and connect the connectivity components.

• Including Master Index Methods in a Business Process

• Connecting the Business Process Components

• Creating the Business Process Client Connectivity Map

• Connecting Business Process Client Connectivity Map Components

  ---

  Note - Refer to Designing Oracle Java CAPS Business Process Manager Projects for more details about performing any of the processes described in this section.

  ---

Including Master Index Methods in a Business Process

You can process data through a Collaboration, a Business Process, or both. If you are processing data by both methods, be sure the processing logic is the same for both. Before including the master index application in the Connectivity Map for the Business Process client project, you need to add master index methods to a Business Process. For more information about the available methods, see theWorking with the Master Index Java API (Repository) in Understanding Oracle Java CAPS Master Index Processing (Repository) .

To Include Master Index Methods in a Business Process

1. Plan and design a new Business Process.
2. In the NetBeans Projects window, right-click the name of the Business Process client project, point to New, and then select Business Process.
3. Enter a new name for the Business Process and then press Enter.
4. In the Business Process Designer, create the components of the Business Process.
5. For each master index method to include, do the following:
   1. In the master index server project, expand the method OTD folder to display the method list.
   2. Drag the method you want to use into the Business Process Designer.

      ---

      Note - The method OTD is the node in the master index server project with the same name as the master index application.

      ---

6. Save the Business Process and continue to the next step, Connecting the Business Process Components.

Connecting the Business Process Components

This topic describes how to connect the components of a Business Process that incorporates master index methods. Make sure you have completed all of the steps in Including Master Index Methods in a Business Process and that the Business Process is open in the Business Process Designer.

To Connect the Business Process Components

1. In the Business Process Designer, place the cursor over the arrow to the right of the Start icon until the cursor turns into a hand.
2. Click the arrow and drag it to the first Business Process component.
3. Follow the same procedure to link each activity in the order in which they should be processed.
4. For each link you create, do the following:
   1. Right-click the link and select Add Business Rule.
   2. Configure the business rule to map data from the input to output activity.
5. Create any additional processing logic as needed.
6. Save the Business Process to the Repository.

Creating the Business Process Client Connectivity Map

Connectivity between the master index application and Business Processes is defined in the Connectivity Map of the Business Process client project. This topic describes how to create and configure the Business Process client Connectivity Map. You can optionally include a JMS Topic (for information and instructions, see Adding the JMS Topic to the Collaboration Client Connectivity Map). You only need to incorporate the topic if you added a JMS Topic to the server project and if you want to publish master index application messages to external systems.

To Create the Business Process 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. To add External Applications, do the following:
   1. On the Connectivity Map Editor toolbar, click the down arrow next to the External Applications icon.
   2. 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.

   3. Drag the External Application icon from the Connectivity Map Editor toolbar to the canvas.
   4. If your data flow includes a destination External Application, repeat the above steps for the destination application, placing the icon to the far right of the source External Application icon.
5. In the Connectivity Map toolbar, click Service and drag it onto the canvas to the right of the External Application icon.
6. Drag the Business Process created in Including Master Index Methods in a Business Process into the Service.
7. To add the master index application, do the following:
   1. On the Connectivity Map Editor toolbar, click the down arrow next to the External Applications icon.
   2. Select the check box next to the name of the master index application you want to add.

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

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

Connecting Business Process Client Connectivity Map Components

Once you create the components of a Connectivity Map, you must 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 Business Process Client Connectivity Map.

To Connect Business Process Connectivity Map components

1. In the Business Process Connectivity Map, double-click the Service icon to display the Service Binding dialog box.
2. Drag the sending application in the Implemented Services box in the Service Binding dialog box to the input External Application icon on the Connectivity Map Editor.
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 Connectivity Map Editor.

   ---

   Note - This is the service with the same name as the master index application.

   ---

4. Drag the receiving application in the Invoked Services box in the Service Binding dialog box to the output External Application icon on the Connectivity Map Editor.
5. Close the Service Binding dialog box.
6. Double-click the Adapter icon to configure the Adapters (for more information, see the configuration topics for the type of Adapter).
7. To add a JMS Topic to the Connectivity Map, follow the instructions under Adding the JMS Topic to the Collaboration Client Connectivity Map and Configuring the Outbound Collaboration.
8. Save the Connectivity Map to the Repository.