4.2 Creating the Driver in Designer

You create the SAP HR 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 SAP HR, 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.

    SAP User Client Number: Specify the client number to be used on the SAP application server. This is referred to as the Client in the SAP R/3 logon screen.

    Metadata File Directory: Specify the file system location where the SAP Metadata definition file resides. By default, this is in the SAPUtils subdirectory of the driver’s installation directory.

    IDoc File Directory: Specify the file system location where the SAP HR IDoc files are placed by the SAP ALE system. This must be accessible to the driver shim process.

    Organization Object Container: Specify the name of the Organization Unit object where the published SAP Organization (O) objects are placed.

    Position Object Container: Specify the name of the Organization Unit object where the published SAP Position (S) objects are placed.

    Job Object Container: Specify the name of the Organizational Unit object where the published SAP Job (C) objects are placed.

    User Container: Select the Identity Vault container where any new users from the SAP HR database are created. This value becomes the default for all drivers in the driver set. If you don’t want to change this value for all drivers, leave this field unchanged and change the value on the driver’s Global Configuration Values page after you’ve finished importing the driver.

    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 hostname 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 (if necessary) 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.

    or

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

4.2.2 Configuring the Driver

After importing the driver configuration file, you need to configure the driver before it can run. You should complete the following tasks to configure the driver:

  • Ensure that the driver can authenticate to the SAP HR system: Make sure that you’ve established an SAP HR administrative account for the driver (see Section 4.1, Creating a SAP HR Account) and that the correct authentication information, including the User ID and password, is defined for the driver parameters (see Section A.1.3, Authentication).

  • Configure the driver parameters: 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 configure the driver parameters located on the Driver Configuration page. For information about the driver parameters, see Section A.1.5, Driver Parameters.

  • Configure the driver policies and filter: Modify the driver policies and filter to implement your business policies. For instructions, see Section 6.0, Customizing the Driver.

Continue with the next section, Deploying the Driver.

4.2.3 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. 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.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. If you are using the Remote Loader with the driver, make sure the Remote Loader driver instance is running. For instructions, see Starting the Remote Loader in the Identity Manager 3.6.1 Remote Loader Guide.

  2. In Designer, open your project.

  3. 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 7.0, Managing the Driver.