Configuring the connector

You must set the connector's standard and connector-specific configuration properties before you can run it. Use one of the following tools to set a connector's configuration properties:

Standard connector properties

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

Note:
This connector is single threaded. It cannot use the AgentConnections property.
Important

Because the connector for Clarify CRM supports both the ICS and WebSphere MQ Integrator Broker, configuration properties for both brokers are relevant to the connector.

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 it.

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

Table 4. Connector-specific configuration properties

Name Possible values Default value Required
ApplicationPassword Password of user account
cw
 
Yes
ApplicationUserName Name of user account cw Yes
ArchiveTableName Name of archive table
xrds_archive
 
No
DatabaseName Name of Clarify CRM database
clarify
 
Yes
EventTableName Name of event table xrds_events Yes
FloatPrecision Precision of a float value 6 No
ServerName Name of Clarify CRM server clarify Yes
IgnoreMissingChildObject true or false true No
PollQuantity Number of events per poll 25 No
RestartCount This is an integer indicating the number of business object requests to be processed before terminating the connector. The connector processes as many incoming business object requests and terminates with the subsequent poll call. None No
DoublePrecision Precision of a double value 15 No
PollAttributeDelimiter Delimiter for attributes in event table :(colon) No
RequestRetrieve deep or shallow shallow No
SQLDumpFileName Name of file containing SQL statements C:\\temp\ XrclarifySQL.log No
StateDumpFileName Name of file for state report C:\\temp\ Xrclarify.log No
UseClarifyID true or false false No
UseDefaults true or false false No

ApplicationPassword

Password for the connector user account. The default value is cw.

ApplicationUserName

Name of the connector user account. The default value is cw.

ArchiveTableName

Name of archive table. The default name is xrds_archive.

DatabaseName

Name of the Clarify CRM database. The default name is clarify.

EventTableName

Name of event table. The default name is xrds_events.

FloatPrecision

Specifies the precision of a float value. The default value (six) is the default precision for floats in the Oracle and MSSQL databases. The value for the parameter should match the precision that the database uses for that data type. If the database has been customized, change the value for the connector to match.

ServerName

Name of the server running Clarify CRM. The default name is clarify.

IgnoreMissingChildObject

On a Retrieve operation, determines whether the operation succeeds for a hierarchical object if one or more child objects are missing. If the parameter is set to true, the retrieve operation is successful even without all child objects. If the parameter is set to false, the retrieve operation fails if all child objects are not retrieved.

The default value is true.

PollQuantity

Number of events to process per poll. The connector poll method retrieves the specified number of event records and processes them in a single poll. Processing multiple events per poll can improve performance when the application generates large numbers of events. However, since integration broker requests are blocked while the poll method is processing events, be sure not to set the number of events too high.

As a general guide, set PollQuantity to be ten percent of the average number of events you expect to have in the event table at one time.

There is a relationship between PollQuantity and PollFrequency values. The larger the PollQuantity value, the larger the PollFrequency value should be. As a general guide, set the PollFrequency to 60 Milliseconds * the PollQuantity value.

The default value is 25.

RestartCount

This is an integer indicating the number of poll requests to be processed before terminating the connector.

The default value is ?.

DoublePrecision

Specifies the precision of a double value. The default value, 15, is the default precision for doubles in the Oracle and MSSQL databases. The value for the parameter should match the precision that the database uses for that data type. If the database has been customized, change the value for the connector to match.

The default value is 15.

PollAttributeDelimiter

Specifies the delimiter for multiple attributes in the object name column of the event table. If the Clarify CRM objid is not used as the key field and the key field may contain a colon (:), set this configuration property to a single character that will not be part of the key field.

The default value is a colon (:).

RequestRetrieve

Specifies whether a connector responds to a Retrieve request by retrieving the business object's entire hierarchy (a deep retrieve) or by retrieving only the top-level business object (a shallow retrieve). The possible values are Deep and Shallow.

Note that the connector also supports the RetrieveAll verb. If the value of RequestRetrieve is set to Deep, the business object must have support for the RetrieveAll verb.

The default is shallow.

SQLDumpFileName

Name of the file containing the SQL statements executed by the Clarify API. Information is appended, so the file may need to be truncated periodically.

In Windows, the default file is C:\\temp\XrclarifySQL.logIn UNIX, the default file is $/ProductDir/XrclarifySQL.log

StateDumpFileName

Name of the file in which the Clarify API reports its state when accessing different objects. Information is appended, so the file may need to be truncated periodically.

In Windows, the default file is C:\\temp\Xrclarify.log. In UNIX, the default file is $/ProductDir/Xrclarify.log

UseClarifyID

On a Create operation, determines how the Clarify ID is created. If the parameter is set to true, Clarify CRM creates the ID. If the parameter is set to false, the connector passes in an ID to Clarify CRM.

The default value is false.

UseDefaults

If UseDefaults is set to true or 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 the parameter is set to false, the connector checks only for valid values; the Create operation fails if valid values are not provided.

The default value is false.

Copyright IBM Corp. 1997, 2003