This section lists and defines each of the standard connector configuration properties.
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.
The default value is CONNECTORNAME/ADMINOUTQUEUE.
Applicable only if RepositoryDirectory is <REMOTE>.
The AgentConnections property controls the number of ORB (Object Request Broker) connections opened by orb.init[].
The default value of this property is set to 1. You can change it as required.
Level of trace messages for the 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 connector's application. This name is used by the system administrator to monitor the WebSphere business integration system environment. This property must have a value before you can run the connector.
Identifies the integration broker type that you are using. The options are ICS, WebSphere message brokers (WMQI, WMQIB or WBIMB) or WAS.
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.
By default, a subset of supported character encodings only is displayed in the drop-down list. To add other supported values to the drop-down list, you must manually modify the \Data\Std\stdConnProps.xml file in the product directory. For more information, see the appendix on Connector Configurator.
Applicable only if RepositoryDirectory is <REMOTE>.
Determines how many business objects can be concurrently processed by the connector for event delivery. Set the value of this attribute to the number of business objects you want concurrently mapped and delivered. For example, set the value of this property to 5 to cause five business objects to be concurrently processed. The default value is 1.
Setting this property to a value greater than 1 allows a connector for a source application to map multiple event business objects at the same time and deliver them to multiple collaboration instances simultaneously. This speeds delivery of business objects to the integration broker, particularly if the business objects use complex maps. Increasing the arrival rate of business objects to collaborations can improve overall performance in the system.
To implement concurrent processing for an entire flow (from a source application to a destination application), you must:
The ConcurrentEventTriggeredFlows property has no effect on connector polling, which is single-threaded and performed serially.
This property allows 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.
There is no default value.
When ContainerManagedEvents is set to JMS, you must configure the following properties to enable guaranteed event delivery:
You must also configure a data handler with the MimeType, DHClass (data handler class), and DataHandlerConfigMOName (the meta-object name, which is optional) properties. To set those values, use the Data Handler tab in Connector Configurator.
Thes properties are adapter-specific, but example values are:
The fields for these values in the Data Handler tab will be displayed only if you have set ContainerManagedEvents to JMS.
This property only appears if the DeliveryTransport property is set to the value JMS.
Applicable only if RepositoryDirectory is <REMOTE>.
Sets the behavior of the connector controller after it detects that the destination application-specific component is unavailable.
If this property is set to true and the destination application-specific component is unavailable when an event reaches ICS, the connector controller blocks the request to the application-specific component. When the application-specific component becomes operational, the controller forwards the request to it.
However, if the destination application's application-specific component becomes unavailable after the connector controller forwards a service call request to it, the connector controller fails the request.
If this property is set to false, the connector controller begins failing all service call requests as soon as it detects that the destination application-specific component is unavailable.
The default is true.
Applicable only if RepositoryDirectory is <REMOTE>.
Level of trace messages for the connector controller. The default is 0.
Applicable only if DeliveryTransport 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. Possible values are MQ for WebSphere MQ, IDL for CORBA IIOP, or JMS for Java Messaging Service.
The connector sends service call requests and administrative messages over CORBA IIOP if the value configured for the DeliveryTransport property is MQ or IDL.
Use WebSphere MQ rather than IDL for event delivery transport, unless you must have only one product. WebSphere MQ offers the following advantages over IDL:
Enables communication between the connector and client connector framework using Java Messaging Service (JMS).
If you select JMS as the delivery transport, additional JMS properties such as jms.MessageBrokerName, jms.FactoryClassName, jms.Password, and jms.UserName, appear in Connector Configurator. The first two of these properties are required for this transport.
In this environment, you may experience difficulty starting both the connector controller (on the server side) and the connector (on the client side) due to memory use within the WebSphere MQ client. If your installation uses less than 768M of process heap size, IBM recommends that you set:
This script resides in the \bin directory below the product directory. With a text editor, add the following line as the first line in the CWSharedEnv.sh script:
export LDR_CNTRL=MAXDATA=0x30000000
This line restricts heap memory usage to a maximum of 768 MB (3 segments * 256 MB). If the process memory grows more than this limit, page swapping can occur, which can adversely affect the performance of your system.
When you set this property to true, a JMS-enabled connector can ensure that duplicate events are not delivered to the delivery queue. To use this feature, the connector must have a unique event identifier set as the business object's ObjectEventId attribute in the application-specific code. This is done during connector development.
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.
The maximum heap size for the agent (in megabytes). This property is applicable only if the RepositoryDirectory value is <REMOTE>.
The default value is 128m.
The maximum native stack size for the agent (in kilobytes). This property is applicable only if the RepositoryDirectory value is <REMOTE>.
The default value is 128k.
The minimum heap size for the agent (in megabytes). This property is applicable only if the RepositoryDirectory value is <REMOTE>.
The default value is 1m.
Specifies the class name to instantiate for a JMS provider. You must set this connector property when you choose JMS as your delivery transport mechanism (DeliveryTransport).
The default is CxCommon.Messaging.jms.IBMMQSeriesFactory.
Specifies the broker name to use for the JMS provider. You must set this connector property when you choose JMS as your delivery transport mechanism (DeliveryTransport).
The default is crossworlds.queue.manager. Use the default when connecting to a local message broker.
When you connect to a remote message broker, this property takes
the following (mandatory) values:
QueueMgrName:<Channel>:<HostName>:<PortNumber>,
where the variables are:
QueueMgrName: The name of the queue manager.
Channel: The channel used by the client.
HostName: The name of the machine where the queue manager is to reside.
PortNumber: The port number to be used by the queue manager for listening.
For example:
jms.MessageBrokerName = WBIMB.Queue.Manager:CHANNEL1:RemoteMachine:1456
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.
This property supports multi-threading in MQ Listener when ICS is the integration broker. It enables batch writing of multiple events to the database, thus improving system performance. The default value is 1.
This property applies only to connectors using MQ transport. The DeliveryTransport property must be set to MQ.
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.
A locale name has the following format:
ll_TT.codeset
where:
By default, only a subset of supported locales appears in the drop-down list. To add other supported values to the drop-down list, you must manually modify the \Data\Std\stdConnProps.xml file in the product directory. For more information, see the appendix on Connector Configurator.
The default value is en_US. If the connector has not been globalized, the only valid value for this property is en_US. To determine whether a specific connector has been globalized, see the connector version list on these websites:
http://www.ibm.com/software/websphere/wbiadapters/infocenter, or http://www.ibm.com/websphere/integration/wicserver/infocenter
Applicable only if RespositoryDirectory is <REMOTE>.
Specifies whether to log errors to the integration broker's log destination. Logging to the broker's log destination also turns on e-mail notification, which generates e-mail messages for the MESSAGE_RECIPIENT specified in the InterchangeSystem.cfg file when errors or fatal errors occur.
For example, when a connector loses its connection to its application, if LogAtInterChangeEnd is set to true, an e-mail message is sent to the specified message recipient. The default is false.
The maximum number of events in the controller buffer. This property is used by flow control and is applicable only if the value of the RepositoryDirectory property is <REMOTE>.
The value can be a positive integer between 1 and 2147483647. The default value is 2147483647.
The name of the connector message file. The standard location for the message file is \connectors\messages in the product directory. Specify the message filename in an absolute path if the message file is not located in the standard location.
If a connector message file does not exist, the connector uses InterchangeSystem.txt as the message file. This file is located in the product directory.
The logical queue that the connector uses to monitor duplicate events. It is used only if the DeliveryTransport property value is JMS and DuplicateEventElimination is set to TRUE.
The default value is CONNECTORNAME/MONITORQUEUE
Valid only when the RepositoryDirectory is <REMOTE>.
Specifies whether the connector uses the automatic and remote restart feature. This feature uses the MQ-triggered Object Activation Daemon (OAD) to restart the connector after an abnormal shutdown, or to start a remote connector from System Monitor.
This property must be set to true to enable the automatic and remote restart feature. For information on how to configure the MQ-triggered OAD feature. see the Installation Guide for Windows or for UNIX.
The default value is false.
Valid only when the RepositoryDirectory is <REMOTE>.
Specifies the maximum number of times that the MQ-triggered OAD automatically attempts to restart the connector after an abnormal shutdown. The OADAutoRestartAgent property must be set to true for this property to take effect.
The default value is 1000.
Valid only when the RepositoryDirectory is <REMOTE>.
Specifies the number of minutes in the retry-time interval for the MQ-triggered OAD. If the connector agent does not restart within this retry-time interval, the connector controller asks the OAD to restart the connector agent again. The OAD repeats this retry process as many times as specified by the OADMaxNumRetry property. The OADAutoRestartAgent property must be set to true for this property to take effect.
The default is 10.
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.
This is the interval between the end of the last poll and the start of the next poll. PollFrequency specifies the amount of time (in milliseconds) between the end of one polling action, and the start of the next polling action. This is not the interval between polling actions. Rather, the logic is as follows:
Set PollFrequency to one of the following values:
The default is 10000.
Designates the number of items from the application that the connector should poll for. If the adapter has a connector-specific property for setting the poll quantity, the value set in the connector-specific property will override the standard property value.
FIX
An email message is also considerd an event. The connector behaves as follows when it is polled for email.
Polled once - connector goes to pick 1. the body of the message as it is also considered an attachment also. Since no DH was specified for this mime type, it it will ignore the body. 2. conector process first PO attachment. DH is avaiable for this mime type so it sends the business object to the Visual Test Connector. If the 3. accept in VTC again no BO should come thru Polled second time 1. conector process second PO attachment. DH is avaiable for this mime type so it sends teh BO to VTC2. accept in VTC again now the third PO attachment should come through. This is the correct behaviour.
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 queue that is used by the integration broker to send business objects to the connector.
The default value is CONNECTOR/REQUESTQUEUE.
The location of the repository from which the connector reads the XML schema documents that store the meta-data for business object definitions.
When the integration broker is ICS, this value must be set to <REMOTE> because the connector obtains this information from the InterChange Server repository.
When the integration broker is a WebSphere message broker or WAS, this value must be set to <local directory>.
Applicable only if DeliveryTransport is JMS and required only if RepositoryDirectory is <REMOTE>.
Designates the JMS response queue, which delivers a response message from the connector framework to the integration broker. When the integration broker is ICS, the server sends the request and waits for a response message in the JMS response queue.
Specifies the number of times the connector attempts to restart itself. When used for a parallel connector, specifies the number of times the master connector application-specific component attempts to restart the slave connector application-specific component.
The default is 3.
Specifies the interval in minutes at which the connector attempts to restart itself. When used for a parallel connector, specifies the interval at which the master connector application-specific component attempts to restart the slave connector application-specific component. Possible values ranges from 1 to 2147483647.
The default is 1.
WebSphere message brokers and WAS only.
This property allows you to configure the value of the field domain name in the JMS header. When data is sent to WMQI over JMS transport, the adapter framework writes JMS header information, with a domain name and a fixed value of mrm. A connfigurable domain name enables users to track how the WMQI broker processes the message data.
A sample header would look like this:
<mcd><Msd>mrm</Msd><Set>3</Set><Type>
Retek_POPhyDesc</Type><Fmt>CwXML</Fmt></mcd>
The default value is mrm, but it may also be set to xml. This property only appears when DeliveryTransport is set to JMSand WireFormat is set to CwXML.
Applicable only if DeliveryTransport is JMS and ContainerManagedEvents is specified.
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 value is CONNECTOR/SOURCEQUEUE.
Applicable only if DeliveryTransport is JMS.
Delivers request messages that require a synchronous response from the connector framework to the 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 the broker on the SynchronousResponseQueue. The response message sent to the connector bears a correlation ID that matches the ID of the original message.
The default is CONNECTORNAME/SYNCHRONOUSREQUESTQUEUE
Applicable only if DeliveryTransport is JMS.
Delivers response messages sent in reply to a synchronous request from the broker to the connector framework. This queue is necessary only if the connector uses synchronous execution.
The default is CONNECTORNAME/SYNCHRONOUSRESPONSEQUEUE
Applicable only if DeliveryTransport is JMS.
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.
Message format on the transport.
WAS integration broker only.
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.
WebSphere message brokers and WAS integration broker only.
A strong property that allows the user to specify short and long name spaces in the XML format of business object definitions.
The default value is short.