A.1 Driver Configuration

In iManager:

  1. Click to display the Identity Manager Administration page.

  2. Open the driver set that contains the driver whose properties you want to edit:

    1. In the Administration list, click Identity Manager Overview.

    2. If the driver set is not listed on the Driver Sets tab, use the Search In field to search for and display the driver set.

    3. Click the driver set to open the Driver Set Overview page.

  3. Locate the driver icon, then click the upper right corner of the driver icon to display the Actions menu.

  4. Click Edit Properties to display the driver’s properties page.

    By default, the Driver Configuration page is displayed.

In Designer:

  1. Open a project in the Modeler.

  2. Right-click the driver icon or line, then select click Properties > Driver Configuration.

The Driver Configuration options are divided into the following sections:

A.1.1 Driver Module

The driver module changes the driver from running locally to running remotely or the reverse.

Table A-1 Driver Module

Option

Description

Java

Used to specify the name of the Java class that is instantiated for the shim component of the driver. This class can be located in the classes directory as a class file, or in the lib directory as a .jar file. If this option is selected, the driver is running locally.

The Java class name for JCO2 is:

com.novell.nds.dirxml.driver.SAPShim.SAPDriverShim

The Java class name for JCO3 is:

com.novell.nds.dirxml.driver.SAPHRShim.SAPDriverShim

Native

This option is not used with the SAP HR driver.

Connect to Remote Loader

Used when the driver is connecting remotely to the connected system. Designer includes two suboptions:

  • Driver Object Password: Specifies a password for the Driver object. If you are using the Remote Loader, you must enter a password on this page. Otherwise, the remote driver does not run. The Remote Loader uses this password to authenticate itself to the remote driver shim.

  • Remote Loader Client Configuration for Documentation: Includes information on the Remote Loader client configuration when Designer generates documentation for the driver.

A.1.2 Driver Object Password (iManager Only)

Table A-2 Driver Object Password

Option

Description

Driver Object Password

Use this option to set a password for the driver object. If you are using the Remote Loader, you must enter a password on this page or the remote driver does not run. This password is used by the Remote Loader to authenticate itself to the remote driver shim.

A.1.3 Authentication

The Authentication section stores the information required to authenticate to the connected system.

Table A-3 Authentication

Option

Description

Authentication ID

or

User ID

Specify an SAP account that the driver can use to authenticate to the SAP system.

Example: SAPHR

Authentication Context

or

Connection Information

Specify the IP address or name of the SAP server the driver should communicate with.

Remote Loader Connection Parameters

or

Host name

Port

KMO

Other parameters

Used only if the driver is connecting to the application through the remote loader. The parameter to enter is hostname=xxx.xxx.xxx.xxx port=xxxx kmo=certificatename, when the hostname is the IP address of the application server running the Remote Loader service and the port is the port the Remote Loader is listening on. The default port for the Remote Loader is 8090.

The kmo entry is optional. It is only used when there is an SSL connection between the Remote Loader and the Metadirectory engine.

Example: hostname=10.0.0.1 port=8090 kmo=IDMCertificate

Driver Cache Limit (kilobytes)

or

Cache limit (KB)

Specify the maximum event cache file size (in KB). If it is set to zero, the file size is unlimited.

Click Unlimited to set the file size to unlimited in Designer.

Application Password

or

Set Password

Specify the password for the user object listed in the Authentication ID field.

Remote Loader Password

or

Set Password

Used only if the driver is connecting to the application through the Remote Loader. The password is used to control access to the Remote Loader instance. It must be the same password specified during the configuration of the Remote Loader on the connected system.

A.1.4 Startup Option

The Startup Option section allows you to set the driver state when the Identity Manager server is started.

Table A-4 Startup Option

Option

Description

Auto start

The driver starts every time the Identity Manager server is started.

Manual

The driver does not start when the Identity Manager server is started. The driver must be started through Designer or iManager.

Disabled

The driver has a cache file that stores all of the events. When the driver is set to Disabled, this file is deleted and no new events are stored in the file until the driver state is changed to Manual or Auto Start.

Do not automatically synchronize the driver

This option only applies if the driver is deployed and was previously disabled. If this is not selected, the driver re-synchronizes the next time it is started.

A.1.5 Driver Parameters

The Driver Parameters section lets you configure the driver-specific parameters. When you change driver parameters, you tune driver behavior to align with your network environment.

The parameters are presented by category:

Table A-5 Driver Settings

Option

Description

Publisher Channel Only

Select whether you want the driver to use the Publisher channel only or if you want it to use both the Publisher and Subscriber channels.

The driver is designed to use a connection to SAP even when it is configured as a Publisher-only driver. The first purpose for using this connection is to verify the version of the SAP server so that the driver can configure itself for the proper version of IDocs it will consume. Otherwise the driver must be configured with a value for the Master HR IDoc parameter.

This connection also verifies the validity time stamps of desired infotypes during processing of future-dated event IDocs. This is an extremely critical function that should always be enabled if future-dated processing options are chosen in the driver configuration. Disabling this capability could result in the propagation of old or stale events that have been subsequently overridden.

If you don’t want a connection to the SAP server, you should remove at least one of the following connection parameters:

In this situation, the IDoc data being processed is used as a completely authoritative source of reliable data.

SAP System Number

The SAP system number on the SAP application server. This is referred to as the System Number in the SAP logon properties.

SAP User Client Number

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.

SAP User Language

The language this driver uses for the SAP session. This is referred to as the Language in the SAP R/3 logon screen.

Character Set Encoding

The character set encoding used to parse data from IDocs. By default, no character set encoding is specified, which causes the driver to use the platform default encoding. If you incorrectly specify a character set, the driver initialization fails.

Metadata File Directory

The file system location in which the SAP Metadata definition file resides. By default, this is in the SAPUtils subdirectory of the driver’s installation directory.

Master HR IDoc

The name of the IDoc type that is generated by the SAP ALE system to publish SAP HR database Master data modification. If it is not specified, the driver determines the revision of the SAP HR system and default to the standard IDoc type for that revision of SAP. The default is HRMD_A05.

This field is optional, unless you select the Publisher Channel Only option.

Future-dated Event Handling Option

The processing of this option is determined by the Begin and End validity dates of the desired IDoc infotypes. There are four possible values for this parameter. The driver default is to Publish on Future Date.

  • Publish Immediately: Indicates that all attributes will be processed by the driver when the IDoc is available. A time stamp is set for each attribute that represents the validity period.

  • Publish on a Future Date: Indicates that only attributes that have a current or past time stamp will be processed by the driver when the IDoc is available. Future-dated infotype attributes are cached in a .futr file to be processed at a future date.

  • Publish Immediately and on a Future Date: Indicates that the driver will blend options 1 and 2. All attributes are processed, with a time stamp, at the time the IDoc is available. All future-dated infotype attributes are also cached in a.futr file to be processed at a future date.

  • Publish Immediately and Daily through Future Date: Indicates that the driver will process all events at the time the IDoc is made available. All future-dated infotype attributes are cached in a .futr file to be processed again on the next calendar day. This continues until the attributes are sent for a final time on the future date.

Future-dated Event Validity Checking Option

Specify whether or not the driver attempts to filter out stale data in future-dated IDocs, by verifying the begin and end validity dates of the data.

Publish History Items

Specifies if data values that are no longer valid are published by the driver. The default is Do Not Publish History Data.

Object Type Code

A list parameter that allows an administrator to specify which HR object types are synchronized. The default list is P, S, O, and C.

Address Subtype Code

A list of configuration parameters that allows an administrator to specify which subtype of data the SAP Private Address infotype the driver synchronizes. The default is 1 and US01.

Communication Subtype Code

A list configuration parameter that allows an administrator to specify which subtype data of the SAP Communication infotype the driver synchronizes. The default is CELL, MAIL, PAGR.

Table A-6 Subscriber Settings

Option

Description

Communication Change Mode

This Subscriber channel parameter specifies how the driver handles requests to change, remove, or add Communication (Infotype 0105) record instances on employees. There are three modes of operation available. For more information on the functionality of the various modes of operation, see Section E.0, Subscriber Change Modes and Validity Date Modes.

Options include: Delimit mode Delete mode Change mode (default driver mode)

Communication Validity Date Mode

This Subscriber channel parameter specifies how Beginning and Ending validity dates are set on newly created Communication record instances on employees. There are two modes of operation available. For more information on the functionality of the various modes of operation, see Section E.0, Subscriber Change Modes and Validity Date Modes.

Internal Data Change Mode

This Subscriber channel parameter specifies how the driver handles requests to change, remove, or add Internal Control Data (Infotype 0032) record instances on employees. There are three modes of operation available. For more information on the functionality of the various modes of operation, see Section E.0, Subscriber Change Modes and Validity Date Modes.

Options include: Delimit mode Delete mode Change mode (default driver mode)

Internal Data Validity Date Mode

This Subscriber channel parameter specifies how Beginning and Ending validity dates are set on newly created Internal Control Data record instances on employees. There are two modes of operation available. For more information on the functionality of the various modes of operation, see Section E.0, Subscriber Change Modes and Validity Date Modes.

Options include: Default mode Current Date Mode (default driver mode)

Table A-7 Publisher Settings

Option

Description

IDoc File Directory

The file system location in which the SAP HR IDoc files are placed by the SAP ALE system.

This location must be accessible to the driver shim process.

Enable or Disable Publisher Connection to the SAP Application Server

Select Enable if you want the Publisher channel to read data from the SAP server in addition to IDoc data.

Select Disable to use IDoc data only.

Poll Interval (secs)

When the Publisher channel has finished processing all source files, it waits the number of seconds specified in this parameter before checking for new source files to process.

Publisher Heartbeat Interval

Specify how many minutes of inactivity can elapse before this channel sends a heartbeat document. In practice, more than the number of minutes specified can elapse. That is, this parameter defines a lower bound.