Connector configuration

Connectors have two types of configuration properties: standard configuration properties and adapter-specific configuration properties. You must set the values of these properties before running the adapter.

You use Connector Configurator to configure connector properties:

An adapter obtains its configuration values at startup. During a runtime session, you may want to change the values of one or more connector properties. Changes to some connector configuration properties, such as AgentTraceLevel, take effect immediately. Changes to other connector properties require component restart or system restart after a change. To determine whether a property is dynamic (taking effect immediately) or static (requiring either connector component restart or system restart), refer to the Update Method column in the Connector Properties window of the System Manager.

Standard connector properties

Standard configuration properties provide information that all adapters use. See Appendix A, Standard configuration properties for connectors for documentation of these properties.

You must provide a value for the ApplicationName configuration property before running the connector.

Connector-specific properties

Connector-specific configuration properties provide information needed by the connector at runtime. Connector-specific properties also provide a way of changing static information or logic within the connector without having to recode and rebuild the agent.

The table below lists the connector-specific configuration properties for the adapter. See the sections that follow for explanations of the properties.
Name Possible values Default value Required
ApplicationPassword Login password for WebSphere MQ
No
ApplicationUserName Login user ID for WebSphere MQ
No
CCSID Character set for queue manager connection null No
Channel MQ server channel through which connector communicates with WebSphere MQ
Yes
DataEncoding The encoding that is used to transform the bytes of a message from the MO queue to a java String: US-ASCII, ISO-8859-1, UTF-8, UTF-16 UTF-8 No
DataHandlerClassName Data handler class name com.ibm..adapters.qad. datahandlers.QADDataHandler Yes
DataHandlerConfigMO Data handler meta-object BIA_QADDataHandlerMO Yes
ErrorQueue Queue for unprocessed messages
No
HostName WebSphere MQ server
Yes
InDoubtEvents FailOnStartup, Reprocess, Ignore, LogError Reprocess No
InputQueue Queue where MFG/PRO puts events
Yes
InProgressQueue In-progress event queue
No
ConnectRetries The number of connect retries in case the adapter loses its connection to the RMI server. 3
OutputQueue The queue where MFG/PRO looks for requests
Yes
PollQuantity Number of messages to retrieve from each queue specified in the InputQueue property 1 No
Port Port established for the WebSphere MQ listener
Yes
SQLQueryServerHost The host name or IP address for the machine on which the SQL Query Dispatcher is installed. localhost No
SQLQueryServerName The name of the RMI server instance to connect to.
No
SQLQueryServerPort The port number for the RMI connection 1099 No
SQLQueryTimeout Time interval, in milliseconds, after which the RMI server will timeout on a request 5000 No
SQLDispatcherCmd Command line for starting the dispatcher
No

ApplicationPassword

Password used with UserID to log in to WebSphere MQ.

Default = None.

If the ApplicationPassword is left blank or removed, the connector uses the default password provided by WebSphere MQ.*

ApplicationUserName

User ID used with Password to log in to WebSphere MQ.

Default = None.

If the ApplicationUserName is left blank or removed, the connector uses the default user ID provided by WebSphere MQ.*

CCSID

The character set for the queue manager connection. The value of this property should match that of the CCSID property in the queue URI.

Default = null.

Channel

MQ server connector channel through which the connector communicates with WebSphere MQ.

Default = none.

If the Channel is left blank or removed, the connector uses the default server channel provided by WebSphere MQ.

DataEncoding

The encoding that is used to transform the bytes of a message from the MO queue to a java String. Possible values are: US-ASCII, ISO-8859-1, UTF-8, UTF-16.

Default = UTF-8

DataHandlerClassName

Data handler class to use when converting messages to and from business objects.

Default = com.ibm..adapters.qad.datahandlers.QADDataHandler

DataHandlerConfigMO

Meta-object passed to data handler to provide configuration information.

Default = BIA_QADDataHandlerMO

ErrorQueue

Queue to which messages that could not be processed are sent.

Default = none

HostName

The name of the server hosting WebSphere MQ.

Default = none.

InDoubtEvents

Specifies how to handle in-progress events that are not fully processed due to unexpected connector shutdown. Choose one of four actions to take if events are found in the in-progress queue during initialization:

Default = Reprocess.

InputQueue

The queue where MFG/PRO puts events. Message queues that will be polled by the connector for new messages. There is only1 InputQueue.

Default = none

InProgressQueue

Message queue where messages are held during processing. You can configure the connector to operate without this queue by using System Manager to remove the default InProgressQueue name from the connector-specific properties. Doing so prompts a warning at startup that event delivery may be compromised if the connector is shut down while are events pending.

Default= none

ConnectRetries

The number of connect retries in case the adapter loses its connection to the RMI server.

Default = 3

OutputQueue

The queue where MFG/PRO looks for requests. A value for this property is required.

Default = none.

PollQuantity

The number of messages to retrieve from each queue specified in the InputQueue property during a pollForEvents scan.

Default =1

Port

Port established for the WebSphere MQ listener.

Default = None

SQLQueryServerHost

The host name or IP address for the machine on which the SQL Query Dispatcher is installed. This value is always localhost when the dispatcher is running on the same machine as the connector.

Default = localhost

SQLQueryServerName

The name of the RMI server instance to connect to. This property is left blank when dispatcher services are not required. When this property is blank, any call requests whose processing triggers SQL queries evaluation will fail.

Default = none

SQLQueryServerPort

The port number for the RMI connection.

Default = 1099

SQLQueryTimeout

Time interval, in milliseconds, after which the RMI server will timeout on a request.

Default = 5000

SQLDispatcherCmd

Command line for starting the dispatcher. Leave blank if the dispatcher is installed on a remote system. When this property is blank, and when property SQLQueryServerNqme is non-blank, the adapter assumes that you start the SQL Dispatcher manually before starting the adapter.

Default = none

Enabling guaranteed event delivery

You can configure the guaranteed-event-delivery feature for the adapter for QAD. You accomplish this by using duplicate event elimination to ensure that duplicate events do not occur. This section provides the following information about use of the guaranteed-event-delivery feature:

Enabling the feature for connectors

To enable the guaranteed-event-delivery feature, you must set the connector configuration properties to values shown in Table 7.

Table 7. Guaranteed-event-delivery connector properties for a connector with a non-JMS event store
Connector property Value
DeliveryTransport
JMS
DuplicateEventElimination
true
MonitorQueue

Name of the JMS monitor queue, in which the connector framework stores the ObjectEventId of processed business objects

If you configure a connector to use guaranteed event delivery, you must set the connector properties as described in Table 7. To set these connector configuration properties, use the Connector Configurator tool. It displays these connector properties on its Standard Properties tab. For information on Connector Configurator, see Appendix B, Connector Configurator.

Effect on event polling

If a connector uses guaranteed event delivery by setting DuplicateEventElimination to true, it behaves slightly differently from a connector that does not use this feature. To provide the duplicate event elimination, the connector framework uses a JMS monitor queue to track a business object. The name of the JMS monitor queue is obtained from the MonitorQueue connector configuration property.

After the connector framework receives the business object from the application-specific component (through a call to gotApplEvent() in the pollForEvents() method), it must determine if the current business object (received from gotApplEvents()) represents a duplicate event. To make this determination, the connector framework retrieves the business object from the JMS monitor queue and compares its ObjectEventId with the ObjectEventId of the current business object:

For the connector to support duplicate event elimination, you must make sure that the connector's pollForEvents() method includes the following steps:

Copyright IBM Corp. 1997, 2003