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 table below lists the connector-specific configuration properties for the connector. See the sections that follow for explanations of the properties.
Name | Possible values | Default value | Required |
---|---|---|---|
ApplicationPassword | Login password | Yes | |
ApplicationUserName | Login user ID | Yes | |
ArchiveQueue | Queue to which copies of successfully processed messages are sent | queue://crossworlds. queuemanager/MQCONN.ARCHIVE | No |
CCSID | Character set for queue manager connection | null | No |
Channel | Telcordia server connector channel | CHANNEL1 | Yes |
ConfigurationMetaObject | Name of configuration meta-object | Telcordia_MQSeries_MO_Config | 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 | Yes |
DefaultVerb | Any verb supported by the connector. | Create | |
ErrorQueue | Queue for unprocessed messages | queue://crossworlds. queuemanager/MQCONN.ERROR | No |
FeedbackCodeMappingMO | Feedback code meta-object | No | |
HostName | Telcordia server | Yes | |
InDoubtEvents | FailOnStartup Reprocess IgnoreLogError | Reprocess | No |
InputQueue | Poll queues | queue://crossworlds. queuemanager/DELV_2_IBM | No |
InProgressQueue | In-progress event queue | queue://crossworlds. queuemanager/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 | 1414 | Yes |
ReplyToQueue | Queue to which response messages are delivered when the connector issues requests | queue://crossworlds. queuemanager/MQCONN.REPLYTO | No |
UnsubscribedQueue | Queue to which unsubscribed messages are sent | queue://crossworlds. queuemanager/MQCONN.UNSUBSCRIBE | No |
UseDefaults | true or false | false |
Password used with UserID to log in to Telcordia.
Default = None.
If the ApplicationPassword is left blank or removed, the connector uses the default password provided by Telcordia.*
User ID used with Password to log in to Telcordia.
Default = None.
If the ApplicationUserName is left blank or removed, the connector uses the default user ID provided by Telcordia.*
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 Queue uniform resource identifiers (URI). The value, for a Windows-based Telcordia connector, should be set to 819.
Default = null.
MQ server connector channel through which the connector communicates with Telcordia.
Default = CHANNEL1.
If the Channel is left blank or removed, the connector uses the default server channel provided by Telcordia.*
Name of static meta-object containing configuration information for the connector.
Default = Telcordia_MQSeries_MO_Config.
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
Specifies the verb to be set within an incoming business object, if it has not been set by the data handler during polling.
Default= Create
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 Telcordia-specific feedback codes:
The connector accepts the following InterChange Server-specific status codes as attribute values in the meta-object:
Table 1. The table below 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 Telcordia.
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 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:
Default = queue://crossworlds.queue.manager/DELV_2_IBM
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 MQ listener.
Default = 1414
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, Telcordia message properties, and dynamic child meta-object attributes.
Default = queue://crossworlds.queue.manager/MQCONN.REPLYTO
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 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.