2.1 Naming Conventions

Naming conventions make it easier to navigate and understand each driver configuration. The naming conventions are defined for all objects that belong to a driver, global configuration values (GCVs), and for user objects created through the Publisher channel.

2.1.1 Driver Configuration Files

The driver configuration file naming convention is:

<base name>[-<type>]-IDM<min. engine version>-V<config version>.xml

  • Base name: The name of the connected system or service the driver provides. For example, Active Directory or Delimited Text.

  • Type: An additional descriptor for the driver configuration file. If there are multiple configuration files, the type distinguishes among the different files.

  • Minimum Engine Version: Lists the minimum engine version that the driver can run against. The elements to date are:

    • IDM2_0_0

    • IDM2_0_1

    • IDM2_0_2

    • IDM3_0_0

    • IDM3_0_1

    • IDM3_5_0

    • IDM3_5_1

    • IDM3_6_0

  • Configuration Version: Specifies the particular driver configuration file version. It is a number that is incremented with each release of a new driver configuration file version.

    • V1

    • V2

    • V11

    • V23

For example:

  • ActiveDirectory-IDM3_6_0-V4.xml

  • DelimitedText-CSVSample-IDM3_6_0-V2.xml

2.1.2 Driver Objects

Drivers consist of a variety of objects. The naming conventions for these objects make it much easier to understand the driver configuration file.

  • Driver Set: There is no naming convention for the driver sets.

  • Driver: There is no naming convention for the drivers.

  • Channel: Use Designer and iManager to name the channel objects.

    • Publisher Channel: Publisher

    • Subscriber Channel: Subscriber

  • Driver Policy Objects: These are policies that exist underneath a driver or a channel object. These policies are usually consumed only by this driver. A driver can contain many policies; without the naming conventions, it is easy to be confused.

    <channel>-<policyset>[-<feature name>][-<WhatIsThisPolicyDoing>]

    Table 2-1 Driver Policy Object Naming Convention

    Policy Set

    DirXML Script Policy

    Style Sheet Policy

    Samples

    Subscriber Event Transformation

    sub-etp

    sub-ets

    sub-etp-VetoAdds, sub-ets-ChangeRenameToMove

    Subscriber Matching

    sub-mp

    sub-ms

     

    Subscriber Creation

    sub-cp

    sub-cs

     

    Subscriber Placement

    sub-pp

    sub-ps

     

    Subscriber Command Transformation

    sub-ctp

    sub-cts

     

    Publisher Event Transformation

    pub-etp

    pub-ets

    pub-etp-VetoAdds, pub-ets-ChangeRenameToMove

    Publisher Matching

    pub-mp

    pub-ms

     

    Publisher Creation

    pub-cp

    pub-cs

     

    Publisher Placement

    pub-pp

    pub-ps

     

    Publisher Command Transformation

    pub-ctp

    pub-cts

    pub-ctp-HandleFromMerge, pub-cts-PasswordSync

    Input Transformation

    itp

    its

     

    Output Transformation

    otp

    ots

     

    Schema Mapping

    smp

    sms

     

  • Policy Objects in Policy Libraries: Policy objects in policy libraries might be consumed by more than one driver in different policy sets and channels. The naming conventions for library policies are adapted from the driver policies.

    lib-<feature name>-<WhatIsThisPolicyDoing>[-<channel>][-<policyset>]

    • Lib: Static prefix to mark the policy as a library policy. This is important so that you can tell which policies belong to that driver and which policies do not.

    • Feature Name: Short name that describes the feature this policy is implementing. Examples might be CredProv for Credential Provisioning or PwdSync for Password Synchronization. The feature name groups multiple policies together.

    • WhatIsThisPolicyDoing: A compound word or phrase where the words are joined without spaces and are capitalized within the compound word. This word or phrase is a brief descriptive name for the policy.

    For example:

    lib-CredProv-ConvertPayload-opt
lib-CredProv-ProcessPayload-itp
lib-CredProv-RequiredAttributes-sub-cp
lib-CredProv-Trigger-sub-ctp

2.1.3 GCV

The GCV naming conventions address the different types of GCVs, the different purposes of the GCVs, and the scopes of the GCVs.

[<purpose/scope>.]<group>.[<subgroup>.]<name>

  • Purpose/Scope: The prefix idv (Identity Value) is used with driver set GCVs. Driver-specific values are drv or driver.

  • Group: Groups GCVs that belong together. Examples for groups could be communication, notification, logging, or security.

  • Subgroup: Form subgroups within groups, such as smtp or snmp.

  • Name: Descriptive name for the GCV.

For example:

idv.notification.smtp.ip
idv.notification.smtp.user
idv.notification.smtp.pwd
idv.notification.snmp.ip
idv.dit.data.locations
idv.dit.system.rbs
driver.samba.server

2.1.4 User Objects

Naming conventions for user objects define variations that each driver supports when generating names for new objects. Even though each company might have very specific naming conventions, there are common options you can use. All options must guarantee tree-wide uniqueness (not just context-wide) as a best practice. This makes login IDs globally unique so that log files of connected systems that are not hierarchical don’t run into implementation problems and log files deliver unambiguous information.

All options are base on the name Charley K Browning.

Option 1

This option uses a name-based object name with a variable length for the name.

Pattern

Examples

First character of the given name + surname

cbrowning

First character of the given name + first character of middle name + surname

ckbrowning

First two character of given name + surname

chbrowning

First three characters of the given name + surname

chabrowning

First character of the given name + surname + up to three digits not padded with leading zeroes

cbrowning1

Option 2

This option uses a name-based object name convention with a fixed length.

Pattern

Examples

First character of the given name + up to seven characters of the surname

cbrownin

First character of given name + first character of the middle name + up to six characters of the surname

ckbrowni

First two characters of the given name + up to six characters of the surname

chbrowni

First three characters of the given name + up to five characters of the surname

chabrown

First character of the given name + up to four characters of the surname + three digits padded with leading zeroes

cbrow001

Option 3

This option uses an attribute value as the object name. This option is effective when the publishing application has login ID ownership or has a unique ID that can be used in the implementation. This option offloads the burden to generate a unique ID from the driver and relies on the application to deliver the unique login ID.

Pattern

Example Attribute

Example

Attribute

CN

cbrownin

chabrown

cbrow001

 

workforceID

615221

622534

7252263