4.2 Creating the Driver in Designer

You create the for Avaya PBX driver by importing the driver’s basic configuration file and then modifying the configuration to suit your environment. After you’ve created and configured the driver, you need to deploy it to the Identity Vault and start it.

4.2.1 Importing the Driver Configuration File

  1. In Designer, open your project.

  2. In the Modeler, right-click the driver set where you want to create the driver, then select New > Driver to display the Driver Configuration Wizard.

  3. In the Driver Configuration list, select Avaya PBX, then click Run.

  4. On the Import Information Requested page, fill in the following fields:

    Driver Name: Specify a name that is unique within the driver set.

    Driver is Local/Remote: Select Local if this driver will run on the Metadirectory server without using the Remote Loader service. Select Remote if you want the driver to use the Remote Loader service, either locally on the Metadirectory server or remotely on another server.

  5. (Conditional) If you chose to run the driver remotely, click Next, then fill in the fields listed below. Otherwise, skip to Step 6.

    Remote Host Name and Port: Specify the host name or IP address of the server where the driver’s Remote Loader service is running.

    Driver Password: Specify the driver object password that is defined in the Remote Loader service. The Remote Loader requires this password to authenticate to the Metadirectory server.

    Remote Password: Specify the Remote Loader’s password (as defined on the Remote Loader service). The Metadirectory engine (or Remote Loader shim) requires this password to authenticate to the Remote Loader

  6. Click Next to import the driver configuration.

    At this point, the driver is created from the basic configuration file. To ensure that the driver works the way you want it to for your environment, you must review and modify the driver’s default configuration settings.

  7. To review or modify the default configuration settings, click Configure, then continue with the next section, Configuring the Driver.


    To skip the configuration settings at this time, click Close. When you are ready to configure the settings, continue with Configuring the Driver.

4.2.2 Configuring the Driver

There are many settings that can help you customize and optimize the driver. The settings are divided into categories such as Driver Configuration, Engine Control Values, and Global Configuration Values (GCVs). Although it is important for you to understand all of the settings, your first priority should be to review the Driver Parameters located on the Driver Configuration page and the Global Configuration Values. These settings must be configured properly for the driver to start and function correctly.

If you do not have the Driver Properties page displayed in Designer:

  1. Open your project.

  2. In the Modeler, right-click the driver icon Driver icon or the driver line, then select Properties.

In addition to the driver settings, you need to modify the default policies provided by the basic driver configuration. Review the information in the following sections to help with the policies:

4.2.3 Using Emulation to Test the Driver

Creating a robust test environment can be a challenge because the only PBX available in an environment might be the production PBX. To solve this problem, the Avaya PBX driver provides emulation capabilities. For an explanation of these capabilities, see What Is Emulation Mode and Why Should I Use it?.

To set up emulation:

  1. Configure the Emulation options on the driver parameters. For instructions, see Section A.1.5, Driver Parameters.

  2. Modify the PBX Site object to change the Access Type to Emulate or AudixEmulate. You must do this in iManager:

    1. In iManager, click the View Objects icon to display the Identity Vault tree.

    2. Open the PBX Site container.

    3. Open the PBX Site object.

    4. In the Access Type list, select Emulate or AudixEmulate.

    5. Click OK to save your changes.

After you configure the emulation settings, you must deploy the driver to the Identity Vault before you can test it. Continue with the next section, Deploying the Driver.

4.2.4 Deploying the Driver

After a driver is created and configured in Designer, it must be deployed into the Identity Vault.

  1. In Designer, open your project.

  2. In the Modeler, right-click the driver icon Driver icon or the driver line, then select Live > Deploy.

  3. If you are authenticated to the Identity Vault, skip to Step 5; otherwise, specify the following information:

    • Host: Specify the IP address or DNS name of the server hosting the Identity Vault.

    • Username: Specify the DN of the user object used to authenticate to the Identity Vault.

    • Password: Specify the user’s password.

  4. Click OK.

  5. Read the deployment summary, then click Deploy.

  6. Read the message, then click OK.

  7. Click Define Security Equivalence to assign rights to the driver.

    The driver requires rights to objects within the Identity Vault. The Admin user object is most often used to supply these rights. However, you might want to create a DriversUser (for example) and assign security equivalence to that user. Whatever rights that the driver needs to have on the server, the DriversUser object must have the same security rights.

    1. Click Add, then browse to and select the object with the correct rights.

    2. Click OK twice.

  8. Click Exclude Administrative Roles to exclude users that should not be synchronized.

    You should exclude any administrative User objects (for example, Admin and DriversUser) from synchronization.

    1. Click Add, then browse to and select the user object you want to exclude.

    2. Click OK.

    3. Repeat Step 8.a and Step 8.b for each object you want to exclude.

    4. Click OK.

  9. Click OK.

4.2.5 Starting the Driver

When a driver is created, it is stopped by default. To make the driver work, you must start the driver and cause events to occur. Identity Manager is an event-driven system, so after the driver is started, it won’t do anything until an event occurs.

To start the driver:

  1. In Designer, open your project.

  2. In the Modeler, right-click the driver icon Driver icon or the driver line, then select Live > Start Driver.

For information about management tasks with the driver, see Section 9.0, Managing the Driver.