A.1 Driver Configuration

In iManager:

  1. Click to display the Identity Manager Administration page.

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

  3. Locate the driver icon, then click the upper right corner of the driver icon to display the Actions menu.

  4. Click Edit Properties to display the driver’s properties page.

In Designer:

  1. Open a project in the Modeler, then right-click the driver line and 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




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 name of the driver’s Java class is:



This option is not used with the Avaya PBX 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 Delimited Text driver.

A.1.2 Driver Object Password (iManager Only)

Table A-2 Driver Object Password



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



Authentication ID


User ID

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

Example: Administrator

Authentication Context


Connection Information

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

Remote Loader Connection Parameters


Host name



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= 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



Auto start

The driver starts every time the Identity Manager server is started.


The driver does not start when the Identity Manager server is started. The driver must be started through Designer or iManager.


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 Avaya PBX driver does not have any Driver Options or Subscriber Options. The following table describes the Publisher Options.

Table A-5 Publisher Options



General Options


PBX Name

Specify the name of the PBX site object. This is the same name you use for the creation of the PBX site object in the directory.

For example: [ProvoPBX]

PBX Site Objects DN

Select the container where the PBX site object resides.

Work Orders Container

Select the container where the PBX work orders object resides.

Extension Container

Select the container where the PBX extension objects will be created. This is required only if your configuration uses extension objects. If your configuration writes PBX information directly to user objects (like the workforce tree configuration does), you do not need to specify an extension container.

Audix Subscriber Container

Select the container where the Audix subscriber objects will be placed in the directory. If your configuration does not include Audix subscribers, you do not need to specify a subscriber container.

Poll Interval (minutes)

Specifies the number of minutes between checks for available transactions to process. The default is 1. Use 0 to disable the polling interval, in which case you need to set a poll time.

Poll Time

Select a poll time for the driver to use. For example, 12:00 AM. If no poll time is selected, the driver uses the poll interval only.

Emulation Options

Use these options to set up emulation for testing purposes. For information about additional tasks required to set up emulation, see Section 4.3.3, Using Emulation to Test the Driver.

Show emulation options

Select show to display the emulation options. Select hide if you don’t need to see the options.

Emulation LDAP host IP address

For emulation, the driver needs to access an LDAP host (eDirectory or any other host). Specify the IP address of the LDAP server.

Emulation LDAP Port

Specify the port number of the LDAP server used for emulation. The default is 389.

DN of login user for emulation

For emulation, the driver requires a username that has access to the LDAP server. This user must have rights to read/write to the extension containers on the server. Specify the name of the user for the LDAP server.

User password for emulation

Specify the password of the user who accesses the LDAP server. Confirm the password. You can also clear the password by selecting Remove existing password (iManager) or Clear password (Designer) and then clicking Apply.

Extension Container DN for Emulation

Specify the DN of the container where the driver will add or modify extension objects (this container must already exist on the LDAP server.) For example, ou=PbxExtensions,ou=AvayaPBX,o=Novell