This section describes the standard connector configuration properties.
The AdapterHelpName property is the name of a directory in which connector-specific extended help files are located. The directory must be located in <ProductDir>\bin\Data\App\Help and must contain at least the language directory enu_usa. It may contain other directories according to locale.
The default value is the template name if it is valid, or it is blank.
The AdminInQueue property specifies the queue that is used by the integration broker to send administrative messages to the connector.
The default value is <CONNECTORNAME>/ADMININQUEUE
The AdminOutQueue property specifies the queue that is used by the connector to send administrative messages to the integration broker.
The default value is <CONNECTORNAME>/ADMINOUTQUEUE
The AgentConnections property controls the number of ORB (Object Request Broker) connections opened when the ORB initializes.
It is valid only if the value of the RepositoryDirectory is set to <REMOTE> and the value of the DeliveryTransport property is MQ or IDL.
The default value of this property is 1.
The AgentTraceLevel property sets the level of trace messages for the application-specific component. The connector delivers all trace messages applicable at the tracing level set and lower.
The default value is 0.
The ApplicationName property uniquely identifies the name of the connector application. This name is used by the system administrator to monitor the integration environment. This property must have a value before you can run the connector.
The default is the name of the connector.
The BiDi.Application property specifies the bidirectional format for data coming from an external application into the adapter in the form of any business object supported by this adapter. The property defines the bidirectional attributes of the application data. These attributes are:
This property is valid only if the BiDi.Transformation property value is set to true.
The default value is ILYNN (implicit, left-to-right, on, off, nominal).
The BiDi.Broker property specifies the bidirectional script format for data sent from the adapter to the integration broker in the form of any supported business object. It defines the bidirectional attributes of the data, which are as listed under BiDi.Application above.
This property is valid only if the BiDi.Transformation property value is set to true. If the BrokerType property is ICS, the property value is read-only.
The default value is ILYNN (implicit, left-to-right, on, off, nominal).
The BiDi.Metadata property defines the bidirectional format or attributes for the metadata, which is used by the connector to establish and maintain a link to the external application. The attribute settings are specific to each adapter using the bidirectional capabilities. If your adapter supports bidirectional processing, refer to the section on adapter-specific properties for more information.
This property is valid only if the BiDi.Transformation property value is set to true.
The default value is ILYNN (implicit, left-to-right, on, off, nominal).
The BiDi.Transformation property defines whether or not the system performs a bidirectional transformation at run time.
If the property value is set to true, the BiDi.Application, BiDi.Broker, and BiDi.Metadata properties are available. If the property value is set to false, they are hidden.
The default value is false.
The BrokerType property identifies the integration broker type that you are using. The possible values are ICS, WMQI (for WMQI, WMQIB or WBIMB), or WAS.
The CharacterEncoding property 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, only a subset of supported character encodings is displayed. To add other supported values to the list, you must manually modify the \Data\Std\stdConnProps.xml file in the product directory (<ProductDir>). For more information, see the Connector Configurator appendix in this guide.
The Common Event Infrastructure (CEI) is a simple event management function handling generated events. The CommonEventInfrastructure property specifies whether the CEI should be invoked at run time.
The default value is false.
The CommonEventInfrastructureContextURL is used to gain access to the WAS server that executes the Common Event Infrastructure (CEI) server application. This property specifies the URL to be used.
This property is valid only if the value of CommonEventInfrastructure is set to true.
The default value is a blank field.
The ConcurrentEventTriggeredFlows property determines how many business objects can be concurrently processed by the connector for event delivery. You set the value of this attribute to the number of business objects that are mapped and delivered concurrently. For example, if you set the value of this property to 5, five business objects are processed concurrently.
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), the following properties must configured:
The ConcurrentEventTriggeredFlows property has no effect on connector polling, which is single-threaded and is performed serially.
This property is valid only if the value of the RepositoryDirectory property is set to <REMOTE>.
The default value is 1.
The ContainerManagedEvents 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 one JMS transaction.
When this property is set to JMS, the following properties must also be set to enable guaranteed event delivery:
You must also configure a data handler with the MimeType and DHClass (data handler class) properties. You can also add DataHandlerConfigMOName (the meta-object name, which is optional). To set those values, use the Data Handler tab in Connector Configurator.
Although these properties are adapter-specific, here are some example values:
The fields for these values in the Data Handler tab are displayed only if you have set the ContainerManagedEvents property to the value JMS.
The ContainerManagedEvents property is valid only if the value of the DeliveryTransport property is set to JMS.
There is no default value.
The ControllerEventSequencing property enables event sequencing in the connector controller.
This property is valid only if the value of the RepositoryDirectory property is set to set to <REMOTE> (BrokerType is ICS).
The default value is true.
The ControllerStoreAndForwardMode property 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 WebSphere InterChange Server, 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.
This property is valid only if the value of the RepositoryDirectory property is set to <REMOTE> (the value of the BrokerType property is ICS).
The default value is true.
The ControllerTraceLevel property sets the level of trace messages for the connector controller.
This property is valid only if the value of the RepositoryDirectory property is set to set to <REMOTE>.
The default value is 0.
The DeliveryQueue property defines the queue that is used by the connector to send business objects to the integration broker.
This property is valid only if the value of the DeliveryTransport property is set to JMS.
The default value is <CONNECTORNAME>/DELIVERYQUEUE.
The DeliveryTransport property 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 of the RepositoryDirectory property is MQ or IDL.
If the value of the DeliveryTransport property is MQ, you can set the command-line parameter WhenServerAbsent in the adapter start script to indicate whether the adapter should pause or shut down when the InterChange Server is shut down.
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:
The JMS transport mechanism 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 are listed in Connector Configurator. The properties jms.MessageBrokerName and jms.FactoryClassName are required for this transport.
There may be a memory limitation if you use the JMS transport mechanism for a connector in the following environment:
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 768MB of process heap size, set the following variable and property:
This script is located in the \bin directory below the product directory (<ProductDir>). Using 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 larger than this limit, page swapping can occur, which can adversely affect the performance of your system.
When the value of this property is true, a JMS-enabled connector can ensure that duplicate events are not delivered to the delivery queue. To use this feature, during connector development, the connector must have a unique event identifier set as the business object ObjectEventId attribute in the application-specific code.
The default value is false.
When the value of this property is true, the adapter runtime will mark the incoming ObjectEventID as a foreign key for flow monitoring.
This property is only valid if the BrokerType property is set to ICS.
The default value is false.
If the connector experiences an error while processing a message, it moves the message (and a status indicator and description of the problem) to the queue specified in the FaultQueue property.
The default value is <CONNECTORNAME>/FAULTQUEUE.
The jms.FactoryClassName property specifies the class name to instantiate for a JMS provider. This property must be set if the value of the DeliveryTransport property is JMS.
The default is CxCommon.Messaging.jms.IBMMQSeriesFactory.
The jms.ListenerConcurrency property specifies the number of concurrent listeners for the JMS controller. It specifies the number of threads that fetch and process messages concurrently within a controller.
This property is valid only if the value of the jms.OptimizedTransport property is true.
The default value is 1.
The jms.MessageBrokerName specifies the broker name to use for the JMS provider. You must set this connector property if you specify JMS as the delivery transport mechanism (in the DeliveryTransport property).
When you connect to a remote message broker, this property requires
the following values:
QueueMgrName:Channel:HostName:PortNumber
where:
QueueMgrName is the name of the queue manager.
Channel is the channel used by the client.
HostName is the name of the machine where the queue manager is to
reside.
PortNumberis the port number used by the queue manager for listening
For example:
jms.MessageBrokerName = WBIMB.Queue.Manager:CHANNEL1:RemoteMachine:1456
The default value is crossworlds.queue.manager. Use the default when connecting to a local message broker.
The jms.NumConcurrentRequests property 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 are blocked and must wait for another request to complete before proceeding.
The default value is 10.
The jms.Password property specifies the password for the JMS provider. A value for this property is optional.
There is no default value.
The jms.TransportOptimized property determines if the WIP (work in progress) is optimized. You must have a WebSphere MQ provider to optimize the WIP. For optimized WIP to operate, the messaging provider must be able to:
The JMS APIs cannot be used for optimized WIP because they do not meet conditions 2 and 4 above, but the MQ Java APIs meet all four conditions, and hence are required for optimized WIP.
This property is valid only if the value of DeliveryTransport is JMS and the value of BrokerType is ICS.
The default value is false.
the jms.UserName property specifies the user name for the JMS provider. A value for this property is optional.
There is no default value.
The JvmMaxHeapSize property specifies the maximum heap size for the agent (in megabytes).
This property is valid only if the value for the RepositoryDirectory property is set to <REMOTE>.
The default value is 128m.
The JvmMaxNativeStackSize property specifies the maximum native stack size for the agent (in kilobytes).
This property is valid only if the value for the RepositoryDirectory property is set to <REMOTE>.
The default value is 128k.
The JvmMinHeapSize property specifies the minimum heap size for the agent (in megabytes).
This property is valid only if the value for the RepositoryDirectory property is set to <REMOTE>.
The default value is 1m.
The ListenerConcurrency property supports multithreading in WebSphere MQ Listener when WebSphere InterChange Server is the integration broker. It enables batch writing of multiple events to the database, thereby improving system performance.
This property valid only with connectors that use MQ transport. The value of the DeliveryTransport property must be MQ.
The default value is 1.
The Locale property specifies the language code, country or territory, and, optionally, the associated character code set. The value of this property determines cultural conventions such 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:
ll is a two-character language
code (in lowercase letters)
TT is a two-letter country or
territory code (in uppercase letters)
codeset is the name of the associated
character code set (may be optional).
By default, only a subset of supported locales are listed. To add other supported values to the list, you modify the \Data\Std\stdConnProps.xml file in the <ProductDir>\bin directory. For more information, refer to the Connector Configurator appendix in this guide.
If the connector has not been internationalized, the only valid value for this property is en_US. To determine whether a specific connector has been globalized, refer to the user guide for that adapter.
The default value is en_US.
The LogAtInterchangeEnd property specifies whether to log errors to the log destination of the integration broker.
Logging to the log destination also turns on e-mail notification, which generates e-mail messages for the recipient specified as the value of MESSAGE_RECIPIENT in the InterchangeSystem.cfg file when errors or fatal errors occur. For example, when a connector loses its connection to the application, if the value of LogAtInterChangeEnd is true, an e-mail message is sent to the specified message recipient.
This property is valid only if the value of the RespositoryDirectory property is set to <REMOTE> (the value of BrokerType is ICS).
The default value is false.
The MaxEventCapacity property specifies maximum number of events in the controller buffer. This property is used by the flow control feature.
This property is valid only if the value of the RespositoryDirectory property is set to <REMOTE> (the value of BrokerType is ICS).
The value can be a positive integer between 1 and 2147483647.
The default value is 2147483647.
The MessageFileName property specifies the name of the connector message file. The standard location for the message file is \connectors\messages in the product directory. Specify the message file name 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 default value is InterchangeSystem.txt.
The MonitorQueue property specifies the logical queue that the connector uses to monitor duplicate events.
It is valid only if the value of the DeliveryTransport property is JMS and the value of the DuplicateEventElimination is true.
The default value is <CONNECTORNAME>/MONITORQUEUE
the OADAutoRestartAgent property specifies whether the connector uses the automatic and remote restart feature. This feature uses the WebSphere 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 WebSphere MQ-triggered OAD feature. see the Installation Guide for Windows or for UNIX.
This property is valid only if the value of the RespositoryDirectory property is set to <REMOTE> (the value of BrokerType is ICS).
The default value is false.
The OADMaxNumRetry property specifies the maximum number of times that the WebSphere MQ-triggered Object Activation Daemon (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.
This property is valid only if the value of the RespositoryDirectory property is set to <REMOTE> (the value of BrokerType is ICS).
The default value is 1000.
The OADRetryTimeInterval property specifies the number of minutes in the retry-time interval for the WebSphere MQ-triggered Object Activation Daemon (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.
This property is valid only if the value of the RespositoryDirectory property is set to <REMOTE> (the value of BrokerType is ICS).
The default value is 10.
The PollEndTime property specifies the time to stop polling the event queue. The format is HH:MM, where HH is 0 through 23 hours, and MM represents 0 through 59 minutes.
You must provide a valid value for this property. The default value is HH:MM without a value, and it must be changed.
If the adapter runtime detects:
it will poll using the value configured for the PollFrequency property.
The PollFrequency property 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:
The following values are valid for this property:
The default is 10000.
The PollQuantity property designates the number of items from the application that the connector polls for. If the adapter has a connector-specific property for setting the poll quantity, the value set in the connector-specific property overrides the standard property value.
This property is valid only if the value of the DeliveryTransport property is JMS, and the ContainerManagedEvents property has a value.
An e-mail message is also considered an event. The connector actions are as follows when it is polled for e-mail.
The PollStartTime property specifies the time to start polling the event queue. The format is HH:MM, where HH is 0 through 23 hours, and MM represents 0 through 59 minutes.
You must provide a valid value for this property. The default value is HH:MM without a value, and it must be changed.
If the adapter runtime detects:
it will poll using the value configured for the PollFrequency property.
The RepositoryDirectory property is the location of the repository from which the connector reads the XML schema documents that store the metadata for business object definitions.
If the integration broker is WebSphere InterChange Server, this value must be set to 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 is set to <ProductDir>\repository by default. However, it may be set to any valid directory name.
The RequestQueue property specifies the queue that is used by the integration broker to send business objects to the connector.
This property is valid only if the value of the DeliveryTransport property is JMS.
The default value is <CONNECTORNAME>/REQUESTQUEUE.
The ResponseQueue property specifies the JMS response queue, which delivers a response message from the connector framework to the integration broker. When the integration broker is WebSphere InterChange Server, the server sends the request and waits for a response message in the JMS response queue.
This property is valid only if the value of the DeliveryTransport property is JMS.
The default value is <CONNECTORNAME>/RESPONSEQUEUE.
The RestartRetryCount property specifies the number of times the connector attempts to restart itself. When this property is used for a connector that is connected in parallel, it specifies the number of times the master connector application-specific component attempts to restart the client connector application-specific component.
The default value is 7.
The RestartRetryInterval property specifies the interval in minutes at which the connector attempts to restart itself. When this property is used for a connector that is linked in parallel, it specifies the interval at which the master connector application-specific component attempts to restart the client connector application-specific component.
Possible values for the property range from 1 through 2147483647.
The default value is 1.
The ResultsSetEnabled property enables or disables results set support when Information Integrator is active. This property can be used only if the adapter supports DB2 Information Integrator.
This property is valid only if the value of the DeliveryTransport property is JMS, and the value of BrokerType is WMQI.
The default value is false.
The ResultsSetSize property defines the maximum number of business objects that can be returned to Information Integrator. This property can be used only if the adapter supports DB2 Information Integrator.
This property is valid only if the value of the ResultsSetEnabled property is true.
The default value is 0. This means that the size of the results set is unlimited.
The RHF2MessageDomain property allows you to configure the value of the field domain name in the JMS header. When data is sent to a WebSphere message broker over JMS transport, the adapter framework writes JMS header information, with a domain name and a fixed value of mrm. A configurable domain name lets you track how the WebSphere message broker processes the message data.
This is an example header:
<mcd><Msd>mrm</Msd><Set>3</Set><Type>
Retek_POPhyDesc</Type><Fmt>CwXML</Fmt></mcd>
This property is valid only if the value of BrokerType is WMQI or WAS. Also, it is valid only if the value of the DeliveryTransport property is JMS, and the value of the WireFormat property is CwXML.
Possible values are mrm and xml. The default value is mrm.
The SourceQueue property 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.
This property is valid only if the value of DeliveryTransport is JMS, and a value for ContainerManagedEvents is specified.
The default value is <CONNECTORNAME>/SOURCEQUEUE.
The SynchronousRequestQueue property 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 synchronous request queue and waits for a response from the broker on the synchronous response queue. The response message sent to the connector has a correlation ID that matches the ID of the original message.
This property is valid only if the value of DeliveryTransport is JMS.
The default value is <CONNECTORNAME>/SYNCHRONOUSREQUESTQUEUE
The SynchronousRequestTimeout property specifies the time in milliseconds that the connector waits for a response to a synchronous request. If the response is not received within the specified time, the connector moves the original synchronous request message (and error message) to the fault queue.
This property is valid only if the value of DeliveryTransport is JMS.
The default value is 0.
The SynchronousResponseQueue property delivers response messages in reply to a synchronous request from the broker to the connector framework. This queue is necessary only if the connector uses synchronous execution.
This property is valid only if the value of DeliveryTransport is JMS.
The default is <CONNECTORNAME>/SYNCHRONOUSRESPONSEQUEUE
The TivoliMonitorTransactionPerformance property specifies whether IBM Tivoli Monitoring for Transaction Performance (ITMTP) is invoked at run time.
The default value is false.
The WireFormat property specifies the message format on the transport:
The WsifSynchronousRequestTimeout property specifies the time in milliseconds that the connector waits for a response to a synchronous request. If the response is not received within the specified time, the connector moves the original synchronous request message (and an error message) to the fault queue.
This property is valid only if the value of BrokerType is WAS.
The default value is 0.
The XMLNameSpaceFormat property specifies short or long namespaces in the XML format of business object definitions.
This property is valid only if the value of BrokerType is set to WMQI or WAS.
The default value is short.