WebSphere Business Integration Adapters: An Adapter Development and WebSphere Business Integration Solution

398 WebSphere Business Integration Adapters

23.1 Connector naming conventions

Naming conventions provide a way to make our connector files easier to locate

and identify. Table 23-1 summarizes the naming conventions that we used for

connector files. Many of these file names are based on the connector name,

which uniquely identifies the file within the WebSphere Business Integration

System. The name,

connName, can identify the application or technology with

which the connector communicates. We named our adapter RMAdapter, and

using the usual naming convention, we name our run-time connector

RMConnector.

Table 23-1 Our naming conventions

23.2 Defining the connector

For the custom adapter, you must create a connector definition. A connector

obtains its configuration values at startup. This section defines these standard

connector property values.

The connector uses the following order to determine a property value, where the

highest number overrides other values:

1. Default

2. Repository (only if the InterChange Server is the integration broker)

3. Local configuration file

4. Command line

Connector file Name

Connector definition RMConnector

Connector directory ProductDir/connectors/RM

Connector configuration file ProductDir\connectors\RM\RMConnector.cfg

Connector class RMAgent.java

Connector library  Java jar file: connDir\RMAdapter.jar

 Java package:

com.ibm.itso.RedHouse.RM.Adapter.RMAgent

Connector startup script  Windows platforms:

connDir\start_RMConnector.bat

 UNIX-based platforms:

connDir/connector_manager_RMConnector.sh

where connDir is the name of the connector

directory, as defined above.

Chapter 23. Packaging the custom adapter for distribution 399

For our scenario with the Message Broker, the properties that we configure will

form part of the local configuration file.

23.2.1 Defining the connector with the Connector Configurator

To define the connector, you create a connector definition. This connector

definition includes the following information to define the connector in the

repository. For initial deployment of a customer adapter, you create a connector

definition with a set of standard properties — the properties that are common for

most connectors. You also create the WebSphere MQ objects that are required

for the connector. You then conduct some basic tests to ensure that the

connector starts correctly before testing some of the business objects that you

created previously. A tool called

Connector Configurator collects this information

and stores it in the repository.

Note: Not every connector uses all the standard properties. When you select

an integration broker from Connector Configurator, you see a list of the

standard properties that you need to configure for your adapter running with

that particular broker type.

Note: If your integration broker is the InterChange Server, the connector and

its configuration must be deployed to the repository. The repository is a

database with which InterChange Server communicates to obtain information

about components in the WebSphere Business Integration System.

Connector definitions must be deployed to the repository. These connector

definitions include both standard and connector-specific connector

configuration properties that the Connector Controller and the client Adapter

Framework require. The connector can also have a local configuration file,

which provides configuration information for the connector locally. When a

local configuration file exists, it usually takes precedence over the information

in the InterChange Server repository.

If your integration broker is WebSphere, there are deployment steps that you

must take for integration of the artifacts for your adapter service.

The most straightforward connector deployment is using the Message Broker

because the connector reads the business object definitions from the local file

system. For basic testing at this stage, there is no deployment involved as

such. You can save the configuration in a file and test immediately.

400 WebSphere Business Integration Adapters

To define the connector with the Connector Configurator:

1. Create the directory which will hold the completed connector configuration (as

shown in Table 23-1 on page 398). For our scenario, that directory is

C:\IBM\WebSphereAdapters\connectors\RM.

2. From the System Manager, start the Connector Configurator by selecting

Tools → Connector Configurator.

3. Enter the properties for the new connector as shown in Figure 23-1.

Figure 23-1 New connector

4. Name the connector. We use RMConnector as the name.

5. Select the broker, WebSphere Message Broker.

6. Select None for the template name, because you are creating a new custom

connector and, as such, there is no template.

7. Click OK.

Chapter 23. Packaging the custom adapter for distribution 401

23.2.2 .Defining the connector configuration properties

The connector definition also contains the connector configuration properties. To

tailor the properties accordingly:

1. Modify the Standard Properties as shown in Figure 23-2.

Figure 23-2 Customized standard properties