This section describes standard configuration properties applicable to adapters whose integration broker is WebSphere MQ Integrator Broker. For information on using WebSphere Integrator Broker, see the Implementation Guide for WebSphere MQ Integrator Broker.
You configure connector properties from Connector Configurator.
A connector obtains its configuration values at startup. If you change the value of one or more connector properties during a runtime session, you must restart the connector. Standard configuration properties provide information that is used by the adapter framework and connector framework, and is common to all connectors.
The following table provides a quick reference for standard connector
configuration properties. See the sections that follow for explanations
of the properties.
Name | Possible Values | Default Value |
---|---|---|
AdminInQueue | valid JMS queue name | CONNECTORNAME/ADMININQUEUE |
AdminOutQueue | valid WebSphere MQ queue name | CONNECTORNAME/ADMINOUTQUEUE |
AgentTraceLevel | 0-5 | 0 |
ApplicationName | application name | AppNameConnector |
BrokerType | WMQI | WMQI |
CharacterEncoding | ASCII, SJIS, Cp949, GBK,
Big5, Cp297, Cp273, Cp280,
Cp284, Cp037, Cp437
| ASCII |
ContainerManagedEvents | JMS or no value | JMS |
DeliveryQueue | valid WebSphere MQ queue name | CONNECTORNAME/DELIVERYQUEUE |
DeliveryTransport | JMS | JMS |
DuplicateEventElimination | true, false |
|
FaultQueue | valid WebSphere MQ queue name | CONNECTORNAME/FAULTQUEUE |
jms.FactoryClassName |
| CxCommon.Messaging.jms.IBMMQSeriesFactory |
jms.MessageBrokerName | If FactoryClassName is IBM, use crossworlds.queue.manager. If FactoryClassName is Sonic, use localhost:2506. | crossworlds.queue.manager |
jms.NumConcurrentRequests |
| 10 |
jms.Password |
|
|
jms.UserName |
|
|
Locale | en_US , ja_JP, ko_KR, zh_C,
zh_T, fr_F, de_D, it_I,
es_E, pt_BR
| en_US |
MessageFileName | path/filename | InterchangeSystem.txt |
PollEndTime | HH:MM | HH:MM |
PollFrequency | milliseconds/key/no | 10000 |
PollStartTime | HH:MM | HH:MM |
RepositoryDirectory | path/directory name Note: Typically you must change this value from the default to whatever path and directory name was actually used when you installed the the connector files. | C:\crossworlds\Repository |
RequestQueue | valid WebSphere MQ queue name | CONNECTORNAME/REQUESTQUEUE |
ResponseQueue |
| RESPONSEQUEUE |
RestartRetryCount | 0-99 | 3 |
RestartRetryInterval | an appropriate integer indicating the number of minutes between restart attempts | 1 |
SourceQueue | valid WebSphere MQ queue name | CONNECTORNAME/SOURCEQUEUE |
SynchronousRequestQueue | valid WebSphere MQ queue name |
|
SynchronousResponseQueue | valid WebSphere MQ queue name |
|
SynchronousTimeout | an appropriate integer indicating the number of minutes the connector waits for a response to a synchronous request | 0 |
WireFormat | CwXML | CwXML |
The queue that is used by the integration broker to send administrative messages to the connector.
The default value is CONNECTORNAME/ADMININQUEUE.
The queue that is used by the connector to send administrative messages to the integration broker.
Level of trace messages for the connector's application-specific component. The default is 0. The connector delivers all trace messages applicable at the tracing level set or lower.
Name that uniquely identifies the connection to the application. This name is used by the system administrator to monitor the connector's environment. When you create a new connector definition, this property defaults to the name of the connector; when you work with the definition for an IBM WebSphere-delivered connector, the property is also likely to be set to the name of the connector. Set the property to a value that suggests the program with which the connector is interfacing, such as the name of an application, or something that identifies a file system or website in the case of technology connectors.
This property is set to the value WMQI for connectors that are configured to use WebSphere MQ Integrator Broker as the integration broker.
Specifies the character code set used to map from a character (such as a letter of the alphabet, a numeric representation, or a punctuation mark) to a numeric value.
Attention: Do not run a non-internationalized connector against InterChange Server version 4.1.1 if you cannot guarantee that only ISO Latin-1 data will be processed.
The default value is ascii.
Setting this property to JMS enables a JMS-enabled connector with a JMS event store to provide guaranteed event delivery, in which an event is removed from the source queue and placed on the destination queue as a single JMS transaction. This property can also be set to no value.
Notes:
The default value is JMS.
The queue that is used by the connector to send business objects to the integration broker.
The default value is CONNECTORNAME/DELIVERYQUEUE.
Specifies the transport mechanism for the delivery of events. The property defaults to the value JMS, indicating that the Java Messaging Service (JMS) is used for communication with WebSphere MQ Integrator. This property must be set to JMS when WebSphere MQ Integrator Broker is the integration broker. Otherwise, the connector cannot start.
Setting this property to true enables a JMS-enabled connector with a non-JMS event store to ensure that duplicate events are not delivered to the delivery queue. To make use of this feature, during connector development a unique event identifier must be set as the business object's ObjectEventId attribute in the application specific code.
This property can also be set to false.
If the connector experiences an error while processing a message then the connector moves the message to the queue specified in this property, along with a status indicator and a description of the problem.
The default value is CONNECTORNAME/FAULTQUEUE.
Specifies the class name to instantiate for a JMS provider.
The default is CxCommon.Messaging.jms.IBMMQSeriesFactory.
Specifies the broker name to use for the JMS provider.
The default is crossworlds.queue.manager.
Specifies the maximum number of concurrent service call requests that can be sent to a connector at the same time. Once that maximum is reached, new service calls block and wait for another request to complete before proceeding.
The default value is 10.
Specifies the password for the JMS provider. A value for this property is optional.
There is no default.
Specifies the user name for the JMS provider. A value for this property is optional.
There is no default.
Specifies the language code, country or territory, and, optionally, the associated character code set. The value of this property determines such cultural conventions as collation and sort order of data, date and time formats, and the symbols used in monetary specifications. For more information, see the overview chapter of the connector guide for an internationalized connector.
A locale name has the following format:
ll_TT.codeset
where:
The default is en_US.
Attention:
The name of the connector message file. The standard location for the message file is \connectors\messages. Specify the message filename in an absolute path if the message file is not located in the standard location. This property defaults to the value InterchangeSystem.txt for new connector definitions and should be changed to the name of the message file for the specific connector.
Time to stop polling the event queue. The format is HH:MM, where HH represents 0-23 hours, and MM represents 0-59 seconds.
You must provide a valid value for this property. The default value is HH:MM, but must be changed.
The amount of time between polling actions. Set the PollFrequency to one of the following values:
The default is 10000.
The time to start polling the event queue. The format is HH:MM, where HH represents 0-23 hours, and MM represents 0-59 seconds.
You must provide a valid value for this property. The default value is HH:MM, but must be changed.
The path and name of the directory from which the connector reads the XML schema documents that store the meta-data of business object definitions.
The default value is C:\crossworlds\repository. You must change this to the directory path that you are using for the \repository directory for your connector. Typically that path is established when you install the adapter product; for example, C:\WebSphereAdapters\repository. The value must be a directory path. Do not use <REMOTE> as the RepositoryDirectory value for a connector that is not using ICS as the broker.
The queue that is used by the integration broker to send business objects to the connector.
The default value is CONNECTORNAME/REQUESTQUEUE.
Designates the JMS response queue, which delivers a response message from the connector framework to the integration broker.
Specifies the number of times the connector attempts to restart itself. The default value is 3, indicating that the connector tries to restart 3 times. For instance, if a connector is unable to log in to an application it fails to start, but with this property set to the value 3 the connector tries a total of three times to start. When used in conjunction with the RestartRetryInterval property, this behavior enables a connector to make several attempts at communicating with an application that might not reliably have a connection available all the time.
Specifies the interval in minutes at which the connector attempts to restart itself. The default value is 1, indicating that the connector waits 1 minute in between its restart attempts.
Designates the JMS source queue for the connector framework in support of guaranteed event delivery for JMS-enabled connectors that use a JMS event store. For further information, see ContainerManagedEvents.
The default is CONNECTORNAME/SOURCEQUEUE.
Delivers request messages that require a synchronous response from the connector framework to WebSphere MQ Integrator Broker. This queue is necessary only if the connector uses synchronous execution. With synchronous execution, the connector framework sends a message to the SynchronousRequestQueue and waits for a response back from WebSphere MQ Integrator Broker on the SynchronousResponseQueue. The response message sent to the connector bears a correlation ID that matches the ID of the original message.
Delivers response messages sent in reply to a synchronous request from WebSphere MQ Integrator Broker to the connector framework. This queue is necessary only if the connector uses synchronous execution.
Specifies the time in minutes that the connector waits for a response to a synchronous request. If the response is not received within the specified time then the connector moves the original synchronous request message into the fault queue along with an error message.
The default value is 0.
The data format for messages exchanged by the connector. The default value CwXML is the only valid value, and directs the connector to compose the messages in XML.