Overview of connector-specific properties

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

The following properties determine the communications between the adapter and the WebSphere Business Integration Message Broker:

Properties that determine the communications between the InterChange Server integration broker and the adapter are found in Appendix A. Standard configuration properties for connectors.

Connector-specific properties

Table 22 lists the connector-specific configuration properties for the connector. See the sections that follow for explanations of the properties.

Table 22. Connector-specific configuration properties
Name Possible values Default value Required
ApplicationPassword Login password No
ApplicationUserName Login user ID No
ArchiveQueue Queue to which copies of successfully processed messages are sent queue://crossworlds.queue. manager/WBIMBConnector/ARCHIVE No
CCSID Character set for queue manager connection Yes
Channel MQ server connector channel Yes
ConfigurationMetaObject Name of configuration meta-object Yes
DataHandlerClassName Data handler class name com.crossworlds.DataHandlers. text.xml Yes
DataHandlerConfigMO Data handler meta-object MO_DataHandler_Default Yes
DataHandlerMimeType MIME type of file text/xml Yes
DataHandlerPoolSize Number of data handler instances to cache for resuse 30 No
DefaultVerb Any verb supported by the connector.
EnableMessageProducerCache true or false true No
ErrorQueue Queue for unprocessed messages queue://crossworlds.queue. manager/WBIMBConnector/ERROR No
HostName WebSphere MQ server Connects to the local queue manager in bindings mode. No
InputQueue Poll queue queue://crossworlds.queue. manager/WBIMBConnector/IN 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 1414 No
ReplyToQueue Queue to which response messages are delivered when the connector issues requests queue://crossworlds.queue. manager/WBIMBConnector/REPLY No
ReplyToQueuePollFrequency Polling interval in number of milliseconds for receiver during synchronous request processing No
SecurityExitClassName The fully qualified class name of the security exit being used. No
SecurityExitInitParam Specifies a value to configure with the initialization string that is used to invoke a secure exit. No
SessionPoolSizeForRequests Maximum pool size for caching the sessions used during request processing 10 No
UnsubscribedQueue Queue to which unsubscribed messages are sent queue://crossworlds.queue. manager/WBIMBConnector/ UNSUBSCRIBED No
UseDefaults true or false false
WorkerThreadCount Maximum number of parallel threads for polling.
1
No

ApplicationPassword

Password used with UserID to log in to WebSphere Business Integration Message Broker.

Default = None.

If the ApplicationPassword is left blank or removed, the connector uses the default password provided by WebSphere Business Integration Message Broker.

ApplicationUserName

User ID used with Password to log in to WebSphere Business Integration Message Broker.

Default = None.

If the ApplicationUserName is left blank or removed, the connector uses the default user ID provided by WebSphere Business Integration Message Broker.

ArchiveQueue

Queue to which copies of successfully processed messages are sent.

Default = queue://crossworlds.queue.manager/WBIMBConnector/ARCHIVE

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. See Setting Queue Uniform Resource Identifiers (URI).

Default = none.

Channel

MQ server connector channel through which the connector communicates with WebSphere Business Integration Message Broker.

Default = none.

If the Channel is left blank or removed, the connector uses the default server channel provided by WebSphere Business Integration Message Broker.

ConfigurationMetaObject

Name of meta-object containing configuration information for the connector

Default = none.

DataHandlerClassName

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

Default = com.crossworlds.DataHandlers.text.xml

DataHandlerConfigMO

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

Default = MO_DataHandler_Default

DataHandlerMimeType

Allows you to request a data handler based on a particular MIME type.

Default = text/xml

DataHandlerPoolSize

Allows you to specify a maximum number of data handler instances to cache for a particular type of data handler.

Default = 30

DefaultVerb

Specifies the verb to be set within an incoming business object, if it has not been set by the data handler during polling.

Default= none

EnableMessageProducerCache

Boolean property to specify that the adapter should enable a message producer cache for sending request messages.

Default= true

ErrorQueue

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

Default = queue://crossworlds.queue.manager/WBIMBConnector/ERROR

HostName

The name of the server hosting WebSphere Business Integration Message Broker.

Default = When a value is not provided, the adapter will connect to the local queue manager in bindings mode.

InputQueue

Message queues that will be polled by the connector for new messages. The connector accepts multiple semi-colon delimited queue names. For example, to poll the following three queues: MyQueueA, MyQueueB, and MyQueueC, the value for connector configuration property InputQueue would equal: MyQueueA;MyQueueB;MyQueueC.

The connector polls the queues in a round-robin manner and retrieves up to pollQuantity number of messages from each queue. For example, if pollQuantity equals 2, and MyQueueA contains 2 messages, MyQueueB contains 1 message and MyQueueC contains 5 messages, the connector retrieves messages in the following manner:

Since we have a pollQuanity of 2, the connector will retrieve at most 2 messages from each queue per call to pollForEvents. For the first cycle (1 of 2), the connector retrieves the first message from each of MyQueueA, MyQueueB, and MyQueueC. That completes the first round of polling and if we had a pollQuantity of 1, the connector would stop. Since we have a pollQuanity of 2, the connector starts a second round of polling (2 of 2) and retrieves one message each from MyQueueA and MyQueueC--it skips MqQueueB since it is now empty. After polling all queues 2x each, the call to the method pollForEvents is complete. Here's the sequence of message retrieval:

  1. 1 message from MyQueueA
  2. 1 message from MyQueueB
  3. 1 message from MyQueueC
  4. 1 message from MyQueueA
  5. Skip MyQueueB since it's now empty
  6. 1 message from MyQueueC

Default = queue://crossworlds.queue.manager/WBIMBConnector/IN

PollQuantity

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 Business Integration Message Broker listener.

Default = The WebSphere MQ environment's default port, which is 1414.

ReplyToQueue

Queue to which response messages are delivered when the connector issues requests.

Default = queue://crossworlds.queue.manager/WBIMBConnector/REPLY

ReplyToQueuePollFrequency

Specifies the polling interval for the receiver during synchronous request processing. The value is the number of milliseconds.

Default = none.

SecurityExitClassName

The fully qualified class name of the security exit being used.

Default = none.

SecurityExitInitParam

Specifies a value to configure with the initialization string that is used to invoke a secure exit.

Default = none.

SessionPoolSizeForRequests

Maximum pool size for caching the sessions used during request processing.

Default = 10

UnsubscribedQueue

Queue to which messages that are not subscribed are sent.

Default = queue://crossworlds.queue.manager/WBIMBConnector/UNSUBSCRIBED

Note:
*Always check the values WebSphere Business Integration Message Broker provides since they may be incorrect or unknown. If so, please implicitly specify values.

UseDefaults

On a Create operation, if UseDefaults is set to true, the connector checks whether a valid value or a default value is provided for each isRequired business object attribute. If a value is provided, the Create operation succeeds. If the parameter is set to false, the connector checks only for a valid value and causes the Create operation to fail if it is not provided. The default is false.

WorkerThreadCount

Maximum number of parallel threads for polling. While concurrently processing the events, the adapter will not be able to submit events to the broker in the order it received. If the sequence needs to be maintained WorkerThreadCount should always be set to 1.

Copyright IBM Corporation 2003, 2005. All Rights Reserved.