3.2 Creating the Driver in iManager

You create the SharePoint driver by importing the driver’s preconfig file and then modifying the configuration to suit your environment. After you create and configure the driver, you need to start it.

3.2.1 Importing the Driver Configuration File

  1. In iManager, click Driver icon to display the Identity Manager Administration page.

  2. Click Identity Manager Overview > Driver Set and open an existing driver set or create a new driver set. From the Driver Set Overview page that displays, select Add Driver from the Drivers drop-down list.

  3. From the Import Configuration page, select the driver set where you want to create the SharePoint driver, then click Next.

  4. Select the Identity Manager 3.6 configurations option from the Show drop-down list.

  5. Select the SHAREPOINT-IDM3_6_0-V1.xml option from the Configurations drop-down list, then click Next.

  6. Follow the wizard prompts, filling in the requested information until you reach the Summary page.

    Field

    Description

    Driver Name

    Specify a name that is unique within the driver set.

    User Name

    Specify the SharePoint user’s name. The driver shim requires this name to access the SharePoint site (For example, AD-DOMAIN\username).

    User Password

    Specify the SharePoint user’s password. The driver shim requires this password to access the SharePoint site.

    Site Collection URL

    Specify the URL of the top-level SharePoint site collection with which the shim will interact.

    Working Directory

    Specify the full path of a directory on the local file system where Publisher state information for the driver can be stored. The driver process must have write access to the directory.

    Domain Name

    Specify the Active Directory domain name that the SharePoint site collection is a part of. On most systems, the NETBIOS name is the domain name. The publisher channel synchronizes objects only from this domain. To synchronize all the objects found in the SharePoint site collection that match the Publisher filter, leave the Domain Name blank.

    Polling Interval in seconds

    Specify the number of seconds the Publisher channel should wait after polling SharePoint for new changes before polling again.

    AD Domain Name

    Specify the Active Directory domain name of the domain used by the SharePoint site collection. This value is used with the value of the Identity Vault DirXML-ADAliasName attribute to construct the SharePoint User LoginName attribute.

    For example, AD-DOMAIN and JDoe become AD-DOMAIN\JDoe.

    User Container

    Specify the container where users are stored by using the slash format.

    Driver is Local/Remote

    The default is Remote, because the SharePoint driver cannot be loaded by the engine. The SharePoint driver should only be loaded by the .NET Remote Loader.

    Do not change the default value.

    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.

    Define Security Equivalences

    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.

    Exclude Administrative Roles

    You should exclude any administrative User objects (for example, Admin and DriversUser) from synchronization.

    When you finish providing the information required by the wizard, the following Summary page is displayed.

    At this point, the driver is created from the preconfig 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 modify the default configuration settings, click the linked driver name, then continue with the next section, Configuring the Driver.

    or

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

3.2.2 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 configure the settings:

  1. Make sure the Modify Object page for the SharePoint driver is displayed in iManager. If it is not:

    1. In iManager, click to display the Identity Manager Administration page.

    2. Click Identity Manager Overview.

    3. Browse to and select the driver set object that contains the new driver.

    4. Click the driver set name to access the Driver Set Overview page.

    5. Click the upper right corner of the driver, then click Edit properties.

  2. Review the settings on the various pages and modify them as needed for your environment. The configuration settings are explained in Section A.0, Driver Properties.

  3. After modifying the settings, click OK to save the settings and close the Modify Object page.

  4. (Conditional) If the SharePoint driver’s Summary page for the Import Configuration Wizard is still displayed, click Finish.

    WARNING:Do not click Cancel on the Summary page. This removes the driver from the Identity Vault and results in the loss of your work.

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 SharePoint, 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.5, Driver Packages.

3.2.3 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 iManager, click to display the Identity Manager Administration page.

  2. Click Identity Manager Overview.

  3. Browse to and select the driver set object that contains the driver you want to start.

  4. Click the driver set name to access the Driver Set Overview page.

  5. Click the upper right corner of the driver, then click Start driver.

    The driver cannot initialize completely unless it successfully connects to the .NET Remote Loader and loads the SharePoint driver shim.

For information about management tasks with the driver, see Section 4.0, Managing the Driver.