Adapter configuration

Connectors have two types of configuration properties: standard configuration properties and connector-specific configuration properties. You must set the values of these properties before you can run the adapter. To configure connector properties with ICS as your integration broker, use Connector Configurator. For more information, refer to Appendix B, "Connector configurator".

A connector 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 Connector Configurator.

Standard connector properties

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

Because this adapter supports only InterChange Server (ICS) as the integration broker, the only configuration properties relevant to it are for ICS.

Connector-specific properties

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

The following table lists the connector-specific configuration properties for the adapter. See the sections that follow for explanations of the properties.

Note:
These properties include default queue name values. You will need to change these values to match the queue names you are actually using in your set up.


Table 9. 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://<queue_manager_name>/
WC_MQCONN.ARCHIVE

No

Channel

MQ server connector channel


Yes

ConfigurationMetaObject

Name of configuration meta-object


Yes

DataHandlerClassName

Data handler class name

com.crossworlds.DataHandlers. text.xml

No

DataHandlerConfigMO

Data handler meta-object

MO_DataHandler_ Default

Yes

DataHandlerMimeType

MIME type of file

text/xml

No

ErrorQueue

Queue for unprocessed messages

queue://<queue_manager_name>/ WC_MQCONN.ERROR

No

FeedbackCodeMappingMO

Feedback code meta-object


No

HostName

WebSphere MQ server


Yes

InDoubtEvents

FailOnStartup Reprocess Ignore LogError

Reprocess

No

InputQueue

Poll queues

queue://<queue_manager_name>/ WC_MQCONN.IN

No

InProgressQueue

In-progress event queue

queue://<queue_manager_name>/ WC_MQCONN.IN_PROGRESS

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

ReplyToQueue

Queue to which response messages are delivered when the adapter issues requests

queue://<queue_manager_name>/ WC_MQCONN.REPLYTO

No

UnsubscribedQueue

Queue to which unsubscribed messages are sent

queue://<queue_manager_name>/ WC_MQCONN.UNSUBSCRIBE

No

UseDefaults true or false false

ApplicationPassword

Password used with UserID to log in to WebSphere MQ.

Default = None.

If the ApplicationPassword is left blank or removed, the adapter 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 adapter uses the default user ID provided by WebSphere MQ.

ArchiveQueue

Queue to which copies of successfully processed messages are sent.

Default = queue://<queue_manager_name>/WC_MQCONN.ARCHIVE

Channel

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

Default=none.

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

ConfigurationMetaObject

Name of static 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. The XML data handler is required for use with WebSphere Commerce.

Default = text/xml

ErrorQueue

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

Default = queue://<queue_manager_name>/WC_MQCONN.ERROR

FeedbackCodeMappingMO

Allows you to override and reassign the default feedback codes used to synchronously acknowledge receipt of messages to InterChange Server. This property enables you to specify a meta-object in which each attribute name is understood to represent a feedback code. The corresponding value of the feedback code is the return status that is passed to InterChange Server. For a listing of the default feedback codes, see "Synchronous delivery". The adapter accepts the following attribute values representing WebSphere MQ-specific feedback codes:

The adapter accepts the following ICS-specific status codes as attribute values in the meta-object:

The following table shows a sample meta-object.

Table 10. Sample feedback code meta-object attributes
Attribute name Default value
MQFB_APPL_FIRST

SUCCESS

MQFB_APPL_FIRST + 1

FAIL

MQFB_APPL_FIRST + 2

UNABLE_TO_LOGIN

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 adapter shutdown. Choose one of four actions to take if events are found in the in-progress queue during initialization:

Default = Reprocess.

InputQueue

Message queues that will be polled by the adapter for new messages. The adapter 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.

If the InputQueue property is not supplied, the connector starts up properly but prints a warning message, and performs request processing only. It will not perform any event processing.

The adapter 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 adapter retrieves messages in the following manner:

Since we have a pollQuanity of 2, the adapter will retrieve at most two messages from each queue per call to pollForEvents. For the first cycle (1 of 2), the adapter 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 adapter would stop.

Since we have a pollQuanity of 2, the adapter 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://<queue_manager_name>/WC_MQCONN.IN

InProgressQueue

Message queue where messages are held during processing.

Default= queue://<queue_manager_name>/WC_MQCONN.IN_PROGRESS

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 MQ listener.

Default=None.

ReplyToQueue

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

Default = queue://<queue_manager_name>/WC_MQCONN.REPLY

UnsubscribedQueue

Queue to which messages that are not subscribed are sent.

Default = queue://<queue_manager_name>/WC_MQCONN.UNSUBSCRIBED

Note:
*Always check the values WebSphere MQ 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.

Copyright IBM Corp. 1997, 2003