Configuring the connector

Connectors have two types of configuration properties: standard configuration properties and connector-specific configuration properties. You must set the values of some of these properties before running the connector.

You configure connector properties from Connector Configurator (when WebSphere MQ Integrator Broker is the integration broker) or from Connector Configurator, which is accessed from System Manager (when ICS is the integration broker). For detailed configuration information, see Appendix B, Connector Configurator or the Connector Development Guide for Java.

Standard connector properties

Standard configuration properties provide information that all connectors use. See Appendix A, Standard configuration properties for connectors for documentation of these properties.

Table 5 provides information specific to this connector about configuration properties in the appendix.

Table 5. Property information specific to this connector

Property Note
Character Encoding This connector does not use this property.
Locale Because this connector has been internationalized, you can change the value of this property. See release notes for the connector to determine currently supported locales.
Important:
WebSphere MQ Integrator Broker does not support multiple locales. Ensure that every component of your installation (for example, all adapters, applications, and the integration broker itself), are set to the same locale.
Note:
Because this connector supports all integration brokers, configuration properties for all brokers are relevant to it.

Connector-specific 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.

Table 6 lists the connector-specific configuration properties for the connector. See the sections that follow for explanations of the properties.

Table 6. Connector-specific configuration properties

Name Meaning Possible values Default value
ConnectString With the new Siebel architecture, the Siebel Java Data Bean can connect to the Siebel Object Manager using the connect string. There is no need to know the configuration file, simply read the file and connect to the Object Manager. protocol://machinename/ enterprisename/objectmanager/ servername N/A
ConnectString
(for Siebel, version 7.5)
With the new Siebel architecture, the Siebel Java Data Bean can connect to the Siebel Object Manager using the connect string. There is no need to know the configuration file, simply read the file and connect to the Object Manager. protocol://machinename/ enterprisename/objectmanager_ languageCode/ servername N/A
ApplicationUserName User account for the Siebel application
CWCONN
ApplicationPassword Password for the Siebel user account
CWCONN
ConnectErrors A set of errors returned from Siebel which are checked in the connector. These errors are considered to be fatal, and the connector is terminated when it encounters these errors. Any network failure or connectivity failure messages. These messages are separated by the ';' delimiter.
ConnectorId Used in case the system has been configured to handle multiple connectors. An integer value denoting the connector.
ViewMode Retained for backward compatibility. The value is used if there is not VM asi specified for the business component. An integer value. Refer to VM asi for details.
DataBeanRefreshInterval The value is used to refresh the Siebel data bean resources when the connector is running against Siebel 6.2.x The connector logs off after the requests processed are equal to this value and logs back in. An integer value indicating the DataBeanRefreshInterval which corresponds to the number of requests to be processed by the connector before a refresh call.
DataBeanPoolSize Indicates the maximum number of beans in the data bean pool. An integer determining the bean pool size.
SiebelLanguageCode Three letter NLS character set code used by Siebel for the languages supported. Default is US English with ENU as the NLS representation. With Siebel 7, the languages supported with their language codes is listed below: Italian (Std) -- ITA Japanese -- JPN Korean --KOR Norwegian -NOR (Bokmal) Polish -- POL Portuguese -- PTB (Brazil) Portuguese -- PTG (Portugal) Russian - RUS Spanish -- ESN (Modern Sort) Swedish -- SVE Turkish -- TUR English (US) -- ENU + all the other languages supported by NLS
DateFormat String date format for the specified locale. String representing the date format. Ex: MM/DD/YY HH:MM:SS AM/PM for US.
PollQuantity Determines the number of events that gets processed with a pollForEvents call. Integer representing the number of events that gets processed with a pollForEvents call. 1
SupportNameValuePairs Used for determining the event object key format. If not set or if set to true, the object key value needs to be a name-value pair with an "=" between the name and the value. If set to false, only one rowId can be specified. True or False False
PollAttributeDelimiter In case of multiple name-value pairs in the object key, this value determines the delimiter between the keys. If not set, the default is; (semi-colon). Character ;
ResonateSupport Indicates if Resonate has been installed with the Siebel server. The connector bean pool uses Attach/Detach calls (Siebel7) only if Resonate is installed. If not, it logs off after processing a certain number of requests. Boolean(Logoff from the bean is decided by the DataBeanRefreshInterval) setting. false
EventProcessingSupport Indicates whether the adapter processes the event or not. Can be used to switch off subscription services if necessary. Boolean True
SiebelVersion Allows the adapter to run against a specified version of Siebel without accessing the SchemeVersion Siebel business object to obtain the version. Use of the default value is recommended. 6, 7, or NONE NONE

ApplicationPassword

Password for the application user account.

There is no default value.

ApplicationUserName

Name of the application user account.

There is no default value.

ArchiveProcessed

Specifies whether the connector archives events for which there are no current subscriptions.

Set this property to true to cause events to be inserted into the Archive business component after they are deleted from the Event business component.

Set this property to false to cause the connector not to perform archive processing. If ArchiveProcessed is set to false, the connector behaves as follows:

If this property is set to false and the poll quantity is low, the connector appears to be polling the event table, but it is simply picking up the same events repeatedly.

If this property has no value, the connector assumes the value to be true. If the ArchiveTableName property also has no value, the connector assumes the archive table's name is xworlds_archive_events.

The default value is true.

ConnectorID

A unique ID for the connector. This ID is useful to retrieve events for a particular instance of the connector.

Default value is null.

PollQuantity

Number of rows in the database table that the connector retrieves per polling interval. Allowable values are 1 to 500.

The default is 1.

UseDefaults

If UseDefaults is set to true or is not set, the connector checks whether a valid value or a default value is provided for each required business object attribute. If a value is provided, the Create succeeds; otherwise, it fails.

If UseDefaults is set to false, the connector checks only whether a valid value is provided for each required business object attribute; the Create operation fails if a valid value is not provided.

The default value is false.

EventProcessingSupport

If EventProcessingSupport is set to true, the adapter processes an event. If EventProcessingSupport is set to false, the adapter does not process the event.

The default value is true.

SiebelVersion

Enables the adapter to run against specified versions of Siebel without accessing the Siebel business object Schema Version to obtain the version. Set to 6 for Siebel version 6, or to 7 for Siebel version 7.

The default value is NONE. When you use the default value, the adapter obtains the Siebel version from Schema Version. Using the default value is recommended.

Copyright IBM Corp. 1997, 2003