B.1 Driver Configuration

In iManager:

  1. Click Identity Manager > Identity Manager Overview, then click Search to search for the driver set that is associated with the driver.

  2. Browse to the driver, then click the upper right corner of the driver icon.

  3. Click Edit Properties > Driver Configuration.

In Designer:

  1. Open a project in the Modeler, then right-click the driver line and click Properties > Driver Configuration.

There are different sections under Driver Configuration. Each section is listed in a table. The table contains a description of the fields, and the default value or an example of what value should be specified in the field.

B.1.1 Driver Module

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

In iManager:

  1. Click Identity Manager > Identity Manager Overview, then click Search to search for the driver set that is associated with the driver.

  2. Browse to the driver, then click the upper right corner of the driver icon.

  3. Click Edit Properties > Driver Configuration > Driver Module.

In Designer:

  1. Open a project in the Modeler, then right-click the driver line and select Properties > Driver Configuration.

  2. Select the Driver Module tab.

    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.

    Native

    Used to specify the name of the .dll file that is instantiated for the application shim component of the driver. If this option is selected, the driver is running locally.

    Connect to Remote Loader

    Used when the driver is connecting remotely to the connected system.

    Remote Loader Client Configuration for Documentation

    Includes the Remote Loader client configuration information in the driver documentation that is generated by Designer.

B.1.2 Driver Object Password

In iManager:

  1. Click Identity Manager > Identity Manager Overview, then click Search to search for the driver set that is associated with the driver.

  2. Browse to the driver, then click the upper right corner of the driver icon.

  3. Click Edit Properties > Driver Configuration > Driver Object Password > Set Password.

In Designer:

  1. Open a project in the Modeler, then right-click the driver line and click Properties > Driver Configuration.

  2. Click Driver Module > Connect to Remote Loader > Driver Object Password > Set 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.

B.1.3 Authentication

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

In iManager:

  1. Click Identity Manager > Identity Manager Overview, then click Search to search for the driver set that is associated with the driver.

  2. Browse to the driver, then click the upper right corner of the driver icon.

  3. Click Edit Properties > Driver Configuration > Authentication.

In Designer:

  1. Open a project in the Modeler, then right-click the driver line and select Properties > Driver Configuration.

  2. Click Authentication.

    Option

    Description

    Authentication ID

    or

    User ID

    Specify a user application ID. This ID is used to pass Identity Vault subscription information to the application.

    Example: Administrator

    Authentication Context

    or

    Connection Information

    Specify the IP address or name of the server the application shim should communicate with.

    The connection string uses the following format: <hostname or IP address>:<Port Number> Example: //PSServer:9000

    To enable failover and loadbalancing, 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 host name is the IP address of the application server running the Remote Loader server 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.

B.1.4 Startup Option

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

In iManager:

  1. Click Identity Manager > Identity Manager Overview, then click Search to search for the driver set that is associated with the driver.

  2. Browse to the driver, then click the upper right corner of the driver icon.

  3. Click Edit Properties > Driver Configuration > Startup Option.

In Designer:

  1. Open a project in the Modeler, then right-click the driver line and select Properties > Driver Configuration.

  2. Click 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.

B.1.5 Driver Parameters

In iManager:

  1. Click Identity Manager > Identity Manager Overview, then click Search to search for the driver set that is associated with the driver.

  2. Browse to the driver, then click the upper right corner of the driver icon.

  3. Click Edit Properties > Driver Configuration > Driver Parameters.

In Designer:

  1. Open a project in the modeler, then right-click the driver line and select Properties > Driver Configuration.

  2. Click Driver Parameters.

    Parameter

    Description

    Driver Settings

     

    Driver parameters for server: Server-name

    Specifies the name of the server on which the driver resides.

    Edit XML

    Allows you to edit the PeopleSoft driver parameters through an XML editor.

    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

    Specifies the name of the data record definition that uniquely identifies a PeopleSoft object. The default is Assoc_ID.

    Use Case-Sensitive Search

    Controls if the driver uses case-sensitive matching criteria while evaluating search attribute matches. The default is No Case-Sensitive Matching.

    Subscriber Setting

     

    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

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

    Publisher Settings

     

    Transaction CI Name

    Contains 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

    The name of the field in the Data Schema Component Interface that uniquely identifies a PeopleSoft object. This name is used for All Data Schema CIs that are specified in the Schema CI Name parameter.

    The field identifies which transactions in the transaction CI are to be processed by the driver. When the driver reads a transaction CI record, it compares the values of the DIRXML_DRIVER field with this parameter value and only processes transactions that match.

    A match is determined by matching characters for the length of this parameter value. For instance, if this parameter is NPSDriver and the DIRXML_DRIVER field in a transaction is NPSDriver1, a match is made.

    This allows multiple drivers to utilize the same transaction CI, which in turn can be populated by multiple PeopleSoft applications or processes.

    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.

    Queue Poll Interval (seconds) or Enter Queue Poll crontab Format String

    If you select Utilize Interval Polling, this entry displays Queue Poll Interval. Specify the number of seconds between checks for available transactions to process. The default is 5.

    If you select Utilize crontab Format Polling, this entry displays Enter Queue Poll crontab Format String. Specify five required crontab field parameters that are separated by blank characters. The default value of * * * * * generates a poll every minute.