4.2 Creating the Driver Object in Designer

You create the PeopleSoft 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: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 object, such as policies, entitlements, filters, and Schema Mapping policies. These packages are only available in Designer. You can upgrade any package that is installed if there is a newer version of the package available.It is recommended to have the latest packages in the Package Catalog before creating a new driver object. For more information on upgrading packages, see Upgrading Installed Packages in the Designer 4.0.1 for Identity Manager 4.0.1 Administration Guide.

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.

    You can download the new packages from the Designer 4.0.1 Auto-update site.

  6. Select any PeopleSoft 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 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 click New > Driver.

  3. Select PeopleSoft Base, then click Next.

  4. Select the optional features to install for the PeopleSoft driver. All options are selected by default.

    PeopleSoft Password Synchronization: This package contains the policies that enable the PeopleSoft driver to synchronize passwords. If you want to synchronize passwords, verify that this option is selected. For more information, see the Identity Manager 4.0.1 Password Management Guide.

    Managed System Information: This package contains the policies that enable the Identity Reporting Module. For more information, see the Identity Reporting Module Guide.

  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 dependency 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) 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 PeopleSoft 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 PeopleSoft 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.

  9. Click Next.

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

  11. On the Application Authentication page, fill in the following fields:

    Authentication ID: Specify the authentication ID for the driver.

    Connection Information: Specify the connection information for the driver to connect to the PeopleSoft system.

    Password: Specify the password for the authentication ID.

  12. Click Next.

  13. 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 the Identity Manager 4.0.1 Remote Loader Guide.

    If you select No, skip to Step 14. 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 Metadirectory server. It must be the same password that is specified as the Driver Object password on the Remote Loader.

  14. Click Next.

  15. (Conditional) This page is displayed only if you selected to install the Managed System packages. On the Install PeopleSoft Managed System Information page, fill in the following fields to define your PeopleSoft system:

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

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

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

    Vendor: Specify the vendor of PeopleSoft system. This information is displayed in reports.

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

  16. Click Next.

  17. (Conditional) This page is displayed only if you selected to install the Data Collection packages and the Account Tracking packages. On the Install PeopleSoft Managed System Information page, fill in the following fields to define the classification of the PeopleSoft system:

    Classification: Select the classification of the PeopleSoft 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 PeopleSoft system.

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

    • Development

    • Test

    • Staging

    • Production

    • Other

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

  18. Click Next.

  19. (Conditional) This page is displayed only if you selected to install the Data Collection packages and the Account Tracking packages. On the Install PeopleSoft Managed System Information page, fill in the following fields to define the ownership of the PeopleSoft system:

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

  20. Click Next.

  21. (Conditional) This page is displayed only if you selected to install the Password Synchronization packages. On the Install PeopleSoft Password Synchronization page, fill in the following fields:

    Identity Manager accepts passwords from application: Select True to allow passwords to flow from the connected system to the Identity Vault.

    Publish passwords to NDS password: Select True to use the password from the connected system to set the non-reversible NDS password in the Identity Vault.

    Publish passwords to Distribution Password: Select True to use the password from the connected system to set the NMAS Distribution Password used for Identity Manager password synchronization.

    Require password policy validation before publishing passwords: Select True to apply the NMAS password policies during publish password operations. The password is not written to the Identity Vault if it does not comply.

    Notify the user of password synchronization failure via e-mail: Select True to notify the user by e-mail of any password synchronization failures.

  22. Click Next.

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

  24. After you have installed the driver, you must change the configuration for your environment. Proceed to Section 4.2.3, Configuring the Driver.

4.2.3 Configuring the Driver

After importing the packages, 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 PeopleSoft: Make sure that you have established a PeopleSoft administrative account for the driver (see Section 4.1, Creating a PeopleSoft Account) and that the correct authentication information, including the User ID and password, is defined for the driver parameters (see User ID:).

  • 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.3, Modifying Driver Policies.

  • Configure password synchronization: The basic driver configuration supports password synchronization through Universal Password. If you don’t want this setup, see Configuring Password Flow in the Identity Manager 4.0.1 Integrated Installation Guide.

After completing the configuration tasks, 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 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 object 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. For receiving events from the Identity Vault, ensure that driver object’s Security Equals DN has the following rights in the Identity Vault:

    Entry Rights: The rights to create entries in the Identity Vault.

    Attributes Rights: The rights to modify the attributes in the Identity Vault.

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

  4. Continue with Section 4.3, Activating the Driver.