Ffworkflow Designer's Guide1
Ffworkflow Designer's Guide1
Workflow Designer’s
Guide
This document provides advanced
information about using the Livelink ECM -
Workflow module to design complex
Workflow Maps.
It assumes familiarity with the basics of
Workflow functionality.
1921970.1
Copyright 2006 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 trademarks Open Text, ‘Great Minds Working Together’, Livelink, and
MeetingZone among others. This list is not exhaustive. All other products or company names are used for identification
purposes only, and are trademarks of their respective owners. All rights reserved.
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 Paul Mercurio.
Contacting Us
Corporate Headquarters
Open Text Corporation
275 Frank Tompa Drive,
Waterloo, Ontario
N2L 0A1
Canada
(519) 888-7111
If you subscribe to our Software Maintenance Program or would like more information about additional support
programs, 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 Properties, 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
Creating a Workflow Status........................................................................................... 16
Chapter 4
Using Complex Step Assignments ............................................................................................ 19
Assigning to Individual or Multiple Users or Groups ........................................................... 20
Dealing With Group Options ......................................................................................... 20
Workflow Roles....................................................................................................................... 22
Defining Workflow Roles................................................................................................. 22
Assigning Users to Roles at Initiation ............................................................................. 23
Chapter 5
Working With Loopback Links ................................................................................................... 25
Overview ................................................................................................................................ 26
Conditional Loopback Links.......................................................................................... 26
Creating Valid Loopback Links ........................................................................................... 27
Retrieving Attribute Data for Steps in a Loopback Link.................................................... 30
Working with Step Iteration Data in Sub-Workflow Steps ........................................... 30
Chapter 6
Using Send On Processing......................................................................................................... 31
v
Overview ................................................................................................................................ 32
Send On Processing Example .............................................................................................. 33
Chapter 7
Using the Process Step ............................................................................................................... 35
When to Use the Process Step or the Item Handler Step ................................................. 36
Copying an Attachment ..................................................................................................... 37
Resetting Attribute Values.................................................................................................... 38
Sending an E-mail ................................................................................................................. 39
Chapter 8
Using the Item Handler Step...................................................................................................... 41
Overview ................................................................................................................................ 42
Enabling Item Handler Step Logging ........................................................................... 42
Configuring the General Tab............................................................................................... 43
Workflow Agent Step Processing .................................................................................. 43
Assigning Item Handler Steps to the Workflow Agent During Workflow Development
43
Reviewing Step Processing .................................................................................................. 44
Creating Folders .................................................................................................................... 45
Tutorial.............................................................................................................................. 45
Performing Category Functions .......................................................................................... 48
Tutorial.............................................................................................................................. 48
Creating Versions .................................................................................................................. 58
Tutorial.............................................................................................................................. 58
Moving and Copying Livelink Items .................................................................................... 63
Creating the Workflow Map and Configuring the General Tab .............................. 63
Moving and Copying a Workflow Attachment Tutorial............................................. 63
Synchronizing Container Contents Tutorial ................................................................. 65
Copying an Item to a Folder Created by a Folder Definition ......................................... 70
Creating the Workflow Map and Configuring the General Tab .............................. 70
Copying a Document to a Folder Created by a Folder Definition .......................... 70
Using Multiple Item Handler Steps in a Workflow............................................................... 72
Tutorial.............................................................................................................................. 72
Testing the Tutorial Workflow ......................................................................................... 83
Chapter 9
Integrating Email in Workflows .................................................................................................. 87
Overview ................................................................................................................................ 88
About Email-Enabled Workflow Features .................................................................... 88
Configuring and Testing Livelink ................................................................................... 90
Monitoring Workflow Events .......................................................................................... 91
vi
About Livelink Workflow Documentation .................................................................... 92
Designing Email-Enabled Workflow Maps.......................................................................... 94
Choosing When to Email Enable a Workflow Map..................................................... 94
Avoiding Unsupported Start Step Features ................................................................. 95
Choosing Descriptive Email Addresses ........................................................................ 96
Designing Email-Enabled Steps ........................................................................................... 98
Choosing Which Steps To Email Enable ....................................................................... 98
Avoiding Step Features Not Supported Through Email............................................ 100
Avoiding Loopback Links............................................................................................. 102
Chapter 10
Working with Due Dates........................................................................................................... 103
How Livelink Calculates Due Dates .................................................................................. 104
Using Durations with No Recalculation ...................................................................... 104
Using Durations with Recalculation ............................................................................ 104
Recalculating After Loopbacks and Evaluate Steps ............................................... 105
Using Explicit Start Dates for Steps .............................................................................. 106
Using the Milestone Step.............................................................................................. 106
Appendix A
Recommended Additional Reading ...................................................................................... 107
Index.......................................................................................................................................... 109
vii
viii
Chapter 1
Introduction to Designing Workflow Maps
This guide provides in-depth examination of particularly complex aspects of Livelink
Workflow Maps. 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 Livelink 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,” without walking through every step in the add attribute procedure. If
you are unfamiliar with a particular procedure discussed in this guide, see the Livelink -
ECM Workflow QuickStart Guide or the Livelink ECM - Workflow User Online Help for more
detail.
The following topics are covered 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 Workflow
Painter user steps, and display desired Workflow status.
• "Using Complex Step Assignments," page 19, clarifies the use of Workflow roles and
how to use the group assignment capabilities.
• "Working With Loopback Links," page 25, clarifies the use of loopback links used to
join steps.
• "Using Send On Processing," page 31, explains how the Send On Processing feature
allows users to more efficiently send on steps in complex Workflows.
• "Using the Process Step," page 35, describes the use of Process steps to copy
attachments, send e-mails, and reset attribute values.
• "Using the Item Handler Step," page 41, describes the use of Item Handler steps to
create Folders, perform Category and attribute operations, create versions of Livelink
Documents or Compound Documents, move or copy Workflow attachments and
Livelink items, and perform other operations.
• "Integrating Email in Workflows," page 87, describes how to make Workflow steps
and initiation request available to users through email message.
• "Working with Due Dates," page 103, 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 drop- Click an expression type in the list to add to the current
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.
Note If the Forms module is not installed on your Livelink system, you cannot use
the Livelink Forms object type with the Livelink Workflow module.
• Parentheses, which allow you to create complex expressions
• Dispositions, which check for the status of a disposition required on a User or Initiator
step’s Permissions tab
The illustration below shows the Expression Builder for this expression.
14. Click Workflow Form : Manager Approval, =, and True in the Row 6 drop-down lists.
15. Click General in the Add New Row drop-down list.
16. Click AND NOT, Status, =, and Workflow Late in the Row 7 drop-down lists.
17. Click Paren Right ) in the Add New Row drop-down list.
18. Click Dispositions in the Add New Row drop-down list.
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 integer (the value is rounded
to a multiple of 10) 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.
7. Click the Submit button.
8. For each assignee, click the Choose User or Group icon , find the user you want to
receive the step, and click his or her Select link.
Note When dynamically assigning User steps, you can also set the Initiator or any
Workflow role, if defined, to receive assignments.
9. Click the Add to Workflow Definition button.
Tip 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.
Note One Level Expand and Full Expand group options require all group members
to perform the steps. This may be inefficient if you have an Evaluate step that
follows. For example, if the Workflow follows a False path because one of the
group members has not approved a Document in the group expand step, all
members will still have to work on the step even if one member has already
not approved the Document.
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 Workflow 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.
Overview
A loopback link connects a step to a previous step within the Workflow, letting you repeat
one or more previous steps. Loopback links are represented by blue lines in the Workflow
Painter.
The criteria defined for the Evaluate step determine which path the Workflow follows.
For example, the following Workflow Map includes an invalid loopback link because the
Evaluate step is not part of the loopback:
If you attempt to save a Workflow Map that contains an invalid loopback link, the
Workflow Painter displays the following message:
In this example, the error is caused by the link from the User 2 step, which is outside the
loopback link, to the User 3 step, which is part of a loopback link.
The Workflow Map must be redesigned to remove the link from the step outside the
loopback link to make it valid. For example, the following Workflow Map shows one way
to reconfigure the steps to make a valid loopback link..
Depending on the functionality you want to add to your Workflows, you may have more
than one alternative when you redesign the steps. The following is another valid
reconfiguration of the example:
Overview
If you are designing a complex Workflow with a combination of interactive steps (User,
Initiator, or Forms Task steps) and non-interactive steps (Evaluation, Process, Sub-
workflow, or Milestone steps), you should attempt to design your Map for optimal
performance.
If your Workflow contains a non-interactive step that requires additional processing and
that step follows an interactive step, you can maximize Workflow performance by using
the Send On Processing feature. The Send On Processing feature allows the interactive
step to be processed transparently (in the background). When a user clicks the interactive
step’s Send On button, the system immediately returns control to the user, and then sets
the step status to ready for the Workflow Agent. The Workflow Agent is a Livelink
Workflow feature that sends on the interactive step and then processes subsequent non-
interactive Workflow steps until it reaches the next interactive step.
The Send On Processing feature is available by selecting the Allow the Workflow Agent
to perform 'Send On' Processing check box on the General tab of the User, Initiator, or
Forms Task step.
For more information about the Workflow Agent, see “Workflow Agent Step Processing,”
page 43.
Note By default, the Workflow Agent is configured to gather and perform
background tasks every 10 minutes, but the Livelink Administrator can
schedule when it should run.
control of the system after sending on the step, rather than waiting for the system to send
the step on to the 12 User steps that follow.
For more information about how to use the Item Handler step, see “"Using the Item
Handler Step," page 41.
Note The Livelink Administrator can control access to the Item Handler step and
its functions. For more information about the functions available in the Item
Handler step in your Livelink Server, see your Livelink Administrator.
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 document 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. Also, copying can only take place if the user
assigned to the step prior to the Process step has permissions to copy the attachments to
the destination Folder.
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 an 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 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.
Overview
The Item Handler step allows you to configure simple or complex Document operations
and other functions to be automatically performed when a Workflow reaches the step. The
operations that you can configure an Item Handler step to perform include:
• Create Folders in a Livelink container item or in the Workflow attachments volume
• Add, modify, or delete Categories and attribute values on Livelink items or update
the current value of Workflow attributes
• Perform Document and Compound Document versioning operations
• Move or copy Workflow attachments or Livelink items
For more information about the Item Handler step, see the Livelink User Online Help. For
more information about administering the Item Handler step, see the Livelink Admin
Online Help.
Note The sections that follow explain how to perform basic Item Handler step
operations by presenting a series of simple tutorials that walk you through
each set of step features. Open Text strongly recommends that you practice
using the Item Handler step in a non-production environment with sample
data before you attempt to use the step in a production environment.
Creating Folders
The Item Handler step allows you to specify Folder hierarchies to be created in a Livelink
container or the Workflow attachments Folder on the Folder Definitions tab. A Folder
definition specifies a Folder hierarchy to be created when the Item Handler step is
processed.
Note You can specify multiple Folder definitions, but the Item Handler step may
not process the Folder definitions in the order that they appear on the Folder
Definitions tab.
The following procedure demonstrates how to create a Folder hierarchy in the My
Workspace using the Item Handler step.
Tutorial
To create a Folder hierarchy:
1. Create a new Workflow Map, and then add an Item Handler step .
2. Drag the Start Step over the Item Handler step to link the steps.
3. Double-click the Item Handler step.
4. On the General tab, do the following:
• Name the step Create Folders.
• Assign the step to yourself.
• Select the Execute using Workflow Agent check box.
The Workflow waits to be processed by the Workflow Agent. You can check the
Workflow status by viewing it on the Workflow Status page. After the Workflow
Agent processes the step, the Workflow is complete.
3. Navigate to the My Workspace.
The My Workspace should contain the Folder named My Folder, created by the
Item Handler step.
4. Click the My Folder link.
The Folder should contain a Folder named My Subfolder.
You can test the Folder collision renaming feature by initiating the Workflow again. After
the Workflow processing is complete, the My Folder Folder should contain a second
Folder named My Subfolder 2.
Tutorial
The following tutorial explains how to create the Report Evaluator, a Workflow that
updates the Workflow attributes with Category and attribute data associated with a report
(a Livelink Document that is an expense report or a sales trip report) that the Initiator
attaches to the Workflow. The Workflow routes the sales report to a Sales Manager or the
expense report to an Accounting Manager by gathering and evaluating the report’s
Category and attribute data.
Before you can create and execute the Workflow, you must prepare some sample data to
be used in the tutorial. The tutorial includes the following sections:
• “Creating Livelink Categories and Attributes”, page 49
• “Creating Sample Users”, page 49
• “Creating a Sample Report”, page 49
• “Creating the Report Evaluator Workflow and Start Step”, page 49
• “Creating the Item Handler Step”, page 51
• “Configuring Attribute Mappings”, page 51
• “Configuring Operations”, page 52
• “Completing the Workflow Design”, page 53
• “Initiating the Report Evaluator Workflow”, page 56
• “Evaluating the Report Evaluator Workflow”, page 57
The Livelink Administrator controls which users can create Livelink Categories and
attributes. For more information about creating Categories, see “Administering the
Categories Volume” in the Livelink Admin Online Help.
The Item Reference attribute allows users to browse Livelink and select an item.
When you create the My Report attribute, specify Documents and Compound
Documents as the valid selectable types. In this tutorial, the user who initiates the
Workflow will select the Livelink Document that is the report to be evaluated and
routed.
For more information about creating Workflow attributes, see the Livelink User
Online Help.
A mapping now exists between the Title and Report Name attributes.
13. On the Definitions sub-tab, click the Add Mapping link for the Type attribute.
14. On the Select Mapping Data Type page, click the Select link for Workflow Attribute.
Livelink displays the Classification attribute, the only Workflow attribute that is of
the same attribute type as the Type attribute.
15. Click the Select link for the Classification attribute.
16. Click the Add Attributes link for Author Properties.
17. Select the check box for the Author attribute.
18. Click the Submit button.
19. On the Definitions sub-tab, click the Add Mapping link for the Author attribute.
20. On the Select Mapping Data Type page, click the Select link for Workflow Attribute.
21. Click the Select link for the Report Submitted by attribute.
A mapping now exists between the Author and the Report Submitted by attributes.
Configuring Operations
Operations define what kind of data transfer is made based on the attribute mappings.
To configure operations:
1. Click the Operations link.
2. On the Operations tab, click the Add Operation button .
3. In the Item field, click the Item Reference Attribute radio button.
4. In the Item Reference Attribute list, click the My Report attribute.
This attribute allows the user to specify the Livelink Document to be evaluated by
the Workflow.
5. In the Update Options field, verify that the Workflow Attribute Values radio button
is selected.
This setting indicates that the mapped Workflow attribute values will be updated
with the values of the Category attribute values on the Livelink Document.
6. Click the Add button.
The step is now configured and ready to be tested.
7. Click the Save link.
8. Click the Painter link.
3. Drag the Category_Functions step over the Evaluate step to create a link between the
steps.
4. Drag the Evaluate step over each User step and the Initiator step to create links
between the steps and the Evaluate step.
5. Drag the Initiator step over the Category_Functions step to create a link between the
Initiator step and the Category_Functions step.
Creating Versions
The Item Handler step automatically creates a Version of the Documents or Compound
Documents you specify on the Versioning tab. If the Document to which you want to add
a Version uses advanced versioning, you can specify that the step should create a major
Version. In addition, you can configure the step to create Generations, Revisions, or
Releases of the Documents or Compound Documents. You can create Versions and
perform other operations on Workflow attachments and specific Livelink items.
Tutorial
The following tutorial explains how to create a Workflow that creates a Version of
Workflow attachments and a Livelink item. Also, it demonstrates how to perform
additional Document and Compound Document operations.
Before you can create and execute the Workflow, you must prepare some sample data to
be used in the tutorial.
For more information about adding attachments, see the Livelink User Online Help.
7. Click the Save link.
8. Click the Painter link.
9. On the Workflow Painter, add a User step to the Workflow.
The step will allow the Initiator to add a modified version of one of the Workflow
attachments and specify a Compound Document to be versioned.
10. Drag the Start step over the User step to create a link between the steps.
11. Double-click the User step.
12. On the General tab, do the following:
• Name the step Modify and Specify.
• Assign the step to the Initiator.
• Click the Add to Workflow Definition button.
13. Click the Save link.
14. Click the Painter link.
2. Drag the Modify and Specify step over the Item Handler step to create a link between
the steps.
Specifying this attribute as the source allows the Initiator to choose in the Modify
and Specify step a Compound Document that will have a versioning operation
performed on it.
12. In the Target field, click the Item Reference Attribute radio button, and then choose
the My Compound Document attribute you created earlier.
Specifying the attribute as the target means that the step operations will be
performed on the source item in its current location.
13. In the Compound Documents field, do the following:
• Click Make Release in the list, and then type My Release in the Override
Default Release/Revision Name field.
These settings indicate that you want to create a Release of the Compound
Document, and that the Release will be named My Release.
• Select the Make Generation check box, and then type My Generation in the
Override Default Generation Name field.
These settings indicate that you also want to create a Generation of the
Compound Document, that the Generation will be named My Generation, and
that it will be created in the container referenced by the My Compound Document
attribute.
14. Click the Add button.
15. Click the Save link.
The two Livelink Documents you created and added as Workflow attachments are
displayed.
10. In the editing program used to create one of the Documents, modify the Document by
adding some text, and then save the file.
You will update the Workflow attachment by adding the modified document as a
new Version of the Livelink Document.
11. Click the Document’s Functions icon, and then choose Add Version.
12. Click the Send On button.
The Workflow is sent to the Version Functions step, which waits to be processed by
the Workflow Agent. To verify that the Workflow completes processing, check the
Workflow status by choosing Workflows on the Personal menu.
2. Configure the General tab as described in “Creating the Workflow Map and
Configuring the General Tab”, page 63.
3. Click the Move/Copy tab.
4. Click the Add Move/Copy Definition icon .
5. In the Source field, click the Workflow Attachment radio button, click the Browse
Attachments button, and then click the Select link for the Workflow attachment you
want to copy.
6. Select the Rename source to check box, and then type the following name for the new
copy of the attachment in the field:
attachment Copy, where attachment is the name of the attachment you want to move
or copy.
7. In the Target field, click the Livelink Container radio button, click the Browse
Livelink button, and then click the Select link for the Folder or container item in the
My Workspace where you want to copy the attachment.
6. In the Target field, click the Livelink Container radio button, click the Browse
Livelink button, and then click the Select link for the Folder or container item that
you want to synchronize with the source Folder.
Folder B contains:
• Sample PDF Document
• Sample Project
Although each Folder contains the Sample PDF Document, the file size is different
(168 KB in Folder A and 252 KB in Folder B), indicating that they are different versions.
Using the settings in the procedure above, the Item Handler’s Move/Copy tab is
configured as follows:
After the Workflow is initiated and the Item Handler step completes its processing, the
contents of Folder A, the source Folder, are unchanged. The contents of Folder B are as
follows:
To satisfy the Move/Copy tab settings, the Item Handler step copied Sample Compound
Document and Sample Poll into Folder B and added Folder A’s version of Sample PDF
Document as a new version. If the Synchronize Container Contents check box was not
selected, the Item Handler step would have failed when it encountered the different
versions of the Sample PDF Document.
Also, Sample Project in Folder B remains unmodified and exists in Folder B only.
Remember that the Synchronize Container Contents check box applies only to items
found in both the source and target containers.
Tutorial
The following tutorial explains how to create the Document Review Workflow, a
Workflow that allows a user to submit a Livelink Document to another user for review. An
Item Handler step copies the Document to the Workflow, which makes the Document
available for the specified user to review. After reviewing the Document, the reviewer
approves or rejects it. If the Document is approved, an Item Handler step does the
following:
• Adds Workflow attributes to the Document as Livelink Category attribute values
• Creates a Version and Generation of the Document
• Moves the reviewed Document to a Folder
If the Document is rejected, an Item Handler step moves the Document to another Folder.
Before you can create and execute the Workflow, you must prepare some sample data to
be used in the tutorial. The tutorial includes the following sections:
• “Creating Categories”, page 73
• “Creating a Document to Be Reviewed”, page 73
• “Creating Reviewed Document Folders”, page 73
• “Creating the Document Review Workflow”, page 73
• “Configuring the Start Step”, page 75
• “Creating the Copy Document to WF Step”, page 75
• “Creating the Document Review Step”, page 76
• “Creating the Evaluate Disposition Step”, page 77
• “Configuring the Move Rejected Document Step”, page 78
• “Configuring the Categories, Versioning & Move Step”, page 79
• “Creating the Notification Steps”, page 82
Creating Categories
In Livelink, create the following Category and attributes to be automatically applied to the
Document submitted for review.
The Livelink Administrator controls which users can create Livelink Categories and
attributes. For more information about creating Categories, see “Administering the
Categories Volume” in the Livelink Admin Online Help.
For more information about creating Workflow attributes, see the Livelink User
Online Help.
11. In the Disposition field, select the Require Disposition check box.
12. Click the Add to Workflow button.
13. Click the Attributes tab.
14. In the Document for Review list, click Not Available.
15. In the Document Name list, click Read Only.
16. In the Written by list, click Read Only.
17. In the Document Review By list, click Not Available.
18. Click the Add to Workflow Definition button.
19. Click the Save link.
20. Click the Painter link.
13. Drag the Evaluate step over the Categories, Versioning & Move step to create a link
between the steps.
14. Double-click the Evaluate step.
15. In the Step Name field, type Evaluate Disposition.
16. Click the Edit Expression button .
17. Create the following expression:
Document Review = Approve
18. Click the Submit button.
19. In the Steps list for the expression, click Categories, Versioning & Move.
20. Click the Add Expression button .
21. Click the Edit Expression button .
22. Create the following expression:
Document Review = Reject
23. Click the Submit button.
24. In the Steps list for the expression, click Move Rejected Document.
25. Click the Add to Workflow Definition button.
9. On the Select Category Attributes page, select the check box in the Attribute header to
select the Title, Reviewer, and Author attributes.
10. Click the Submit button.
The Document Properties Category attributes are added to the step.
11. Click the Add Mapping link for the Title attribute.
12. On the Select Mapping Data Type page, click the Select link for Workflow Attribute.
13. On the Select Mapping Field page, click the Select link for the Document Name
attribute.
A mapping between the Title attribute in the Document Properties category and the
Document Name Workflow attribute is created.
14. Click the Add Mapping link for the Reviewer attribute.
15. On the Select Mapping Data Type page, click the Select link for Workflow Attribute.
16. On the Select Mapping Field page, click the Select link for the Document Reviewed
By attribute.
A mapping between the Author attribute in the Document Properties category and
the Written by Workflow attribute is created.
17. Click the Add Mapping link for the Author attribute.
18. On the Select Mapping Data Type page, click the Select link for Workflow Attribute.
19. On the Select Mapping Field page, click the Select link for the Document Written By
attribute.
A mapping between the Author attribute in the Written by attribute and the
Document Reviewed By Workflow attribute is created.
24. Also, in the Update Options area, select the Set Attribute Value(s) check box.
This enables the step to add the values of the Workflow attributes to the Category
and attributes as defined by the mappings.
25. Click the Add button.
26. Click the Save link.
27. Click the Versioning tab.
Note The Workflow Attachments sub-tab is displayed by default. The settings on
the sub-tab control Versioning requests for all attachments added to the
Workflow definition (before it is initiated). Because the Document being
reviewed in the Workflow is added to the Workflow Attachments Folder
during Workflow processing, you must specify Versioning operations on the
Specific Targets sub-tab.
28. Click the Specific Targets link.
29. Click the Add Versioning Definition button .
30. On the Add Versioning Definition page, in the Source section, click the Item
Reference Attribute radio button, and then click Document for Review in the
attribute list.
31. In the Target section, click the Item Reference Attribute radio button, and then click
Document for Review in the attribute list.
32. In the Documents section, select the Make Generation check box, and then type My
Generation in the Override Default Generation Name field.
These settings enable the step to create a Generation of the Document named My
Generation in addition to a Version.
33. Click the Add button.
34. Click the Save button.
35. Click the Move/Copy tab.
36. Click the Add Move/Copy Definition button .
37. On the Add Move/Copy Definition page, in the Source section, click the Item
Reference Attribute radio button, and then click Document for Review in the
attribute list.
38. In the Target section, click the Livelink Container radio button, and then click the
Browse Livelink button.
39. In the Target Browse window, click the Select link for the Approved Documents
Folder.
The default Move/Copy action is move, so you do not need to specify an action.
40. Click the Add button.
Note To view the Workflow status, which contains detailed information about the
actions performed during the Workflow, on the Personal menu, choose
Workflows, click the Workflow name link, and then click the Audit link.
Overview
Livelink Embark provides you with the option to make some Workflow functions
accessible to users through email messages. In earlier Livelink releases, users could access
these features only by signing into Livelink. Before you integrate email features with a
Workflow Map, it is important to understand how the features work and the way users
interact with them.
This section covers the following topics:
• “About Email-Enabled Workflow Features”
• “Configuring and Testing Livelink”
• “Monitoring Workflow Events”
• “About Livelink Workflow Documentation”
Information in the email message the user sends to the Workflow is transferred to the
Workflow package. The following table explains how information in the initiation email is
used in the Workflow:
When Livelink receives an initiation request, the system initiates the Workflow and
returns an Initiation Confirmed message to the initiator.
ensure that the system is ready to handle Workflow email features and that requests are
processed quickly. For example, you may want to perform the following tasks before you
email-enable Workflow features:
• Verify that the Livelink Notification Agent is set to run every five minutes so that
Workflow-related email messages are sent promptly to users.
• Verify that the Livelink Server and eLink are properly working, that is, before you
attempt to email-enable a Workflow Map or step, confirm that email messages
addressed to an eLink-enabled Folder or Discussion are being received and sent.
• Verify that your mail server does not use restrictions or filters that may delay or
prevent delivery of Workflow email messages.
Note You may need to contact your Livelink Administrator to configure Livelink
and complete these tests.
Note Users must sign in to Livelink to access the Livelink User Online Help..
• If a user attaches a document to an Action Completed email message but the step is
not configured to accept attachments, the document is ignored and is not included in
the confirmation message attachment list.
Verifying Permissions
Before you make a step available through email, verify that the users who may be
assigned to the step have the Livelink permissions required to view and update the
attachments. If a step assignee attempts to send an attachment by email but does not have
permission to update the document or destination container, that work will complete,
however, the confirmation message will not indicate that the attachment has been
received.
It is essential that you provide clear and specific instructions so that step assignees who
receive the Action Requested email message for the step can understand exactly what
they need to do to complete work on the step. Open Text recommends that you follow
these general rules when you write the General instructions for steps that will be
delivered through email:
• Users who work on a step through email or in Livelink will see the same step
instructions, so be certain that the instructions are written in a way that makes sense
to users in each environment. For example, if the step instructions include references
to email messages, users who attempt to complete the step in Livelink may become
confused.
• Use basic HyperText Markup Language (HTML) tags to format the instructions.
• Use replacement tags to display additional dynamic information such as Form field
values or Workflow attributes.
• Remember that any instructions you specify on the Attachments tab of the Workflow
package are not included in email messages.
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 three days.
• The Initiator step has a duration of one day.
• The HR Approval step has a duration of two days.
When the Workflow begins executing, Livelink calculates the due date as six days from
the initiation or start 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. Also, you cannot
change the due date once the Workflow is initiated.
completes to obtain the new due date. Remember that durations of the subsequent steps
do not change, even if a step is late.
• If the assignee of the Manager Approval step completes the step in three days (the
original duration), the due date of the Workflow remains the same.
• If the assignee of the Manager Approval step completes the step in four days, the step
status is marked as late until it is sent on. The Workflow due date, however, becomes
three 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 one day, the
Workflow due date is set to two days earlier than the initial due date. Livelink adds
the durations of the subsequent steps to calculate the new due date.
107
108 Livelink Workflow Designer’s Guide
Index
A eLink module
configuring 90
Action Completed message 90 Email
Action Requested message 90 completing steps 89
Additional Reading, Recommended 107 filters 91
Assigning to Individual or Multiple Users or initiating 88
Groups 20 verifying 90
Attachments 98 Execute Using Send On Processing 31
Attributes 95, 101
Forms F
Authentication 100
Authentication 95, 96 Features 88
Filters 91
C Folder Definitions 70
Folders
Categories Creating 70
Item Handler step 48 Item Handler step 45
Comments 101 Forms 95
Completing steps 89 required 96
Copying an Attachment 37
Copying items 70 G
Item Handler step 63, 70
Creating Folders 70 Group assignments 98, 100
Item Handler step 45
H
D
How Livelink Calculates Due Dates 104
Dealing With Group Options 20
Defining a Simple Expression 8
Defining an Expression With Multiple Rows 9
I
Delegate 98 Initialization
Designing a Business Process 3 instructions 94
Designing a Flow Chart 5 Initiating 88
Dispositions 98 Initiation Confirmed message 89
Documentation 92 Instructions 94, 95
Due date 95 steps 101
Due Dates, how Livelink calculates 104 Introduction to Designing Workflow Maps 1
Due Dates, Using 103 Item Handler step
Durations, with recalculation 104 Advanced tutorial 72
Durations, without recalculation 104 Categories 48
Folders 45
E Logging 42
Moving and Copying 63, 70
eLink tutorials 42
notifications 91 Versioning 58
109
L Send On Processing 31
Sending an Email 39
Livelink 90 Start step 94
documentation 92 Display at initiation 95
log data required information 95
Item Handler step 42 Status
Loopback links 102 Workflow Status 16
Steps
features supported by email 98
M naming 102
Mapping the Flow Chart to Livelink Workflow providing instructions 101
Steps 6 Supported features 88
Messages
Action Completed 90 T
Action Requested 90
Initiation Confirmed 89 Testing 90
Moving items testing 90
Item Handler step 63, 70 The Business Process 4
The Evaluate Step’s Expression Builder 8
N
U
Naming
steps 102 User help 92
Naming Workflow Maps 96 Using Complex Step Assignments 19
Notifications Using Durations with no Recalculation 104
configuring 91 Using Durations with Recalculation 104
Using Explicit Start Dates for Steps 106
Using the Expression Builder to Dynamically As-
O sign User Steps 12
Online help 92 Using the Expression Builder to Monitor Work-
flow Status 15
Using the Expression Builders 7, 87
P Using the Milestone Step 106
Permissions 99 Using the Process Step 31, 35
Using the Sub-workflow Step 41
R V
Recalculating After Loopbacks and Evaluate Steps
Versions
105
Recalculating, after Evaluate steps 105
Item Handler step 58
Recalculating, after loopbacks 105
Recommended Additional Reading 107 W
Required software 90
Resetting Attribute Values 38 Workflow Agent 43
Workflow Maps
Naming 96
S Workflow Roles 22
Workflow Status 16
Send for Review 98
111
112 Livelink Workflow Designer’s Guide