Configuring the connector

You must configure the connector's standard and connector-specific connector configuration properties before you can run it. To configure connector properties, use:

As you enter configuration values, they are saved in the repository.

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.

Important:
Because this connector supports all integration brokers, configuration properties for all brokers are relevant to it.

Table 4 provides information specific to this connector about a configuration property in the appendix.

Table 4. Property information specific to this connector
Property Note
AgentConnections Because this connector is single-threaded, do not change the default value of this property.
CharacterEncoding 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 adapter to determine currently supported locales.

Connector-specific properties

This section documents configuration properties specific to this connector at runtime. Connector-specific properties provide a way of changing static information or logic within the connector without having to recode and rebuild it.

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

Table 5. Connector-specific configuration properties
Name Possible values Default value Required
AppServerMachineNameOrIP
n/a Yes
ApplicationPassword Password for the connector's user account PS Yes
ApplicationUserName Name of the connector's user account PS Yes
ConnectorID Name of connector for event distribution null No
ConvertToPrimitiveFloat true or false false No
EventKeyDelimiter <NameValueChar><DelimiterChar> Note: Do not specify a space between the actual characters. =: No
PingCompInterface replace <CHANGEME> with the name of an existing component interface CHANGEME Yes
PollQuantity Values are 1 to 500 1 No
PortNumber The Jolt port number 9000 Yes
ReconnectSessionOnGetFail true or false false No
SetLangCode true or false false No
UseDefaults true or false false Yes
Version PeopleTools version number 8.15 Yes

AppServerMachineNameOrIP

The name or IP address of the machine where the Application Server is running. The connector uses this value only when connecting to the application.

ApplicationPassword

Password for the connector's user account in the PeopleSoft application.

There is no default value.

ApplicationUserName

Name of the connector's user account in the PeopleSoft application.

There is no default value.

ConnectorID

The value of this property is used to search for events in the CW_EVENT_TBL through the cweventci. It is used for event distribution, when multiple connectors are used to retrieve specific events. If the value is left blank or null, this property will not be set prior to invoking the Find() method in the event component interface.

ConvertToPrimitiveFloat

Specifies whether to convert float objects to primitive float objects.

The default value is false.

EventKeyDelimiter

Specifies the two characters in name-value pairs that separate the name from its value (NameValue character) and the pairs from each other (Delimiter character). The following example uses the default equals (=) NameValue character and default colon (:) Delimiter character:

SETID=1234:DEPTID=5678
 

The default value is =:

PIngCompInterface

Pings the component interface to test for network connectivity/session validity. FAIL is returned when either the session or connectivity are invalid. When the name of the component interface is given, the connector agent terminates if the session instance is unable to get that interface, because of either invalid session or network connectivity issues.

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.

PortNumber

The Jolt Port Number (not the Tuxedo port number) on the Application Server. The connector connects to the JSL, not to the WSL.

The default value is 9000

ReconnectSessionOnGetFail

If set to true, the connector automatically creates a new session object and reconnects to the PeopleSoft application. The connector uses this property only when the component interface's Get() method returns a non-critical error or warning message that terminates the connector's session object. Typically this problem arises when an instance has different keys from those used by the connector.

The default value is false.

SetLangCode

Specifies whether the connector sets the base language immediately after it connects to the PeopleSoft application. If set to true, the connector uses a workaround that correctly updates the base language in the base table rather than in the language table. If you set this property to false, your base tables may not be updated correctly.

The default value is false.

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.

Version

Specifies the current version of PeopleTools on which the application is running. The value should be specified to the latest available decimal point.

The default value is 8.16.

Copyright IBM Corp. 1997, 2003