Novell Doc: Identity Manager 3.6 Driver for PeopleSoft 5.2 Implementation Guide

A.1 Driver Configuration

In iManager:

Click to display the Identity Manager Administration page.
Open the driver set that contains the driver whose properties you want to edit:
1. In the Administration list, click Identity Manager Overview.
2. If the driver set is not listed on the Driver Sets tab, use the Search In field to search for and display the driver set.
3. Click the driver set to open the Driver Set Overview page.
Locate the driver icon, then click the upper right corner of the driver icon to display the Actions menu.
Click Edit Properties to display the driver’s properties page.

By default, the Driver Configuration page is displayed.

In Designer:

Open a project in the Modeler.
Right-click the driver icon or line, then select click Properties > Driver Configuration.

The Driver Configuration options are divided into the following sections:

A.1.1 Driver Module

The driver module changes the driver from running locally to running remotely or the reverse.

Table A-1 Driver Module

Option	Description
Java	Used to specify the name of the Java class that is instantiated for the shim component of the driver. This class can be located in the classes directory as a class file, or in the lib directory as a .jar file. If this option is selected, the driver is running locally. The Java class name is: com.novell.nds.dirxml.driver.psoftshim.PSOFTDriverShim
Native	This option is not used with the PeopleSoft driver.
Connect to Remote Loader	Used when the driver is connecting remotely to the connected system. Designer includes two suboptions: Driver Object Password: Specifies a password for the Driver object. If you are using the Remote Loader, you must enter a password on this page. Otherwise, the remote driver does not run. The Remote Loader uses this password to authenticate itself to the remote driver shim. Remote Loader Client Configuration for Documentation: Includes information on the Remote Loader client configuration when Designer generates documentation for the driver.

Option

Description

Java

Used to specify the name of the Java class that is instantiated for the shim component of the driver. This class can be located in the classes directory as a class file, or in the lib directory as a .jar file. If this option is selected, the driver is running locally.

The Java class name is:

com.novell.nds.dirxml.driver.psoftshim.PSOFTDriverShim

Native

This option is not used with the PeopleSoft driver.

Connect to Remote Loader

Used when the driver is connecting remotely to the connected system. Designer includes two suboptions:

Driver Object Password: Specifies a password for the Driver object. If you are using the Remote Loader, you must enter a password on this page. Otherwise, the remote driver does not run. The Remote Loader uses this password to authenticate itself to the remote driver shim.
Remote Loader Client Configuration for Documentation: Includes information on the Remote Loader client configuration when Designer generates documentation for the driver.

A.1.2 Driver Object Password (iManager Only)

Table A-2 Driver Object Password

Option	Description
Driver Object Password	Use this option to set a password for the driver object. If you are using the Remote Loader, you must enter a password on this page or the remote driver does not run. This password is used by the Remote Loader to authenticate itself to the remote driver shim.

A.1.3 Authentication

The Authentication section stores the information required to authenticate to the connected system.

Table A-3 Authentication

Option	Description
Authentication ID or User ID	Specify an administrative account that the driver can use to authenticate to PeopleSoft. For more information, see Section 4.1, Creating a PeopleSoft Account. Example: PSAdmin
Authentication Context or Connection Information	Specify the IP address or name of the PeopleSoft server the driver should communicate with. The connection string uses the following format: <hostname or IP address>:<Port Number> Example: //PSServer:9000 To enable failover and load balancing, you can supply multiple server connection strings separated by a comma. Example: //PSServer:9000,//111.222.3.4:9000
Remote Loader Connection Parameters or Host name Port KMO Other parameters	Used only if the driver is connecting to the application through the remote loader. The parameter to enter is hostname=xxx.xxx.xxx.xxx port=xxxx kmo=certificatename, when the hostname is the IP address of the application server running the Remote Loader service and the port is the port the Remote Loader is listening on. The default port for the Remote Loader is 8090. The kmo entry is optional. It is only used when there is an SSL connection between the Remote Loader and the Metadirectory engine. Example: hostname=10.0.0.1 port=8090 kmo=IDMCertificate
Driver Cache Limit (kilobytes) or Cache limit (KB)	Specify the maximum event cache file size (in KB). If it is set to zero, the file size is unlimited. Click Unlimited to set the file size to unlimited in Designer.
Application Password or Set Password	Specify the password for the user object listed in the Authentication ID field.
Remote Loader Password or Set Password	Used only if the driver is connecting to the application through the Remote Loader. The password is used to control access to the Remote Loader instance. It must be the same password specified during the configuration of the Remote Loader on the connected system.

Option

Description

Authentication ID

User ID

Specify an administrative account that the driver can use to authenticate to PeopleSoft. For more information, see Section 4.1, Creating a PeopleSoft Account.

Example: PSAdmin

Authentication Context

Connection Information

Specify the IP address or name of the PeopleSoft server the driver should communicate with.

The connection string uses the following format:

Example: //PSServer:9000

To enable failover and load balancing, you can supply multiple server connection strings separated by a comma.

Example: //PSServer:9000,//111.222.3.4:9000

Remote Loader Connection Parameters

Host name

Port

KMO

Other parameters

Used only if the driver is connecting to the application through the remote loader. The parameter to enter is hostname=xxx.xxx.xxx.xxx port=xxxx kmo=certificatename, when the hostname is the IP address of the application server running the Remote Loader service and the port is the port the Remote Loader is listening on. The default port for the Remote Loader is 8090.

The kmo entry is optional. It is only used when there is an SSL connection between the Remote Loader and the Metadirectory engine.

Example: hostname=10.0.0.1 port=8090 kmo=IDMCertificate

Driver Cache Limit (kilobytes)

Cache limit (KB)

Specify the maximum event cache file size (in KB). If it is set to zero, the file size is unlimited.

Click Unlimited to set the file size to unlimited in Designer.

Application Password

Set Password

Specify the password for the user object listed in the Authentication ID field.

Remote Loader Password

Set Password

Used only if the driver is connecting to the application through the Remote Loader. The password is used to control access to the Remote Loader instance. It must be the same password specified during the configuration of the Remote Loader on the connected system.

A.1.4 Startup Option

The Startup Option section allows you to set the driver state when the Identity Manager server is started.

Table A-4 Startup Option

Option	Description
Auto start	The driver starts every time the Identity Manager server is started.
Manual	The driver does not start when the Identity Manager server is started. The driver must be started through Designer or iManager.
Disabled	The driver has a cache file that stores all of the events. When the driver is set to Disabled, this file is deleted and no new events are stored in the file until the driver state is changed to Manual or Auto Start.
Do not automatically synchronize the driver	This option only applies if the driver is deployed and was previously disabled. If this is not selected, the driver re-synchronizes the next time it is started.

A.1.5 Driver Parameters

The Driver Parameters section lets you configure the driver-specific parameters. When you change driver parameters, you tune driver behavior to align with your network environment.

The parameters are presented by category:

Table A-5 Driver Settings

Option	Description
Schema CI Name	Allows you to list the Data Schema Component Interfaces that the driver synchronizes. Use the Plus icon to add an item, the Minus icon to delete an item, and the Pen icon to edit an item. The default is DIRXML_SCHEMA01.
Data Record ID Field	Specify the name of the data record definition that uniquely identifies a PeopleSoft object. The default is Assoc_ID.
Use Case-Sensitive Search	Controls whether the driver uses case-sensitive matching criteria while evaluating search attribute matches. The default is No Case-Sensitive Matching.

Table A-6 Subscriber Settings

Option	Description
Allow "add" events	Subscriber Add events are implemented by invoking the Component Interface Create method (if present). If you want the driver to allow Subscriber channel Add events, select Allow Subscriber add. The default is Disallow Subscriber add.
Data Record ID Field Default Value	Specify a default value for the Schema CI key field. This parameter is used only for Subscriber channel Add events. The default is New.
Allow "delete" events	Subscriber Delete events are implemented by invoking the Component Interface Delete method (if present). If you want the driver to allow Subscriber channel Delete events, select Allow Subscriber delete. The default is Disallow Subscriber delete.

Table A-7 Publisher Settings

Parameter	Description
Transaction CI Name	Specify the name of the PeopleSoft CI object that defines the set of fields required for the driver Transaction interface. The set of fields in the specified transaction CI must contain the same fields and keys that are identified in the default transaction CI in order for the driver to work. The default is DIRXML_TRANS01.
Driver Subset Identifier	Specify the value of the DIRXML_DRIVER field in the transaction CI that identifies a subset of published transactions. This value is used for polling the transaction CI to retrieve relevant transactions from the PeopleSoft application.
Publisher Polling Option	The PeopleSoft driver supports two options for Publisher Transaction record polling. To choose an interval of seconds between polls, select Utilize Interval Polling. To use a crontab format, select Utilize crontab Format Polling. If you select Utilize Interval Polling, fill in the Queue Poll Interval by specifying the number of seconds between checks for available transactions to process. The default is 5. If you select Utilize crontab Format Polling, fill in the Enter Queue Poll crontab Format String by specifying the polling interval in crontab format. The default value of * * * * * generates a poll every minute.
Publisher Heartbeat Interval	Specify how many minutes of inactivity can elapse before this channel sends a heartbeat document. In practice, more than the number of minutes specified can elapse. That is, this parameter defines a lower bound.