4.2 Creating the Driver in Designer

You create the Active Directory driver by installing the driver packages and then modifying the configuration to suit your environment. After you create and configure the driver, you need to deploy it to the Identity Vault and start it.

NOTE:Drivers are created with packages, and iManager does not support packages. In order to create drivers with the current version of Identity Manager, you must use Designer.

4.2.1 Importing the Current Driver Packages

Driver packages can be updated at any time and are stored in the Package Catalog. Packages are initially imported into the Package Catalog when you create a project, import a project, or convert a project. It is important to verify you have the latest packages imported into the Package Catalog before you install the driver.

To verify you have the latest packages imported into the Package Catalog:

  1. Open Designer.

  2. In the toolbar click Help > Check for Package Updates.

  3. Click OK if there are no package update

    or

    Click OK to import the package updates. If prompted to restart Designer, click Yes and save your project, then wait until Designer restarts.

  4. In the Outline view, right-click the Package Catalog.

  5. Click Import Package.

  6. Select the Active Directory packages

    or

    Click Select All to import all of the packages displayed, then click OK.

    By default, only the base packages are displayed. Deselect Show Base Packages Only to display all packages.

    IMPORTANT:If you want the driver to support quick onboarding of custom entitlements, ensure you import the following packages to the driver:

    • NOVLACOMSET 2.0.0 (Common Settings Advanced Edition)

    • NOVLADENTEX 2.0.0 (Active Directory Entitlements and Exchange Mailbox Support)

    • NOVLADDCFG 2.3.0 (Active Directory Default Configuration)

    For information about quick onboarding of custom entitlements, see Synchronizing Permission Changes from the Connected Systems in the NetIQ Identity Manager Driver Administration Guide.

  7. Click OK to import the selected packages, then click OK in the successfully imported packages message.

  8. After the current packages are imported, continue with Section 4.2.2, Installing the Driver Packages.

4.2.2 Installing the Driver Packages

After you have imported the current driver packages into the Package Catalog, you can install the driver packages to create a new driver.

  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.

  3. Select Active Directory Base from the list of base packages, then click Next.

  4. Select the optional features to install for the Active Directory driver. All options are selected by default. The options are:

    • Default Configuration: This package contains the default configuration information for the Active Directory driver. Always leave this option selected.

    • Entitlements and Exchange Mailbox Support: This package contains configuration information for synchronizing Exchange Mailbox accounts and policies that enable account creation and auditing for the Active Directory driver. If you want account creation and auditing enabled, verify that this option is selected.

      This package also contains policies for quick onboarding of custom entitlements and dynamic resource creation. This package contains GCVs to control the resource mapping. Select this package if you want to enable the entitlement onboarding feature for this driver. For more information, see Synchronizing Permission Changes from the Connected Systems in the NetIQ Identity Manager Driver Administration Guide.

      For general information about entitlements, see the NetIQ Identity Manager Entitlements Guide.

    • Password Synchronization: This packages contains the policies that enable the Active Directory driver to synchronize passwords. If you want to synchronize passwords, verify that this option is selected. For more information, see the NetIQ Identity Manager Password Management Guide.

    • Data Collection: This package contains the policies that enable the driver to collect data for reports. If you are using the Identity Reporting Module, verify that this option is selected. For more information, see the Administrator Guide to NetIQ Identity Reporting.

    • Account Tracking: This package contains the policies that enable you to track accounts for reports. If you are using the Identity Reporting Module, verify that this option is selected. For more information, see the Administrator Guide to NetIQ Identity Reporting.

  5. Click Next.

  6. (Conditional) If there are package dependencies for the packages you selected to install, you must install them to install the selected package. Click OK to install the package dependencies listed.

  7. (Conditional) If more than one type of package dependency must be installed, you are presented with these packages separately. Continue to click OK to install any additional package dependencies.

  8. (Conditional) If not already configured, fill in the following fields on the Common Settings page, then click Next:

    • User Container: Select the Identity Vault container where Active Directory users will be added if they don’t already exist in the vault. This value becomes the default for all drivers in the driver set.

      If you want a unique location for this driver, set the value for all drivers on this page. After the driver is created, change the value on the driver’s Global Configuration Values page.

    • Group Container: Select the Identity Vault container where Active Directory groups will be added if they don’t already exist in the vault. This value becomes the default for all drivers in the driver set.

      If you want a unique location for this driver, set the value for all drivers on this page. After the driver is created, change the value on the driver’s Global Configuration Values page.

    NOTE:The Common Settings page is only displayed if the Common Settings package is a dependency.

  9. (Conditional) If not already configured, fill in the following fields on the Common Settings Advanced Edition page, then click Next:

    NOTE:This page is only displayed if you installed the Common Settings Advanced Edition package.

  10. On the Driver Information page, specify a name for the driver, then click Next.

  11. On the Authentication Parameters page, fill in the following fields to authenticate to Active Directory and click Next:

    • Authentication ID: Specify an Active Directory account with administrative privileges to be used by Identity Manager. The form of the name used depends on the selected authentication mechanism.

      For the Negotiate authentication method, provide the name form required by your Active Directory authentication mechanism. For example:

      • Administrator: Active Directory Logon Name

      • Domain/Administrator: Domain qualified Active Directory Logon Name

    • Password: Provide the password for the specified Active Directory account.

    • Authentication Context: Specify the name of the Active Directory domain controller to use for synchronization.

      For example, for the Negotiate method, use the DNS name (for example, mycontroller.domain.com). For the Simple authentication method, you can use the IP address of your server (for example, 10.10.128.23 or the DNS name).

      If no value is specified, localhost is used.

  12. On the Remote Loader page, fill in the following fields to configure the driver to connect using the Remote Loader, then click Next:

    • Connect to Remote Loader: By default, the driver is configured to connect using the Remote Loader. If you want to run the driver locally, select no, then click Next. Otherwise, fill in the remaining fields to configure the driver to connect by using the Remote Loader.

    • Host Name: Specify the hostname or IP address of the server where the driver’s Remote Loader service is running.

    • Port: Specify the port number where the Remote Loader is installed and is running for this driver. The default port number is 8090.

    • KMO: Specify the Key Name of the Key Material Object (KMO) that contains the keys and certificate the Remote Loader uses for an SSL connection. This parameter is only used when you use SSL for connections between the Remote Loader and the Identity Manager engine.

    • Other parameters: Specify any other parameters required to connect to the Remote Loader. Any parameters specified must use a key-value pair format, as follows: paraName1=paraValue1 paraName2=paraValue2

    • Remote Password: Specify the Remote Loader’s password as defined on the Remote Loader. The Identity Manager server (or Remote Loader shim) requires this password to authenticate to the Remote Loader

    • 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 Identity Manager server.

  13. On the Synchronization page, fill in the following fields to configure the driver’s synchronization settings, then click Next:

    • Domain DNS Name: Specify the DNS name of the Active Directory domain managed by this driver.

    • Subscriber Channel Placement Type: Select the desired form of placement for the Subscriber channel. This option determines the Subscriber channel Placement policies.

      • mirrored: Places objects hierarchically within the base container

      • flat: Places objects only in the base container

    • Active Directory User Container: Specify the container where user objects reside in Active Directory.

    • Publisher Channel Placement Type: Select the desired form of placement for the Publisher channel. This option determines the Publisher channel Placement policies.

      • mirrored: Places object hierarchically within the base container

      • flat: Places objects only in the base container

  14. (Conditional) On the Entitlements Name to CSV File Mappings page, click the Add Name to File Mapping Active Directory Discovery Tool icon to populate the page with the entitlement configuration options.

    Identity Manager uses the CSV file to maps Active Directory entitlements into corresponding resources in the Identity Manager catalog.

    NOTE:This page is only displayed if you installed the Entitlements and Exchange Mailbox Support package.

    The information that you specify in this page is used for creating the permission catalog. Fill in the following fields, then click Next:

    • Entitlement Name: Specify a descriptive name for the entitlement to map it to the CSV file that contains the Active Directory entitlement details.

      Entitlement Name is the name of the entitlement. This parameter corresponds to the Entitlement Assignment Attribute in Active Directory. For example, you could define an entitlement called ParkingPass.

      This parameter is used to create a resource in the User Application.

    • Entitlement Assignment Attribute: Specify a descriptive name for the assignment attribute for an entitlement.

      Entitlement Assignment Attribute holds the entitlement values in Active Directory. For example, you could have an attribute called Parking.

      You must add this parameter to Field Names in the Driver Parameters page or modify it in driver settings after creating the driver.

    • CSV File: Specify the location of the CSV file. This file must be located on the same server as the driver. This file contains the values for the application entitlements.

    • Multi-valued?: Set the value of this parameter to True if you want to assign resources and entitlements multiple times with different values to the same user. Otherwise, set it to False.

    NOTE:After creating the driver, you can modify Entitlement Name to CSV File Mapping from PermissionNameToFile mapping.

  15. (Conditional) On the Account Tracking page, fill in the following field, then click Next:

    Realm: Specify the name of the realm, security domain, or namespace where the account name is unique.

    NOTE:This page is only displayed if you installed the Account Tracking package.

  16. Click Next.

  17. (Conditional) On the General Information page, fill in the following fields to define your Active Directory system, then click Next:

    • Name: Specify a descriptive name for this Active Directory system. The name is displayed in reports.

    • Description: Specify a brief description for this Active Directory system. The description is displayed in reports.

    • Location: Specify the physical location of this Active Directory system. The location is displayed in reports.

    • Vendor: Leave Microsoft as the vendor of Active Directory. This information is displayed in reports.

    • Version: Specify the version of this Active Directory system. The version is displayed in the reports.

    NOTE:This page is only displayed if you installed the Managed System package.

  18. (Conditional) On the System Ownership page, fill in the following fields to define the ownership of the Active Directory system, then click Next:

    • Business Owner: Select a user object in the Identity Vault that is the business owner of the Active Directory system. This can only be a user object, not a role, group, or container.

    • Application Owner: Select a user object in the Identity Vault that is the application owner of the Active Directory system. This can only be a user object, not a role, group, or container.

    NOTE:This page is only displayed if you installed the Managed System package.

  19. (Conditional) On the System Classification page, fill in the following fields to define the classification of the Active Directory system, then click Next:

    • Classification: Select the classification of the Active Directory system. This information is displayed in the reports. The available options are:

      • Mission-Critical

      • Vital

      • Not-Critical

      • Other

        If you select Other, you must specify a custom classification for the Active Directory system.

    • Environment: Select the type of environment the Active Directory system provides. The available options are:

      • Development

      • Test

      • Staging

      • Production

      • Other

        If you select Other, you must specify a custom classification for the Active Directory system.

    NOTE:This page is only displayed if you installed the Managed System package.

  20. Review the summary of tasks that will be completed to create the driver, then click Finish.

The driver is now created. You can modify the configuration settings, by continuing with the next section, Section 4.2.3, Configuring the Driver. If you don’t need to configure the driver, continue to Section 4.2.3, Configuring the Driver.

4.2.3 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 access the Driver Properties page:

  1. Open your project.

  2. In the Modeler, right-click the driver icon Active Directory Discovery Tool or the driver line, then select Properties.

  3. (Conditional) Click GCVs > Entitlements and review the following settings:

    NOTE:These settings are only displayed if you installed the Entitlements package.

    • Use User Account Entitlement: Ensure the value of this parameter is set to true to enable the driver to manage user account permissions using the User Account entitlement. By default, the value is set to true.

    • Use Group Entitlement: Ensure the value of this parameter is set to true to enable the driver to manage group memberships using the Group entitlement. By default, the value is set to true.

    • Exchange Mailbox Provisioning: Ensure the value of this parameter is set to Use Exchange Mailbox Entitlement to enable the driver to provision Exchange mailboxes. By default, the value is set to Use Exchange Mailbox Entitlement.

    • Enable Permissions Collection and Reconciliation: Set the value of this parameter to true for permission reconciliation and entitlement assignment. By default, the value is set to false.

      The following settings are only displayed if you set Enable Permissions Collection and Reconciliation to true:

      • Enable Permissions Reconciliation for User Account Entitlement: Ensure the value of this parameter is set to Yes enable the driver to map Active Directory user accounts to users in the Identity Vault and assign user account entitlements through the Publisher channel. By default the value is set to Yes.

      • Allow User add via publisher channel: Set the value of this parameter to Yes to allow the driver to add new user accounts to the Identity Vault through the Publisher channel. By default, the value is set to No.

      • Enable Permissions Reconciliation for Group entitlement: Ensure the value of this parameter is set to Yes to enable the driver to assign group entitlements through the Publisher channel. By default, the value is set to Yes.

        IMPORTANT:If you set the value of this parameter to No, the user and group resource is not created in the User Application.

      • Enable Permissions Reconciliation for Exchange entitlement: Ensure the value of this parameter is set to Yes to enable the driver to assign Exchange entitlements through the Publisher channel. By default, the value is set to Yes.

      • Enable Permission Reconciliation for all Custom entitlements: If the value of this parameter is set to No, this parameter allows you to select custom entitlements for permission reconciliation. By default, the value is set to Yes, which allows permission reconciliation of all custom entitlements.

      • Select Permissions to be reconciled: This parameter is presented if the value of Enable Permission Reconciliation for all Custom entitlements is set to No.

        Click the Add Active Directory Discovery Tool icon to add custom entitlements you want to selectively onboard, specifying an Assignment Attribute Name for each entitlement.

  4. Click Apply.

  5. Modify any other settings as necessary

    In addition to the driver settings, you should review the set of default policies and rules provided by the basic driver configuration. Although these policies and rules are suitable for synchronizing with Active Directory, your synchronization requirements for the driver might differ from the default policies. If this is the case, you need to change them to carry out the policies you want. The default policies and rules are discussed in Section 1.4, Default Driver Configuration.

  6. Click OK when finished.

  7. Continue with Section 4.2.4, Deploying the Driver.

4.2.4 Deploying the Driver

After a driver is created 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 Active Directory Discovery Tool 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 through the deployment summary, then click Deploy.

  6. Read the success 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 user account called 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 Active Directory Discovery Tool or the driver line, then select Live > Start Driver.

For information about management tasks for the driver, see Section 7.0, Managing Active Directory Groups and Exchange Mailboxes.