Configuring the adapter

After installation and before startup, you must configure the adapter components as follows.

Configuring the JPOs

The JPO triggers require certain configuration properties to be set before they will work. To set these configuration properties, you have to edit the source code for each JPO.

The JPOs installed with the adapter for eMatrix are WBIEventLogger and InstallEventTables. After you have installed them, you must locate each JPO in the eMatrix Business Modeler and edit the source code.

The fields that need to be edited are clearly marked. Their names and default values are listed in Table 2.

Table 2. JPO configuration properties

Property name Description Default value
wbiPrefix The prefix used to provide all WebSphere Business Integration
eMatrix meta-entities (types, attributes and policies) with their own
namespace within eMatrix. It must match the value specified for
the WBIPrefix connector configuration property.
wbi_
vault Name of the eMatrix vault in which new events will be created.
Must match the value specified for the EventVault connector
configuration property.
WBI_Events
adapterUser The ID that the adapter uses when making requests in the eMatrix
system. Must match the value specified for the ApplicationUserName
connector configuration property. Important for preventing
"Ping-pong" (see below).
adapter

Preventing the ping-pong effect

When the adapter modifies an object in the eMatrix system for which a trigger is assigned, that trigger may in turn generate a new event to be published back to the broker. The following mechanism prevents this from happening.

When a JPO is invoked, it receives a Context object that contains, among other things, the userID associated with the user who invoked the JPO. This user ID is set in the JPO property adapterUser. When it is triggered, the WBIEventLogger JPO checks the user ID it receives from the eMatrix Context object.

If the user was the adapter for eMatrix, the value of the JPO's adapterUser property will match the value of the connector's ApplicationUserName property. In this case, the JPO will ignore the event, and it is not logged. If the user IDs do not match, the JPO creates a new event.

Note:
It is important to set the adapterUser property in the JPO and the ApplicationUserName property in the adapter to the same values, otherwise you get the ping-pong effect.

Configuring the connector

The connector component of the adapter has two types of configuration properties: standard configuration properties, which apply to most adapters, and application-specific configuration properties, which apply only to your adapter. You must set the values of these properties before running the connector.

Standard configuration properties

To configure the standard connector properties, use the Connector Configurator tool. Details are given in Appendix B, "Connector Configurator".. This tool provides a graphical user interface for configuring the connector. Click on the Standard Config Properties tab to add or modify configuration properties.

When you have finished specifying values for the connector's configuration properties, Connector Configurator saves the values in the adapter repository (for ICS) or generates a configuration file and places it in the adapter's local repository (for WebSphere message brokers or WAS).

A connector obtains its configuration values at startup. During a run-time session, you may want to change the values of one or more connector properties.

To determine whether a property is dynamic or static, refer to the update method column in Connector Configurator.

Application-specific configuration properties

Application-specific connector configuration properties provide information related to the application and needed by the connector at run time. They also provide a way for you to change static information or logic within the connector without having to recode and rebuild it.

To configure these properties, use Connector Configurator. Click the Application Config Properties tab to add or modify configuration properties. For more information, see Appendix B, "Connector Configurator".

Table 3 lists the application-specific configuration properties for the connector, along with their descriptions and possible values.

Table 3. Application-specific configuration properties for eMatrix

Property Description Possible values Default value Required
ApplicationUserName Name used when
connecting to the eMatrix
system.
<any>
Must match the value
set for the adapterUser
JPO configuration
property
WBI Yes
ApplicationPassword Password used when
connecting to the eMatrix
system.
<any>
WBI Yes
EventVault Vault in which the
adapter searches for
events.
<any>
Must match the value
set for the vault JPO
configuration
property
WBIEventVault Yes
inDoubtEvents Recovery strategy
for in-doubt events.
If no value is given,
the adapter will fail
on start-up.
One of:
  • FailOnStartup
  • Reprocess
  • LogError
  • Ignore
Reprocess
Yes
ArchiveProcessed If True, the adapter
archives all events.
If False or undefined, the
adapter deletes events
from eMatrix after
they have been processed.
true or false false
DefaultVault Default vault in
which the adapter creates
new objects and
manipulates existing ones.
<any> DefaultWBIVault
DefaultPolicy Default policy used
by the adapter when it
creates new objects in
eMatrix.
<any> DefaultWBIPolicy
KeepRelations If true, the adapter
maintains relationships
when it updates
business objects.
If false, it destroys any
relationships that are not
defined in Update
requests.
true or false false
UseDefaults The adapter uses
the defaults set in the
business object definition
if UseDefaults is set
to true.
true or false true
PollQuantity The maximum number
of events that the adapter
can process for each
poll call.
<any positive
integer>
1
WBIPrefix The prefix of all
business objects and
attributes related to event
notification in the eMatrix
system.
Note:
No pre-existing
business objects or
attributes may
start with this value.
<any>
Must match the value
specified for the JPO
wbiPrefix configuration
property.
wbi_
EmatrixServer The name of the remote
business object server.
<any> :bos
Hostname The URL of the
collaboration server.
<any> localhost:1099

Copyright IBM Corp. 1997, 2003