3.2 Creating the Driver in Designer

You create the Delimited Text 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.

3.2.1 Importing the Current Driver Packages

The driver packages contain the items required to create a driver, such as policies, filters, and Schema Mapping policies. Packages are imported into the Package Catalog when you create a project, import a project, or convert a project, and you can update a package any time after it is imported. It is important to verify you have the latest packages in the Package Catalog before you install the driver.

To verify you have the latest packages in the Package Catalog:

  1. Open Designer.

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

  3. Click OK if there are no package updates

    or

    Click OK to import the package updates.

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

  5. Click Import Package.

  6. Select the Delimited Text 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.

  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 3.2.2, Installing the Driver Packages.

3.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 Delimited Text Base from the list of base packages, then click Next.

  4. Click Next.

  5. Select the Delimited Text Password Synchronization package, if you want the driver to synchronize passwords.

  6. Click Next.

  7. (Conditional) If this is the first driver you have installed in the driver set, click OK to install the Common Settings package dependency.

  8. (Conditional) Fill in the following fields on the Common Settings page:

    The Common Settings page is displayed only if the Common Settings package is installed as a dependency.

    User Container: Select the Identity Vault container where the users are added if they don’t already exist in the Identity Vault. This value becomes the default value 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 the groups are added if they don’t already exist in the Identity Vault. This value becomes the default value 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.

  9. On the Install Delimited Text Base page, fill in the following field for the driver information:

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

  10. Click Next.

  11. On the Install Delimited Text Base page, fill in the following fields:

    Input File Path: Specify the path for the input file.

    Output File Path: Specify the path for the output file.

  12. Click Next.

  13. On the Install Delimited Text Base page, fill in the following fields to configure the driver to connect through the Remote Loader:

    Connect to Remote Loader: By default, the driver is configured to connect through 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 through the Remote Loader.

    Host Name: Specify the host name 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.

    Remote Password: Specify the Remote Loader’s password (as defined on the Remote Loader). The Metadirectory 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 Metadirectory server.

  14. Click Next.

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

  16. Modify the configuration setting by continuing with the next section, Section 3.2.3, Configuring the Driver Settings.

    or

    If you do not need to configure the driver, continue with Section 3.2.4, Deploying the Driver.

3.2.3 Configuring the Driver Settings

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. These settings let you control the format and content of the input and output files.

The driver configuration settings are explained in Section A.0, Driver Properties.

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.

  3. After you have customized the driver for you environment, you must deploy the driver to the Identity Vault. Proceed to Section 3.2.4, Deploying the Driver.

3.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 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 through the deployment summary, then click Deploy.

  6. Read the successful 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 and to the input and output directories on the server. 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.

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