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:
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 the Connector Properties window of Connector Configurator.
Standard configuration properties provide information that all connectors use. See Appendix A. Standard configuration properties for connectors for documentation of these 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 following table 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 | No | |
ApplicationUserName | Login user ID | No | |
ArchiveQueue | Queue to which copies of successfully processed messages are sent | queue://crossworlds. queue.manager/MQCONN.ARCHIVE | No |
CCSID | Character set for queue manager connection | 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 |
DataHandlerPoolSize | Number of data handler instances to cache for reuse | 30 | No |
DefaultVerb | Any verb supported by the connector. | No | |
EnableMessageProducerCache | true or false | true | No |
ErrorQueue | Queue for unprocessed messages | queue://crossworlds. queue.manager/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://crossworlds. queue.manager/MQCONN.IN | No |
InProgressQueue | In-progress event queue | queue://crossworlds.queue. manager/MQCONN.IN_PROGRESS | No |
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 connector issues requests | queue://crossworlds. queue.manager/MQCONN.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/MQCONN.UNSUBSCRIBED | No |
UseDefaults | true or false | false | No |
WorkerThreadCount | Maximum number of parallel threads for polling | 1 | No |
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.*
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.*
Queue to which copies of successfully processed messages are sent.
Default = queue://crossworlds.queue.manager/MQCONN.ARCHIVE
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.
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.*
Name of static meta-object containing configuration information for the connector.
Default = none.
Data handler class to use when converting messages to and from business objects.
Default = com.crossworlds.DataHandlers.text.xml
Meta-object passed to data handler to provide configuration information.
Default = MO_DataHandler_Default
Allows you to request a data handler based on a particular MIME type.
Default = text/xml
Allows you to specify a maximum number of data handler instances to cache for a particular type of data handler.
Default = 30
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
Boolean property to specify that the adapter should enable a message producer cache for sending request messages.
Default= true
Queue to which messages that could not be processed are sent.
Default = queue://crossworlds.queue.manager/MQCONN.ERROR
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 connector accepts the following attribute values representing WebSphere MQ-specific feedback codes:
The connector accepts the following WebSphere business integration system-specific status codes as attribute values in the meta-object:
Table 9 shows a sample meta-object.
Attribute name | Default value |
---|---|
MQFB_APPL_FIRST | SUCCESS |
MQFB_APPL_FIRST + 1 | FAIL |
MQFB_APPL_FIRST + 2 | UNABLE_TO_LOGIN |
Default = none.
The name of the server hosting WebSphere MQ.
Default = none.
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.
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.
If the InputQueue property is not supplied, the connector will start up properly, print a warning message, and perform request processing only. It will perform no event processing.
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 PollQuantity 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 PollQuantity 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:
Default = queue://crossworlds.queue.manager/MQCONN.IN
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= queue://crossworlds.queue.manager/MQCONN.IN_PROGRESS
Number of messages to retrieve from each queue specified in the InputQueue property during a pollForEvents scan.
Default =1
Port established for the WebSphere MQ listener.
Default = None.
Queue to which response messages are delivered when the connector issues requests. You can also use attributes in the child dynamic meta-object to ignore a response. For more information on the these attributes, see JMS headers and dynamic child meta-object attributes.
Default = queue://crossworlds.queue.manager/MQCONN.REPLY
Specifies the polling interval for the receiver during synchronous request processing. The value is the number of milliseconds.
Default = None.
The fully qualified class name of the security exit being used.
Default = None.
Specifies a value to configure with the initialization string that is used to invoke a secure exit.
Default = None.
Maximum pool size for caching the sessions used during request processing.
Default = 10
Queue to which messages that are not subscribed are sent.
Default = queue://crossworlds.queue.manager/MQCONN.UNSUBSCRIBED
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 is Required 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.
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 was received. If the sequence needs to be maintained, WorkerThreadCount should always be set to 1.