Novell IDENTITY MANAGER 3.6.1 - WORKORDER DRIVER IMPLEMENTATION GUIDE... User manual

Novell®
www.novell.com
novdocx (en) 17 September 2009
AUTHORIZED DOCUMENTATION
Identity Manager 3.6.1 WorkOrder Driver Implementation Guide.
Identity Manager
3.6.1
December 18, 2009
WorkOrder Driver Implementation Guide

novdocx (en) 17 September 2009
Legal Notices
Novell, Inc. makes no representations or warranties with respect to the contents or use of this documentation, and
specifically disclaims any express or implied warranties of merchantability or fitness for any particular purpose.
Further, Novell, Inc. reserves the right to revise this publication and to make changes to its content, at any time,
without obligation to notify any person or entity of such revisions or changes.
Further, Novell, Inc. makes no representations or warranties with respect to any software, and specifically disclaims
any express or implied warranties of merchantability or fitness for any particular purpose. Further, Novell, Inc.
reserves the right to make changes to any and all parts of Novell software, at any time, without any obligation to
notify any person or entity of such changes.
Any products or technical information provided under this Agreement may be subject to U.S. export controls and the
trade laws of other countries. You agree to comply with all export control regulations and to obtain any required
licenses or classification to export, re-export or import deliverables. You agree not to export or re-export to entities on
the current U.S. export exclusion lists or to any embargoed or terrorist countries as specified in the U.S. export laws.
You agree to not use deliverables for prohibited nuclear, missile, or chemical biological weaponry end uses. See the
Novell International Trade Services Web page (http://www.novell.com/info/exports/) for more information on
exporting Novell software. Novell assumes no responsibility for your failure to obtain any necessary export
approvals.
Copyright © 2008-2009 Novell, Inc. All rights reserved. No part of this publication may be reproduced, photocopied,
stored on a retrieval system, or transmitted without the express written consent of the publisher.
Novell, Inc. has intellectual property rights relating to technology embodied in the product that is described in this
document. In particular, and without limitation, these intellectual property rights may include one or more of the U.S.
patents listed on the Novell Legal Patents Web page (http://www.novell.com/company/legal/patents/) and one or
more additional patents or pending patent applications in the U.S. and in other countries.
Novell, Inc.
404 Wyman Street, Suite 500
Waltham, MA 02451
U.S.A.
www.novell.com
Online Documentation: To access the latest online documentation for this and other Novell products, see
the Novell Documentation Web page (http://www.novell.com/documentation).

novdocx (en) 17 September 2009
Novell Trademarks
For Novell trademarks, see the Novell Trademark and Service Mark list (http://www.novell.com/company/legal/
trademarks/tmlist.html).
Third-Party Materials
All third-party trademarks are the property of their respective owners.

4Identity Manager 3.6.1 WorkOrder Driver Implementation Guide.
novdocx (en) 17 September 2009

Contents 5
Contents
novdocx (en) 17 September 2009
About This Guide 7
1Overview 9
1.1 The Work Order Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1.1 Subscriber Channel Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.1.2 Publisher Channel Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
1.2 Key Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.3 Support for Standard Driver Functions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
1.4 Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
2 Implementation Checklist 15
3 Installing Driver Files 17
4 Creating a New Driver 19
4.1 Creating the WorkOrder Container in the Identity Vault . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.2 Creating the Driver in Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.2.1 Importing the Driver Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
4.2.2 Configuring the Driver Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
4.2.3 Deploying the Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.2.4 Starting the Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
4.3 Creating the Driver in iManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.3.1 Importing the Driver Configuration File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
4.3.2 Configuring the Driver Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.3.3 Starting the Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24
4.4 Activating the Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25
5 Upgrading an Existing Driver 27
5.1 Supported Upgrade Paths . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5.2 What’s New in Version 3.6.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
5.3 Upgrade Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27
6 Customizing the Driver 29
6.1 Policies and Rules Used in the Basic Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6.1.1 Subscriber Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
6.1.2 Publisher Channel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
6.2 Human Resource Example Using an HR Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31
6.2.1 Human Resource Driver Policies. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
6.2.2 WorkOrder Driver Policy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.3 Human Resource Example without an HR Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
6.3.1 Filter Additions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.3.2 Subscriber Create Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.3.3 Subscriber Command Transform. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
6.3.4 Work Order E-Mail Notification of Work Order Completion . . . . . . . . . . . . . . . . . . . . 34

6Identity Manager 3.6.1 WorkOrder Driver Implementation Guide.
novdocx (en) 17 September 2009
7 Creating and Managing Work Orders 35
7.1 Using Drivers to Create Work Orders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
7.2 Using iManager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
7.2.1 Creating a New Work Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
7.2.2 Editing Work Order Properties. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
7.2.3 Filtering the Work Order List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
8 Managing the Driver 39
9 Troubleshooting Driver Processes 41
A Driver Properties 43
A.1 Driver Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
A.1.1 Driver Module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
A.1.2 Driver Object Password (iManager Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
A.1.3 Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44
A.1.4 Startup Option . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
A.1.5 Driver Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
A.1.6 ECMAScript (Designer Only) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
A.2 Global Configuration Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
B Objects and Attributes Used 49
B.1 New Objects Used by the Driver . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
B.1.1 DirXML-WorkOrder Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
B.1.2 DirXML-WorkToDo Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
B.2 DoItNow and SendToPublisher Flags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
B.2.1 DoItNow Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
B.2.2 SendToPublisherFlag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
C Schema and Policy Rules For Work Order Management 51
C.1 DirXML-WorkOrder Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
C.2 DirXML-WorkToDo Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
C.3 Publisher Placement Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
C.4 Subscriber Placement Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
C.5 Subscriber Create Rule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

About This Guide 7
novdocx (en) 17 September 2009
About This Guide
This guide explains how to install and configure the Novell®Identity Manager WorkOrder driver.
Chapter 1, “Overview,” on page 9
Chapter 2, “Implementation Checklist,” on page 15
Chapter 3, “Installing Driver Files,” on page 17
Chapter 4, “Creating a New Driver,” on page 19
Chapter 5, “Upgrading an Existing Driver,” on page 27
Chapter 6, “Customizing the Driver,” on page 29
Chapter 7, “Creating and Managing Work Orders,” on page 35
Chapter 8, “Managing the Driver,” on page 39
Chapter 9, “Troubleshooting Driver Processes,” on page 41
Appendix A, “Driver Properties,” on page 43
Appendix B, “Objects and Attributes Used,” on page 49
Appendix C, “Schema and Policy Rules For Work Order Management,” on page 51
Audience
This guide is intended for developers and administrators using Identity Manager and the WorkOrder
driver.
Feedback
We want to hear your comments and suggestions about this manual and the other documentation
included with this product. Please use the User Comments feature at the bottom of each page of the
online documentation, or go to www.novell.com/documentation/feedback.html and enter your
comments there.
Documentation Updates
For the most recent version of the Identity Manager WorkOrder Driver Implementation Guide, visit
the Identity Manager Documentation Web site (http://www.novell.com/documentation/
idm36drivers).
Additional Documentation
For documentation on other Identity Manager drivers, see the Identity Manager Documentation Web
site (http://www.novell.com/documentation/idm36drivers).
Documentation Conventions
In Novell documentation, a greater-than symbol (>) is used to separate actions within a step and
items in a cross-reference path.

8Identity Manager 3.6.1 WorkOrder Driver Implementation Guide.
novdocx (en) 17 September 2009
A trademark symbol (®, TM, etc.) denotes a Novell trademark. An asterisk (*) denotes a third-party
trademark.

Overview
1
9
novdocx (en) 17 September 2009
1
Overview
Typically, changes to data in the Identity Vault or a connected application are immediately
processed. Work orders enable you to schedule when tasks are to be performed.
For example, a new employee is hired but is not scheduled to start for a month. The employee needs
to be added to the HR database but should not be granted access to any corporate resources (e-mail,
servers, and so forth) until the start date. In a typical scenario, the user would be granted access as
soon as he or she is added to the HR database. With work orders implemented, a work order is
created that delays account provisioning to the user’s start date.
The WorkOrder driver provides work order functionality. The following sections introduce the
WorkOrder driver and the key concepts and terminology associated with the driver:
Section 1.1, “The Work Order Process,” on page 9
Section 1.2, “Key Features,” on page 14
Section 1.3, “Support for Standard Driver Functions,” on page 14
Section 1.4, “Terminology,” on page 14
1.1 The Work Order Process
From a high-level perspective, work orders are processed as follows:
1. A work order is created, either through an automated process (another driver) or a manual
process (iManager), and is added as a WorkOrder object in a the Identity Vault’s work order
container.
2. At the scheduled time (as defined in the WorkOrder object), the driver begins processing the
work order.
3. The driver applies any policies to the work order (performing any actions associated with the
policies) and creates a WorkToDo object in the Identity Vault’s work order container.
4. Depending on how you configure the WorkOrder driver and the other drivers in your system,
either the WorkOrder driver performs the desired work or other drivers use the information in
the the WorkToDo object to perform the work. Because the WorkOrder driver is designed to
accomodate a variety of configuration scenarios, sample scenarios are provided in Chapter 6,
“Customizing the Driver,” on page 29.
The following sections provide detailed information about the work performed by the driver’s
Subscriber and Publisher channels. Because the WorkOrder driver channels function differently than
with other drivers, you should carefully review the information.
Section 1.1.1, “Subscriber Channel Functions,” on page 9
Section 1.1.2, “Publisher Channel Functions,” on page 11
1.1.1 Subscriber Channel Functions
This section provides a basic understanding of the functions the Subscriber channel performs in the
WorkOrder driver.

10 Identity Manager 3.6.1 WorkOrder Driver Implementation Guide.
novdocx (en) 17 September 2009
First, Placement and Create rules are configured so all new work orders that contain the required
attributes are sent to the Subscriber channel. The following attributes must be present for a work
order to pass the Create rule and go to the Subscriber channel:
DirXML-nwoContent
DirXML-nwoStatus
DirXML-DoItNow Flag
DirXML-SendToPublisher Flag
Figure 3-1 shows what happens when the Subscriber channel receives a work order.
Figure 1-1 Subscriber Channel Configuration
The Subscriber channel performs the following actions:
1. Creates an association for each WorkOrder object it receives.
2. Checks if the DoItNow and SendToPublisher flags are set to True. If these attributes are set to
True, the Subscriber channel builds a work order and sends it immediately to the Publisher
channel.
3. If the DoItNow and SendToPublisher flags are not set to True, the Subscriber channel waits
until the next event.
No
Is it an Add
work order?
Subscriber gets the
WorkOrder XML
from the engine.
Write the
association
to the engine.
Returns to
the engine.
Write the Work
Order object to
the Publisher.
Yes
Yes
No
Is the
SendToPublisher
or the DoItNow
flag set?

Overview 11
novdocx (en) 17 September 2009
1.1.2 Publisher Channel Functions
This section reviews the functions of the Publisher channel.
“The Publisher Channel Wakes Up” on page 11
“How the Publisher Channel Processes Work Orders” on page 12
“How the Publisher Channel Deletes Work Orders” on page 13
The Publisher Channel Wakes Up
The following flowchart illustrates the Publisher channel’s action when it wakes up.
Figure 1-2 Publisher Channel Configuration
1. The Publisher channel wakes because the Subscriber channel sends a WorkOrder object. If the
SendToPublisher flag is set to True, the work order is written out to the work order container. If
the DoItNow flag is set to True, the work order is processed immediately.
Wakes because
the poll loop has
expired.
Wakes because
of Heartbeat.
Wakes because the
WorkOrder object
is sent by the
Subscriber.
Query the Work
Order container
for all work orders
pending and due.
Process all work
orders.
Write the Work
Order object to
the WorkOrder
container.
Delete work orders
with expired
delete due date.
Go back
to sleep.
Report the status
of the driver.
Publisher
No
Is the
SendToPublisher
flag True?
Yes
No
Process all work
orders.
Is the
DoItNow
flag True?
Yes

12 Identity Manager 3.6.1 WorkOrder Driver Implementation Guide.
novdocx (en) 17 September 2009
2. The Publisher channel wakes when the polling time has expired and queries the work order
container for work orders that are pending and due. The driver processes these work orders.
Work orders with delete due dates are deleted.
a. The Publisher channel queries the work order container for work orders that are pending
and due. See “How the Publisher Channel Processes Work Orders” on page 12.
b. The Publisher channel queries all work orders for expired DeleteDueDates. See “How the
Publisher Channel Deletes Work Orders” on page 13.
3. If the driver heartbeat is configured, the driver wakes to report the driver status.
How the Publisher Channel Processes Work Orders
After the Publisher channel queries the Identity Vault for work orders, it configures the work orders
in the driver. The following flowchart illustrates how the Publisher channel processes work orders.
Figure 1-3 How the Publisher Processes Work Orders
1. Before a work order is processed, the driver checks the DependentWorkOrder attribute to see if
the work order is dependent on another work order. If there is a dependent work order, the
Publisher channel queries Identity Manager to see the status of the dependent work order. If the

Overview 13
novdocx (en) 17 September 2009
dependent work order status is configured, the Publisher channel processes the work order. If
not, the work order waits until the next polling loop to see if the dependent work order has been
configured.
2. The Publisher channel performs the work orders that are due, completing the appropriate action
based on the attributes of the DirXML-WorkOrder objects.
3. To process the work order, the driver writes a DirXML-WorkToDo object to the WorkToDo
container. The DirXML-nwoContent attribute of the WorkToDo object contains the value of
the DirXML-nwoContent attribute of the WorkOrder object. The default configuration does not
do anything else with the WorkToDo object. A policy could use the WorkToDo object to
process the work order. For example, the content attribute might contain the DN of a user
object whose LogOnDisabled flag should be changed from True to False at the due date.
4. The Publisher channel updates the DirXML-WorkOrder with the results. If the WorkToDo
object was processed without an error, the status of the work order is changed to Configured. If
an error occurred, then the status is changed to Error. The work order process log is updated to
contain the results.
5. If the WorkOrder object has a repeat interval value, the value is added to the Due Date and the
work order status remains Pending. This allows for the work order to be repeated as many
times as specified in the repeat interval count value, or indefinitely if no repeat interval count
value is specified. The process log contains the results.
How the Publisher Channel Deletes Work Orders
The Publisher channel now queries the work order container for work orders with an expired
DeleteDueDate attribute. If the status of the work order is Pending or configured, and the
DeleteDueDate has expired, the work order is deleted. The work order is also deleted if it has an
error status and the DeleteOnError attribute is set to True. The following flowchart illustrates this
process.
Figure 1-4 The DeleteDueDate Process
No
Is the
work order
status Pending or
Configured
?
Is the
work order
status error and
DeleteOnError
True?
Query for work
orders with
DeleteDueDate
expired.
Delete the
work order.
Go to the next
work order.
Yes
Yes

14 Identity Manager 3.6.1 WorkOrder Driver Implementation Guide.
novdocx (en) 17 September 2009
1.2 Key Features
The following list describes key features of the WorkOrder driver:
Schedules work orders: The WorkOrder driver allows work to be scheduled for a specific
date and time.
Supports dependent work orders: If a work order is dependent on another work order, it is
not processed until the dependent work order has been successfully processed.
Repeats work orders: The driver allows for work orders to be repeated at a set interval.
Facilitates tracking and accountability for work orders: Each work order carries with it the
creator and main contact of the work order, a description of the action taken, and the errors it
encountered.
1.3 Support for Standard Driver Functions
There are several functions that most Identity Manager drivers support. The following list explains
whether or not the WorkOrder driver supports these standard functions.
Local Platforms: The WorkOrder driver can run on the same platforms as the Metadirectory
engine. See “Metadirectory Server” in “System Requirements” in the Identity Manager 3.6.1
Installation Guide.
Remote Platforms: The WorkOrder driver works on all the platforms supported by the
Remote Loader. See “Remote Loader” in “System Requirements” in the Identity Manager 3.6.1
Installation Guide.
Role-Based Entitlements: The WorkOrder driver does not support Role-Based Entitlements.
Password Synchronization Support: The WorkOrder driver does not support Password
Synchronization.
Synchronized Objects: The WorkOrder driver only processes events that pertain to work
orders. It does not synchronize other objects and attributes within the Identity Vault.
1.4 Terminology
The following terms are used by the WorkOrder driver:
Due Date: The date and time the work order is to be executed.
Content: The definition of the work that is to be processed.
Interval: The amount of time until the work order is to be repeated.
Dependency: The distinguished name of any other work orders that must be completed before
the current work order.
Status: The value returned by the driver after the work order was processed (Configured, Error,
etc.).
Process Log: The description of the events that occurred when the work order was processed.
Delete Due Date: The date the work order will be deleted from the Identity Vault.
Pending: A work order that is not yet due.

Implementation Checklist
2
15
novdocx (en) 17 September 2009
2
Implementation Checklist
Use the following checklist to ensure that you complete all of the tasks required to set up and use the
WorkOrder driver.
Table 2-1 WorkOrder Implementation Checklist
Task Details
Install the WorkOrder
driver files
By default, the WorkOrder driver files (driver shim and configuration file)
are copied to the Metadirectory server when the Metadirectory engine is
installed. If the driver is not on the Metadirectory server (because a custom
installation was performed, or you want to run the driver on a server other
than the Metadirectory server), see Chapter 3, “Installing Driver Files,” on
page 17.
Create a new
WorkOrder driver
or
Upgrade an existing
WorkOrder driver to
the new version
You need to import the basic configuration file to create the driver. For
instructions, see Chapter 4, “Creating a New Driver,” on page 19.
If you have an existing driver, you can upgrade its configuration to this
version. For instructions, see Chapter 5, “Upgrading an Existing Driver,” on
page 27.
Customize the driver The basic configuration for the WorkOrder driver enables it to create
WorkOrder objects and WorkToDo objects. This is the extent of what the
WorkOrder driver does when using the base configuration. For any
additional work to be done, you must customize the WorkOrder driver or
other Identity Manager drivers to perform the desired work.
For instructions, see Chapter 6, “Customizing the Driver,” on page 29.
Create work orders Most work orders are likely created by other drivers as part of the work
order process you establish while customizing the driver (see the previous
task). However, you can also create work orders manually as well as
modify existing work orders.
For instructions, see Chapter 7, “Creating and Managing Work Orders,” on
page 35.

16 Identity Manager 3.6.1 WorkOrder Driver Implementation Guide.
novdocx (en) 17 September 2009

Installing Driver Files
3
17
novdocx (en) 17 September 2009
3
Installing Driver Files
By default, the WorkOrder driver files are installed on the Metadirectory server at the same time as
the Metadirectory engine. The installation program extends the Identity Vault’s schema and installs
both the driver shim and the driver configuration files. It does not create the driver in the Identity
Vault (see Chapter 4, “Creating a New Driver,” on page 19) or upgrade an existing driver’s
configuration (see Chapter 5, “Upgrading an Existing Driver,” on page 27).
If you performed a custom installation and did not not install the WorkOrder driver on the
Metadirectory server, you have two options:
Install the files on the Metadirectory server, using the instructions in “Installing the
Metadirectory Server” in the Identity Manager 3.6.1 Installation Guide.
Install the Remote Loader (required to run the driver on a non-Metadirectory server) and the
driver files on a non-Metadirectory server where you want to run the driver. See “Installing the
Remote Loader” in the Identity Manager 3.6.1 Installation Guide.

18 Identity Manager 3.6.1 WorkOrder Driver Implementation Guide.
novdocx (en) 17 September 2009

Creating a New Driver
4
19
novdocx (en) 17 September 2009
4
Creating a New Driver
After the WorkOrder driver files are installed on the server where you want to run the driver (see
Chapter 3, “Installing Driver Files,” on page 17), you can create the driver in the Identity Vault. You
do so by importing the basic driver configuration file and then modifying the driver configuration to
suit your environment. The following sections provide instructions:
Section 4.1, “Creating the WorkOrder Container in the Identity Vault,” on page 19
Section 4.2, “Creating the Driver in Designer,” on page 19
Section 4.3, “Creating the Driver in iManager,” on page 22
Section 4.4, “Activating the Driver,” on page 25
4.1 Creating the WorkOrder Container in the
Identity Vault
The WorkOrder driver requires you to specify an Identity Vault container for WorkOrder objects and
WorkToDo objects. You can use an existing container for these objects, but we strongly recommend
that you create a new container. You can give the container any name you want (for example,
WorkOrders). You should restrict rights to the container so that only authorized administrators can
change the container or the objects it holds.
4.2 Creating the Driver in Designer
You create the WorkOrder driver by importing the driver’s basic configuration file and then
modifying the configuration to suit your environment. After you’ve created and configured the
driver, you need to deploy it to the Identity Vault and start it.
Section 4.2.1, “Importing the Driver Configuration File,” on page 19
Section 4.2.2, “Configuring the Driver Settings,” on page 20
Section 4.2.3, “Deploying the Driver,” on page 21
Section 4.2.4, “Starting the Driver,” on page 21
4.2.1 Importing the Driver Configuration File
1In Designer, open your project.
2In the Modeler, right-click the driver set where you want to create the driver, then select New >
Driver to display the Driver Configuration Wizard.
3In the Driver Configuration list, select WorkOrder, then click Run.
4On the Import Information Requested page, fill in the following fields:
Driver Name: Specify a name that is unique within the driver set.
WorkOrder Container: Browse for and select the container you’ve created for WorkOrder
objects (see Section 4.1, “Creating the WorkOrder Container in the Identity Vault,” on
page 19).

20 Identity Manager 3.6.1 WorkOrder Driver Implementation Guide.
novdocx (en) 17 September 2009
Driver is Local/Remote: Select Local if this driver will run on the Metadirectory server
without using the Remote Loader service. Select Remote if you want the driver to use the
Remote Loader service, either locally on the Metadirectory server or remotely on another
server.
5(Conditional) If you chose to run the driver remotely, click Next, then fill in the fields listed
below. Otherwise, skip to Step 6.
Remote Host Name and Port: Specify the host name 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
6Click Next to import the driver configuration.
At this point, the driver is created from the basic configuration 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.
7To review or modify the default configuration settings, click Configure, then continue with the
next section, Configuring the Driver Settings.
or
To skip the configuration settings at this time, click Close. When you are ready to configure the
settings, continue with the next section, Configuring the Driver Settings.
4.2.2 Configuring the Driver Settings
After importing the driver configuration file, the WorkOrder driver will run. However, the basic
configuration might not meet the requirements for your environment. For example, you might need
to change whether the driver checks for new work orders in the WorkOrder container at a specific
interval throughout the day or only at a specific time each day. The default setting is to poll the
WorkOrder container every minute.
In addition to the polling setting, there are addtional 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).
The driver configuration settings are explained in Appendix A, “Driver Properties,” on page 43.
If you do not have the Driver Properties page displayed in Designer:
1Open your project.
2In the Modeler, right-click the driver icon or the driver line, then select Properties.
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. These settings let you
control the method the driver uses to check for new work orders.