7.5 Configuring Initial Settings

After you create your custom base package, configure the initial package settings you want to use for the driver. When you install the driver, the driver’s initial settings create a set of objects that the driver needs for startup. The initial settings for a driver are specified as ds-object code. The ds-object code installs driver shim parameters, driver start options, named passwords, GCVs, and filters.

When you create a package, the initial settings XML for the package is empty by default. This is displayed in the Package Properties window. Unless you are extremely proficient with XML and possess a good understanding of Identity Manager schema, NetIQ recommends that you populate your initial settings from an existing template.

You can use a working driver as a template, if you want your package to use specific settings from that driver. For example, if you want to create a custom eDirectory package, you can use an eDirectory driver as your development driver and populate your initial settings from the development driver.

If you only want to include minimum initial settings in your package and configure them manually, you can also add an empty Generic App driver. You can only add certain driver properties as ds-attribute objects in the initial settings, as listed in the table below.

ds-attribute Object

Identity Vault Mapped Driver Attribute

Type

Description

name

CN

String

Specifies the name of the driver.

application-schema

DirXML-ApplicationSchema

XML

Specifies the schema of the application to which the driver connects. Each application has its own schema, but Identity Manager does not necessarily use all classes or attributes from an application schema.

For more information about application schema, see Managing a Copy of an Application Schema

configuration-manifest

DirXML-ConfigManifest

XML

Contains the driver health configuration settings for the driver. These settings allow you to monitor the state of the driver and configure the driver to perform actions automatically depending on the driver’s health state.

For more information about the Driver Health Configuration, see Driver Health Configuration.

driver-filter-xml

DirXML-DriverFilter

XML

Can include a class and attributes.

Specifies how the driver should filter incoming data. NetIQ recommends that you do not use this attribute to configure the base driver filter, instead create filter extension objects.

For more information about creating filter extension objects, see Adding Filter Extensions

reciprocal-links

DirXML-ReciprocalAttrMap

XML

The Reciprocal Attributes property page lets you create and manage backlinks between objects. For example, the Group object includes a Members attribute that contains pointers to all User objects that belong to that group. Similarly, each User object includes a Group Membership attribute that points to the Group objects of which that user is a member. These two-way links between objects are known as reciprocal mappings.

For more information about reciprocal links, see Reciprocal Attributes

driver-image

DirXML-DriverImage

String

Driver image is a 64-bit encoded image that represents the driver in the iManager Web interface.

trace-name

DirXML-TraceName

String

Trace name helps you track trace messages. This name appears in the driver trace messages. Use a trace name if the driver name is very long.

For more information about Driver Trace, see Driver Trace Levels

trace-file

DirXML-TraceFile

String

When you set a value to this field, all Java information for the driver is written to the file. The value for this field is the path for that file. As long as the file is specified, Java information is written to this file. If you do not need to debug Java, leave this field blank.

trace-file-encoding

DirXML-TraceFileEncoding

String

Specifies the trace file encoding. The trace file uses the system’s default encoding. You can specify another encoding if desired.

trace-level

DirXML-TraceLevel

Integer

You can add a trace to your driver. With the driver trace level set, DS Trace displays driver-related Identity Manager events, at the level of detail specified by the driver trace level as the engine processes the events. The driver trace level affects only the driver or driver set where it is set.

trace-size-limit

DirXML-TraceSizeLimit

Integer

Allows you to set a limit for the Java trace file. If you set the file size to Unlimited, the file grows in size until there is no disk space left.

java-module

DirXML-JavaModule

String

Specifies the driver shim XML configuration the driver uses. For example, com.novell.nds.dirxml.driver.nds.DriverShimImpl or com.novell.idm.driver.ComposerDriverShim.

native-module

DirXML-NativeModule

String

Specifies the name of the DLL file that will be instantiated for the application shim component of the driver.

driver-trace-level

DirXML-DriverTraceLevel

Integer

With the trace set, DS Trace displays Identity Manager and DirXML events as the engine processes the events. The trace level affects each driver in the driver set. Use the trace level for troubleshooting issues with the drivers when they are deployed. DS Trace displays the output of the specified trace level.

log-limit

DirXML-LogLimit

Integer

Allows you to set a limit for the log file.

shim-auth-id

DirXML-ShimAuthID

String

Specifies the application user ID. This ID is used to pass Identity Vault subscription information to the application. If you enabled SSL/TLS for eDirectory drivers, this option is greyed out.

For more information about shim, see Custom Shims

shim-auth-server

DirXML-ShimAuthServer

String

The server that the driver is associated with.

log-events

DirXML-LogEvents

XML

Specifies the types of events you want the driver to log in the audit log. For example, you can configure the driver to log errors, warning, or specific events like object modifications.

By default, the driver uses the settings from the driver set, as specified in the Log Level tab in the driver set Properties window.

For more information about configuring log levels, see Driver Set Log Levels.

shim-config-info

DirXML-ShimConfigInfo

XML

Specifies the Driver Parameters settings displayed in the Properties window for the driver.

global-config-values

DirXML-ConfigValues

XML

Specifies any GCVs configured on the driver. For more information about GCVs, see Driver Global Configuration Values.

global-engine-values

DirXML-EngineControlValues

XML

Specifies the engine control values used by all drivers, including the Subscriber channel retry interval and maximum eDirectory replication wait time.

For more information about engine control values, see Engine Control Values.

driver-start-option

DirXML-DriverStartOption

Integer

Specifies the default startup option for the driver. For more information about driver startup options, see Startup Option.

named-password

DirXML-NamedPasswords

String

Specifies any named passwords configured on the driver. For more information about named passwords, see Driver Named Passwords.

driver-cache-limit

DirXML-DriverCacheLimit

Integer

Specifies the limit to the driver cache file. By default, the driver cache (file) size is limited only by available disk space. This is the recommended setting.

For more information about driver-cache-limit, seeDriver Configuration

driver-password

DirXML-ShimAuthPassword

String

The driver shim password is prompted for during import.

Complete the following steps to add initial settings to your base package.

  1. In the Outline view, right-click the base package, then select Properties.

  2. Click Initial Settings.

  3. Click Populate From Template.

    WARNING:When you populate your initial settings from a template, Designer overwrites any XML currently in the Initial Settings window. If you have any previously-customized XML, ensure that you save the existing XML before clicking Populate From Template.

  4. In the Model Browser window, select the driver you want to use as a template, then click OK.

    NOTE:You can use any driver currently available in your workspace to populate your Initial Settings window.

  5. Modify the package initial settings as necessary for your environment.

  6. When finished, click OK.