C.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. In this document, each section is listed in a table. The table contains a description of the fields, and the default value or an example of the value that should be specified in the field.

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

    See Table C-1 for a list of the driver module options.

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.

    See Table C-1 for a list of the driver module options.

Table C-1 Driver Modules

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.

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.

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

    See Table C-2 for more information.

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.

    See Table C-2 for more information.

Table C-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.

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

    See Table C-3 for a list of the authentication options.

In Designer:

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

  2. Click Authentication.

    See Table C-3 for a list of the authentication options.

Table C-3 Authentication Options

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.

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.

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

    See Table C-4 for a list of the startup options.

In Designer:

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

  2. Click Startup Option.

    See Table C-4 for a list of the startup options.

Table C-4 Startup Options

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.

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

    See Table C-5 for a list of the 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.

    See Table C-5 for a list of the driver parameters.

Table C-5 Driver Parameters

Parameter Name

Parameter Descriptions

Driver Name

The actual name you want to use for the driver.

WorkOrders Container

The name of the container where work orders are to be stored.

WorkToDo Container

The name of the container to store configured work orders.

Polling Method

Specifies the polling method by interval or time. Interval indicates that the driver will poll at a specified time interval. Polling by time indicates a specific time of day.

Driver Heartbeat

Specifies if the Publisher should emit heartbeat documents. The driver emits heartbeat documents to indicate to the Identity Manager that the driver is still functioning.

Install Driver as Remote or Local

Select Remote to configure the driver for use with the Remote Loader service.

Select Local to configure the driver for local use.

Poll Interval

The polling interval (in minutes) at which the Publisher channel polls the Identity Manager Vault for work orders to be configured.

Poll Time

Time of day the Publisher channel wakes up to check the Identity Manager Vault for work orders to be configured.