4.3 Creating the Driver in iManager

You create the Identity Manager Driver for Avaya PBX 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 start it.

4.3.1 Importing the Driver Configuration File

  1. In iManager, click Driver icon to display the Identity Manager Administration page.

  2. In the Administration list, click Import Configuration to launch the Import Configuration wizard.

  3. Follow the wizard prompts, filling in the requested information (described below) until you reach the Summary page.

    Prompt

    Description

    Where do you want to place the new driver?

    You can add the driver to an existing driver set, or you can create a new driver set and add the driver to the new set. If you choose to create a new driver set, you are prompted to specify the name, context, and server for the driver set.

    Import a configuration into this driver set

    Use the default option, Import a configuration from the server (.XML file).

    In the Show field, select Identity Manager 3.6.1 configurations.

    In the Configurations field, select the AvayaPBXShip file.

    Driver name

    Type a name for the driver. The name must be 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.

    Remote Host Name and Port

    This applies only if the driver is running remotely.

    Specify the host name or IP address of the server where the driver’s Remote Loader service is running.

    Driver Password

    This applies only if the driver is running remotely.

    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

    This applies only if the driver is running remotely.

    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

    Define Security Equivalences

    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.

    Exclude Administrative Roles

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

    When you finish providing the information required by the wizard, a Summary page, similar to the following is displayed.

    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.

  4. To modify the default configuration settings, click the linked driver name, then continue with the next section, Configuring the Driver.

    or

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

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

To configure the settings:

  1. Make sure the Modify Object page for the Identity Manager driver for Avaya PBX is displayed in iManager. If it is not:

    1. In iManager, click to display the Identity Manager Administration page.

    2. Click Identity Manager Overview.

    3. Browse to and select the driver set object that contains the new driver.

    4. Click the driver set name to access the Driver Set Overview page.

    5. Click the upper right corner of the driver, then click Edit properties.

  2. Review the settings on the various pages and modify them as needed for your environment. The configuration settings are explained in Section A.0, Driver Properties.

  3. After modifying the settings, click OK to save the settings and close the Modify Object page.

  4. (Conditional) If the Identity Manager driver for Avaya PBX’s Summary page for the Import Configuration wizard is still displayed, click Finish.

    WARNING:Do not click Cancel on the Summary page. This removes the driver from the Identity Vault and results in the loss of your work.

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

4.3.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:

    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.

4.3.4 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 iManager, click to display the Identity Manager Administration page.

  2. Click Identity Manager Overview.

  3. Browse to and select the driver set object that contains the driver you want to start.

  4. Click the driver set name to access the Driver Set Overview page.

  5. Click the upper right corner of the driver, then click Start driver.

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