Xworkflow Designers Guide
Xworkflow Designers Guide
Workflow Designer’s
Guide
This document provides advanced
information about using the Livelink
Workflow module to design complex
workflow maps.
It assumes familiarity with the basics of
workflow functionality.
1921920.1
Copyright 2003 by Open Text Corporation. The copyright to these materials and any accompanying software is
owned, without reservation, by Open Text. These materials and any accompanying software may not be copied in whole or
part without the express, written permission of Open Text.
Open Text Corporation is the owner of the following trademarks: BASIS®, BASIS Desktop®, BASIS Techlib, iRIMS,
Livelink®, Livelink Activators, Livelink Change Agents, Livelink Channels, Livelink Collaboration, Livelink Desktop,
Livelink Directory Services, Livelink Discussions, Livelink eLink, Livelink Enterprise Activator, Livelink Explorer, Livelink
Forms, Livelink Intranet, Livelink Library, Livelink LiveReports, Livelink MeetingZone, Livelink Notifications, Livelink
Offline, Livelink OnTime, LiveLink PDF Forms, Livelink Project Collaboration, Livelink Prospectors, Livelink Remote
Cache, Livelink SDK, Livelink Search, Livelink SmartAgent, Livelink Spider, Livelink Tasks, Livelink Workflow, Livelink
UNITE, OnTime®, Open Text, and WorkSmart®. Other trademarks and trade names in the documentation are owned by
other companies and are used for product and company identification and information only. All rights reserved. Open Text
is the owner of other registered and unregistered trademarks. The above trademark listing is not exhaustive.
Open Text Corporation provides certain warranties and limitations in connection with the software that this document
describes. For information about these warranties and limitations, refer to the license agreement entered into between the
licensee and Open Text Corporation.
Written by Marya Janoff.
Contacting Us
Corporate Headquarters
Open Text Corporation,
185 Columbia Street West,
Waterloo, Ontario
N2L 5Z5
Canada
(519) 888-7111
If you subscribe to our Customer Assistance Program or would like more information about the support program, visit
Open Text Customer Support at http://www.opentext.com/services/support.html.
If you have suggestions for this publication, send an e-mail message to [email protected] to contact the Open Text
Publications Group.
Visit our home page at http://www.opentext.com for more information about Open Text products and services.
ii
Typographical Conventions Used in This Guide
All information in the following table is case-sensitive unless otherwise noted.
Items Convention
File names, directory These items appear in regular (normal) typeface. Some elements in
names, folder names, italic indicate placeholders.
path names, window Examples:
names, dialog box names,
Web page names, URLs, • Run setup.exe to start the installation program.
and e-mail addresses • Open the Livelink_home/config/opentext.ini file in a text edi-
tor.
Note The placeholder Livelink_home represents
the Livelink root directory (directory where
Livelink was installed).
• Send an e-mail message to [email protected] to contact
Open Text Customer Support.
• In the Windows NT Control Panel, double-click the Services
icon to open the Services dialog box.
Names of user interface These items appear in bold typeface.
elements, such as Examples:
buttons, links, menus,
check boxes, radio • On the Tools menu, click Search.
buttons, lists, fields, and • In the Services dialog box, click Livelink Server:
so on service_name, and then click the Start button.
• Click the item’s Functions icon, choose Info, and then
choose General.
• Click the Admin Home link.
Variable placeholders, These items appear in italic typeface.
references to other Examples:
documents, new or
special terminology, and • For more information, see the Livelink First-Time Installation
emphasis Guide.
• You can scan new documents for content of interest by sav-
ing your search criteria in a query called a prospector.
• In your Web browser, go to the default Livelink start page at
protocol://host:port/URL_prefix/livelink.exe, where protocol
is http or https, host is the DNS name of the HTTP server
host, port is the port number on which the HTTP server is lis-
tening, and URL_prefix is the prefix mapped to the
Livelink_home/cgi directory in the HTTP server.
iii
Items Convention
References to chapters These items appear in “quotation marks.”
and sections of Examples:
documents, and citations
of messages displayed to • For more information, see Chapter Three, “Projects,” in the
users Livelink QuickStart for Users guide.
• For more information, see “Item Types” in Chapter Five,
“Livelink Items.”
• For more information, see “Item Types,” page 150.
• If the import completes successfully, Oracle displays the
message “Database import completed without errors.”
Operating system These items appear in a monospaced font.
commands, code Examples:
examples, feature names,
method names, object • In the User Name field, type Admin.
names, and text typed by • At the operating system prompt, type start-llserver,
users and then press ENTER.
• When searching for users, you can set the maximum number
of users displayed per page by setting the value (default is
30) of the MaxUsersToListPerPage parameter in the
[general] section of the opentext.ini file.
Key names Key names appear in ALL CAPS.
Examples:
• Press ENTER to start a new line when typing in this field.
• To select multiple items, hold down the CTRL key while you
click the items that you want to select.
iv
Table of Contents
Chapter 1
Introduction to Designing Workflow Maps ................................................................................. 1
Chapter 2
Defining a Business Process ........................................................................................................ 3
The Business Process................................................................................................................ 4
Designing a Flow Chart .......................................................................................................... 5
Mapping the Flow Chart to Livelink Workflow Steps ........................................................... 6
Chapter 3
Using the Expression Builders ...................................................................................................... 7
The Evaluate Step’s Expression Builder ................................................................................. 8
Defining a Simple Expression ........................................................................................... 8
Defining an Expression With Multiple Rows .................................................................... 9
Dynamically Assigning User Steps ....................................................................................... 12
Monitoring Workflow Status.................................................................................................. 15
Chapter 4
Using Complex Step Assignments ............................................................................................ 17
Assigning to Individual or Multiple Users or Groups ........................................................... 18
Dealing With Group Options ......................................................................................... 18
Workflow Roles....................................................................................................................... 20
Defining Workflow Roles................................................................................................. 20
Assigning Users to Roles at Initiation ............................................................................. 21
Chapter 5
Using the Process Step ............................................................................................................... 23
Copying an Attachment ..................................................................................................... 24
Resetting Attribute Values.................................................................................................... 25
Sending an E-mail ................................................................................................................. 26
Chapter 6
Working with Due Dates............................................................................................................. 27
How Livelink Calculates Due Dates .................................................................................... 28
Using Durations with No Recalculation ........................................................................ 28
Using Durations with Recalculation .............................................................................. 28
Recalculating After Loopbacks and Evaluate Steps ................................................. 29
Using Explicit Start Dates for Steps ................................................................................ 29
Using the Milestone Step................................................................................................ 30
Appendix A
Recommended Additional Reading ........................................................................................ 31
Index............................................................................................................................................ 33
v
vi
Chapter 1
Introduction to Designing Workflow Maps
As you have probably already discovered, it is easy to master the basics of the Livelink
Workflow module. However, there are many pitfalls you encounter when you begin
designing more complex and complicated workflows that take full advantage of the
module’s functionality.
This guide provides in-depth examination of particularly difficult aspects of Workflow. It
is not designed to introduce users to the basics, or to provide details of every activity you
can perform.
Since the scope of this guide is limited, the steps you see instruct you more generally than
in other Workflow help. For example, in the section that deals with the Expression Builder,
you are instructed to “Add a Text:Popup attribute named Color whose values are Blue
and Green,” rather than walked through every step in the add attribute procedure. If you
are unfamiliar with a particular procedure discussed in this guide, see the Livelink
Workflow QuickStart or the Workflow User Online Help for more detail.
The following topics appear in this guide:
• "Defining a Business Process," page 3, describes the necessary steps to complete before
painting your workflow map.
• "Using the Expression Builders," page 7, demonstrates how to use the workflow
painter’s expression builders to design evaluate steps, dynamically assign user steps,
and display desired workflow status.
• "Using Complex Step Assignments," page 17, clarifies the use of workflow roles and
how to use the group assignment capabilities.
• "Using the Process Step," page 23, describes the use of Process steps to copy
attachments, send e-mails, and reset attribute values.
• "Working with Due Dates," page 27, summarizes the way Livelink calculates due
dates and details how you can use due dates to monitor the course of a workflow.
Now, you can easily translate the steps into a flow chart.
When you map out your business process, you will notice that since Livelink does not
allow loopbacks to the Start step, you need to add an Initiator Revision step for the
Evaluate steps to loop back to. Your final map should look like this:
Delete Expression Click to delete an Expression field (at least one field
icon must remain)
Add New Row Click an expression type in the list to add to the current
drop-down list row in the Expression Builder
Delete Row icon Click to delete a row in the Expression Builder
The Evaluate step’s Expression field is populated with the expression you defined.
The illustration below shows the Expression Builder for this expression.
19. Click OR, Supervisor Approval, =, and Return for Review in the Row 9 drop-down
lists.
20. Click the Submit button.
The Evaluate step’s Expression field is populated with the expression you defined.
In some circumstances, however, you may simply want to assign a workflow step to
different users, depending on certain criteria.
For example, if you are designing a workflow map where a manager needs to approve a
document, but you know that Nina Johnson, the manager, is going on leave to get her
MBA on September 1, 2003, you could easily create the following statement in the
Expression Builder to assign the step to another user after that date:
“Date < 09/01/2003”
Once you define the expression, you select Nina to appear as the user in the If field, and
Daisy McCann, the employee taking Nina’s place, in the Else field.
The criteria available in the User step Expression Builder are the same as those in the
Evaluate step Expression Builder, discussed above. Therefore, you can easily define
complex statements for step assignment.
Moreover, the If and Else fields that contain the expressions can be expanded by clicking
the Add Expression icon to include an unlimited number of Else If statements, as
illustrated below.
Note If you want to reorder the statement, type a new 10-power integer in the
Order fields in the order you want them to appear, and then click the Add to
Workflow Definition button.
To define a user assignment statement:
1. Define a Date Field attribute called Date.
2. Double-click a User step, and click the Assignees tab.
3. Click the Expressions radio button.
4. Click the Edit Expression icon.
5. Click Attributes in the Add New Row drop-down list.
6. Click Date, <, September, 1, and 2003 in the row’s drop-down lists.
Note Click the Remove User icon to delete an assignee from the list.
5. Click the Add to Workflow Definition button.
If you want to assign a step to a previous assignee, you must first define a specific
assignee for any prior step.
To assign a step to the assignee of a previous step:
1. Double-click a User step.
2. Click the Assignees tab.
3. Click the name of the step whose assignee you want to execute this step in the
Assignee from Prior Step drop-down list.
4. Click the Add to Workflow Definition button.
• Member Accept (Maintain), which also requires only one member of the group to
perform the task. If a loopback occurs to make that step ready again, the same user
who worked on the step initially is assigned it again, without it appearing on the
Assignments page of all individuals in the group.
• One Level Expand, which requires each member of the group to perform the task. If
the group contains one or more sub-groups, only one member from each of the sub-
groups is required to perform the task. After a member of a sub-group accepts the
task, it is removed from the Assignments page of other members of the sub-group.
• Full Expand, which requires each member of the group and any of the sub-groups
within that group to perform the task. The workflow does not move on to the next
step until every member of the group and its sub-groups completes the task.
Workflow Roles
Workflow roles allow you to postpone assigning User steps to Livelink users until the
workflow is initiated. Using roles can improve the flexibility of your maps. For example,
instead of using the Expression Builder to dynamically assign a workflow step to the
manager of the person who initiated the workflow, you can simply define a Role called
Manager, which the user then assigns at initiation.
At initiation, Livelink requires that all Workflow Roles have assigned performers.
Otherwise, the user receives the following error message:
Could not start workflow. All of the roles have not been assigned
performers.
Implementing Workflow roles can allow you to reuse workflow maps across departments
and projects.
When you define user steps, you can substitute a workflow role for any explicit user or
group.
Copying an Attachment
Instead of requiring that a step assignee copy an approved document to a certain folder in
Livelink, you can use a process step to automatically send the step to the correct location,
as in the workflow illustrated below. If the manager approves the document, the
workflow automatically saves it to Livelink; if not, it routes back to the Initiator who
submitted the item (in this case, for revision).
Tip If you create a workflow that requires an attachment to be added at initiation,
instead of setting the process step to copy an individual attachment, create a
folder for it to copy instead.
When you set a Process step to copy specific named attachments, make sure to instruct
users not to rename the attachments during the workflow’s execution. If the attachments
are renamed, Livelink cannot recognize them.
Sending an E-mail
You can also use the Process step to send an e-mail message to a step recipient when a step
is activated. In this way, you can ensure that the assignee is aware that a workflow step
has been received.
Note The Livelink Administrator must enable Notification in the Livelink Server
before you can send e-mail message from a Process step. For more
information about how to enable Notification, contact your Livelink
Administrator or see Administering Livelink Notification in the Livelink
Admin Online Help.
To define a Process step to send an e-mail message:
1. Double-click a Process step.
2. Type a valid e-mail address or addresses in the To field.
Tip Use a comma to separate multiple addresses.
3. If desired, type a description of the e-mail message in the Subject field.
4. Type the text of the e-mail message in the Message field.
5. Click the Add to Workflow Definition button.
In the workflow map shown above, the durations of the steps are as follows, and none of
the Recalculate Due Dates check boxes are selected.
• The Manager Approval step has a duration of 3 days
• The Initiator step has a duration of 1 day
• The HR Approval step has a duration of 2 days
When the workflow begins executing, Livelink calculates the due date as 6 days from the
initiation date. Unless you modify the workflow, this workflow due date remains the
same, even if one of the users completes a step early or late.
days from the completion of the Manager Approval step (the total durations of the
subsequent steps). Note that the workflow as a whole is not late.
• If the assignee of the Manager Approval step completes the step in 1 day, the
workflow due date is set to 2 days earlier than the initial due date. Livelink adds the
durations of the subsequent steps to calculate the new due date.
completes the step prior to April 7, the first Initiator step will still not appear on the
Assignments page until its start date.
By using explicit start dates for steps in this way, you can ensure that any durations you
set for the workflow are fulfilled exactly.
31
32 Livelink Workflow Designer’s Guide
Index
A R
Additional Reading, Recommended 31 Recalculating After Loopbacks and Evaluate Steps
Assigning to Individual or Multiple Users or 29
Groups 18 Recalculating, after Evaluate steps 29
Recalculating, after loopbacks 29
C Recommended Additional Reading 31
Resetting Attribute Values 25
Copying an Attachment 24
S
D Sending an Email 26
Dealing With Group Options 18
Defining a Simple Expression 8 T
Defining an Expression With Multiple Rows 9
Designing a Business Process 3 The Business Process 4
Designing a Flow Chart 5 The Evaluate Step’s Expression Builder 8
Due Dates, how Livelink calculates 28
Due Dates, Using 27 U
Durations, with recalculation 28
Durations, without recalculation 28 Using Complex Step Assignments 17
Using Durations with no Recalculation 28
H Using Durations with Recalculation 28
Using Explicit Start Dates for Steps 29
How Livelink Calculates Due Dates 28 Using the Expression Builder to Dynamically As-
sign User Steps 12
I Using the Expression Builder to Monitor Work-
flow Status 15
Introduction to Designing Workflow Maps 1 Using the Expression Builders 7
Using the Milestone Step 30
Using the Process Step 23
M
Mapping the Flow Chart to Livelink Workflow W
Steps 6
Workflow Roles 20
Working with Due Dates 27
33
34 Livelink Workflow Designer’s Guide