4.2 Creating the Driver Object in Designer

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

NOTE:You should not create driver objects by using the new Identity Manager 4.0 and later configuration files through iManager. This method of creating driver objects is no longer supported. To create drivers, you now need to use the new package management features provided in Designer.

4.2.1 Importing the Current Driver Packages

The driver packages contain the items required to create a driver, such as policies, entitlements, filters, and Schema Mapping policies. These packages are only available in Designer and can be updated after they are initially installed. You must have the most current version of the packages in the Package Catalog before you can create a new driver object.

To verify you have the most recent version of the driver packages in the Package Catalog:

  1. Open Designer.

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

  3. Click OK to update the packages

    or

    Click OK if the packages are up-to-date.

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

  5. Click Import Package.

  6. Select any SAP HR driver packages

    or

    Click Select All to import all of the packages displayed.

    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 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 click New > Driver.

  3. Select SAP HR Integration Base, then click Next.

  4. Select the optional features to install for the SAP HR driver, then click Next. All options are selected by default. The options are:

    Default Configuration: This package contains the default configuration information for the SAP HR driver. Always leave this option selected.

    Password Synchronization: This package contains the policies that enable the SAP HR 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: These packages contain the policies that enable the driver to collect data for reports. If you are using Identity Reporting, verify that this option is selected. For more information, see the NetIQ Identity Reporting: User’s Guide to Running Reports.

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

  6. (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.

  7. (Conditional) The Common Settings page is displayed only if the Common Settings package is installed as a dependency. On the Install Common Settings page, fill in the following fields:

    User Container: Select the Identity Vault container where the SAP HR accounts 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 the SAP HR accounts 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.

  8. Click Next.

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

  10. On the Install SAP HR Integration page, fill in the following fields, then click Next:

    SAP User ID: Specify SAP user ID this driver uses for SAP Logon. This is referred to as the User in the SAP Logon screen.

    SAP User Password: Specify the password for the SAP user ID.

    SAP Application Server: Specify the hostname or IP address for connecting to the appropriate SAP Application server. This is referred to as the Application Server in the SAP Logon properties.

    SAP System Number: Specify the SAP system number on the SAP application server. This is referred to as the System Number in the SAP logon properties. Use this option only if the driver is configured for SAP Connectivity.

    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 logon screen. Use this option only if the driver is configured for SAP Connectivity.

    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 shim installation directory.

    IDoc File Directory: Specify the file system location where the SAP HR IDoc files are placed by the SAP ALE system.

  11. Fill in the following fields for Remote Loader information:

    Connect To Remote Loader: Select Yes or No to determine if the driver will use the Remote Loader. For more information, see Configuring the Remote Loader and Drivers in the NetIQ Identity Manager Driver Administration Guide.

    If you select No, skip to Step 12. If you select Yes, use the following information to complete the configuration of the Remote Loader.

    Host Name: Specify the IP address or DNS name of the server where the Remote Loader is installed and running.

    Port: Specify the port number for this driver. Each driver connects to the Remote Loader on a separate port. The default value is 8090.

    Remote Loader Password: Specify a password to control access to the Remote Loader. It must be the same password that is specified as the Remote Loader password on the Remote Loader.

    Driver Password: Specify a password for the driver to authenticate to the Identity Manager server. It must be the same password that is specified as the Driver Object Password on the Remote Loader.

  12. (Conditional) The Install SAP HR Integration Managed System Information page is displayed only if you selected to install the Data Collection and Account Tracking packages. Fill in the following fields to define your SAP HR system, then click Next:

    Name: Specify a descriptive name for this SAP HR system. The name is displayed in reports.

    Description: Specify a brief description for this SAP HR system. The description is displayed in reports.

    Location: Specify the physical location of this SAP HR system. The location is displayed in reports.

    Vendor: Leave SAP as the vendor of this SAP HR system. This information is displayed in reports.

    Version: Specify the version of this SAP HR system. The version is displayed in the reports.

  13. (Conditional) The Install SAP HR Integration Managed System Information page is displayed only if you selected to install the Data Collection and Account Tracking packages. Fill in the following fields to define the classification of the SAP HR system, then click Next:

    Classification: Select the classification of the SAP HR system. This information is displayed in the reports. Your options are:

    • Mission-Critical

    • Vital

    • Not-Critical

    • Other

      If you select Other, you must specify a custom classification for the SAP HR system.

    Environment: Select the type of environment the SAP HR system provides. The options are:

    • Development

    • Test

    • Staging

    • Production

    • Other

      If you select Other, you must specify a custom classification for the SAP HR system.

  14. (Conditional) The Install SAP HR Integration Managed System Information page is displayed only if you selected to install the Data Collection and Account Tracking packages. Fill in the following fields to define the ownership of the SAP HR system, then click Next:

    Business Owner: Select a user object in the Identity Vault that is the business owner of the SAP HR 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 SAP HR system. This can only be a user object, not a role, group, or container.

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

  16. After you have installed the driver, you must change the configuration for your environment. Proceed to Section 4.0, Creating a New Driver Object.

4.2.3 Configuring the Driver Object

After installing the driver packages, you should complete the following tasks to configure the driver object before it can run:

  • Ensure that the driver can authenticate to the SAP HR system: Ensure that you have established an SAP HR administrative account for the driver (see Creating a SAP HR Account) and that the correct authentication information, including the User ID and password, is defined for the driver parameters (see 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 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 Object.

4.2.4 Deploying the Driver Object

After the driver object 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 or the driver line, then select Live > Deploy.

  3. If you are authenticated to the Identity Vault, skip to Step 4; otherwise, specify the following information, then click OK:

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

  5. Read the successful message, then click OK.

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

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

    2. Click OK twice.

      For more information about defining a Security Equivalent User in objects for drivers in the Identity Vault, see Establishing a Security Equivalent User in the NetIQ Identity Manager Security Guide.

  7. 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, then click OK.

    2. Repeat Step 7.a for each object you want to exclude.

    3. Click OK.

  8. 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. If you are using the Remote Loader with the driver, ensure the Remote Loader driver instance is running.

    For instructions, see Starting a Driver Instance in the Remote Loader in the NetIQ Identity Manager Driver Administration Guide.

  2. In Designer, open your project.

  3. In the Modeler, right-click the 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.