Table 18 provides a quick-reference to the standard connector configuration properties. Not all connectors require all of these properties, and property settings may differ from integration broker to integration broker.
See the section following the table for a description of each property.
Property name | Possible values | Default value | Update method | Notes |
---|---|---|---|---|
AdapterHelpName |
One of the valid subdirectories in <ProductDir>\bin\Data \App\Help\ that contains a valid <RegionalSetting> directory |
Template name, if valid, or blank field |
Component restart |
Supported regional settings. Include chs_chn, cht_twn, deu_deu, esn_esp, fra_fra, ita_ita, jpn_jpn, kor_kor, ptb_bra, and enu_usa (default). |
AdminInQueue | Valid JMS queue name |
<CONNECTORNAME> /ADMININQUEUE |
Component restart |
This property is valid only when the value of DeliveryTransport is JMS |
AdminOutQueue | Valid JMS queue name |
<CONNECTORNAME> /ADMINOUTQUEUE |
Component restart |
This property is valid only when the value of DeliveryTransport is JMS |
AgentConnections | 1 through 4 | 1 |
Component restart |
This property is valid only when the value of DeliveryTransport is MQ or IDL, the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
AgentTraceLevel | 0 through 5 | 0 |
Dynamic if broker is ICS; otherwise Component restart |
|
ApplicationName | Application name |
The value specified for the connector application name |
Component restart |
|
BiDi.Application |
Any valid combination
of these bidirectional attributes: 1st letter: I,V 2nd letter: L,R 3rd letter: Y, N 4th letter: S, N 5th letter: H, C, N |
ILYNN (five letters) |
Component restart |
This property is valid only if the value of BiDi.Transforma tion is true |
BiDi.Broker |
Any valid combination
of these bidirectional attributes: 1st letter: I,V 2nd letter: L,R 3rd letter: Y, N 4th letter: S, N 5th letter: H, C, N |
ILYNN (five letters) |
Component restart |
This property is valid only if the value of BiDi.Transformation is true. If the value of BrokerType is ICS, the property is read-only. |
BiDi.Metadata |
Any valid combination
of these bidirectional attributes: 1st letter: I,V 2nd letter: L,R 3rd letter: Y, N 4th letter: S, N 5th letter: H, C, N |
ILYNN (five letters) |
Component restart |
This property is valid only if the value of BiDi.Transformation is true. |
BiDi.Transformation | true or false | false |
Component restart |
This property is valid only if the value of BrokerType is not WAS. |
BOTrace | none or keys or full | none |
Agent restart |
This property is valid only if the value of AgentTraceLevel is lower than 5. |
BrokerType | ICS, WMQI, WAS | ICS |
Component restart |
|
CharacterEncoding |
Any supported code.
.The list shows this subset: ascii7, ascii8, SJIS, Cp949, GBK, Big5, Cp297, Cp273, Cp280, Cp284, Cp037, Cp437 |
ascii7 |
Component restart |
This property is valid only for C++ connectors. |
CommonEventInfrastruc ture |
true or false | false |
Component restart |
|
CommonEventInfrastruc tureURL |
A URL string, for example, corbaloc:iiop: host:2809. |
No default value. |
Component restart |
This property is valid only if the value of CommonEvent Infrastructure is true. |
ConcurrentEventTrig geredFlows |
1 through 32,767 | 1 |
Component restart |
This property is valid only if the value of RepositoryDirectory is set to <REMOTE> and the value of BrokerType is ICS. |
ContainerManagedEvents | Blank or JMS | Blank |
Component restart |
This property is valid only when the value of Delivery Transport is JMS. |
ControllerEventSequenc ing |
true or false | true | Dynamic |
This property is valid only if the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
ControllerStoreAndFor wardMode |
true or false | true | Dynamic |
This property is valid only if the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
ControllerTraceLevel | 0 through 5 | 0 | Dynamic |
This property is valid only if the value of RepositoryDirectory is set to <REMOTE> and the value of BrokerType is ICS. |
DeliveryQueue |
Any valid JMS queue name |
<CONNECTORNAME>
/DELIVERYQUEUE |
Component restart |
This property is valid only when the value of Delivery Transport is JMS. |
DeliveryTransport | MQ, IDL, or JMS |
IDL when the value of RepositoryDirectory is <REMOTE>, otherwise JMS |
Component restart |
If the value of RepositoryDirectory is not <REMOTE>, the only valid value for this property is JMS. |
DuplicateEventElimina tion |
true or false | false |
Component restart |
This property is valid only if the value of DeliveryTransport is JMS. |
EnableOidForFlowMoni toring |
true or false | false |
Component restart |
This property is valid only if the value of BrokerType is ICS. |
FaultQueue | Any valid queue name. |
<CONNECTORNAME>
/FAULTQUEUE |
Component restart |
This property is valid only if the value of DeliveryTransport is JMS. |
jms.FactoryClassName |
CxCommon.Messaging.jms .IBMMQSeriesFactory, CxCommon.Messaging .jms.SonicMQFactory, or any Java class name |
CxCommon.Messaging. jms.IBMMQSeriesFactory |
Component restart |
This property is valid only if the value of DeliveryTransport is JMS. |
jms.ListenerConcurrency | 1 through 32767 | 1 |
Component restart |
This property is valid only if the value of jms.TransportOptimized is true. |
jms.MessageBrokerName |
If the value of jms.FactoryClassName is IBM, use crossworlds.queue. manager. |
crossworlds.queue. manager |
Component restart |
This property is valid
.only if the value of DeliveryTransport is JMS |
jms.NumConcurrent Requests |
Positive integer | 10 |
Component restart |
This property is valid
.only if the value of DeliveryTransport is JMS |
jms.Password | Any valid password |
Component restart |
This property is valid
.only if the value of DeliveryTransport is JMS |
|
jms.TransportOptimized | true or false | false |
Component restart |
This property is valid only if the value of DeliveryTransport is JMS and the value of BrokerType is ICS. |
jms.UserName | Any valid name |
Component restart |
This property is valid only if the value of Delivery Transport is JMS. |
|
JvmMaxHeapSize | Heap size in megabytes | 128m |
Component restart |
This property is valid only if the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
JvmMaxNativeStackSize | Size of stack in kilobytes | 128k |
Component restart |
This property is valid only if the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
JvmMinHeapSize | Heap size in megabytes | 1m |
Component restart |
This property is valid only if the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
ListenerConcurrency | 1 through 100 | 1 |
Component restart |
This property is valid only if the value of DeliveryTransport is MQ. |
Locale |
This is a subset of the supported locales: en_US, ja_JP, ko_KR, zh_CN, zh_TW, fr_FR, de_DE, it_IT, es_ES, pt_BR |
en_US |
Component restart |
|
LogAtInterchangeEnd | true or false | false |
Component restart |
This property is valid only if the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
MaxEventCapacity | 1 through 2147483647 | 2147483647 | Dynamic |
This property is valid only if the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
MessageFileName | Valid file name | InterchangeSystem.txt |
Component restart |
|
MonitorQueue | Any valid queue name |
<CONNECTORNAME> /MONITORQUEUE |
Component restart |
This property is valid only if the value of DuplicateEventElimination is true and ContainerManagedEvents has no value. |
OADAutoRestartAgent | true or false | false | Dynamic |
This property is valid only if the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
OADMaxNumRetry | A positive integer | 1000 | Dynamic |
This property is valid only if the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
OADRetryTimeInterval |
A positive integer in minutes |
10 | Dynamic |
This property is valid only if the value of Repository Directory is set to <REMOTE> and the value of BrokerType is ICS. |
PollEndTime |
HH = 0 through 23 MM = 0 through 59 |
HH:MM |
Component restart |
|
PollFrequency |
A positive integer (in milliseconds) |
10000 |
Dynamic if broker is ICS; otherwise Component restart |
|
PollQuantity | 1 through 500 | 1 |
Agent restart |
This property is valid only if the value of ContainerManagedEvents is JMS. |
PollStartTime |
HH = 0 through 23 MM = 0 through 59 |
HH:MM |
Component restart |
|
RepositoryDirectory |
<REMOTE> if the broker is ICS; otherwise any valid local directory. |
For ICS, the value is set
to <REMOTE> For WMQI and WAS, the value is <ProductDir \repository |
Agent restart |
|
RequestQueue | Valid JMS queue name |
<CONNECTORNAME> /REQUESTQUEUE |
Component restart |
This property is valid only if the value of DeliveryTransport is JMS |
ResponseQueue | Valid JMS queue name |
<CONNECTORNAME> /RESPONSEQUEUE |
Component restart |
This property is valid only if the value of DeliveryTransport is JMS. |
RestartRetryCount | 0 through 99 | 7 |
Dynamic if ICS; otherwise Component restart |
|
RestartRetryInterval |
A value in minutes from 1 through 2147483647 |
1 |
Dynamic if ICS; otherwise Component restart |
|
ResultsSetEnabled | true or false | false |
Component restart |
Used only by connectors
that support DB2II. This property is valid only if the value of DeliveryTransport is JMS, and the value of BrokerType is WMQI. |
ResultsSetSize | Positive integer |
0 (means the results set size is unlimited) |
Component restart |
Used only by connectors
that support DB2II. This property is valid only if the value of ResultsSetEnabled is true. |
RHF2MessageDomain | mrm or xml | mrm |
Component restart |
This property is valid only if the value of DeliveryTransport is JMS and the value of WireFormat is CwXML. |
SourceQueue |
Any valid WebSphere MQ queue name |
<CONNECTORNAME> /SOURCEQUEUE |
Agent restart |
This property is valid only if the value of ContainerManagedEvents is JMS. |
SynchronousRequest Queue |
Any valid queue name. |
<CONNECTORNAME> /SYNCHRONOUSREQUEST QUEUE |
Component restart |
This property is valid only if the value of DeliveryTransport is JMS. |
SynchronousRequest Timeout |
0 to any number (milliseconds) |
0 |
Component restart |
This property is valid only if the value of DeliveryTransport is JMS. |
SynchronousResponse Queue |
Any valid queue name |
<CONNECTORNAME> /SYNCHRONOUSRESPONSE QUEUE |
Component restart |
This property is valid only if the value of DeliveryTransport is JMS. |
TivoliMonitorTransaction Performance |
true or false | false |
Component restart |
|
WireFormat | CwXML or CwBO | CwXML |
Agent restart |
The value of this property must be CwXML if the value of RepositoryDirectory is not set to <REMOTE>. The value must be CwBO if the value of RepositoryDirectory is set to <REMOTE>. |
WsifSynchronousRequest Timeout |
0 to any number (milliseconds) | 0 |
Component restart |
This property is valid only if the value of BrokerType is WAS. |
XMLNameSpaceFormat | short or long or no | short |
Agent restart |
This property is valid only if the value of BrokerType is WMQI or WAS |