Escolar Documentos
Profissional Documentos
Cultura Documentos
Workflow Manager
Version 6.5
User Guide
P/N 300007241 A01
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748‑9103
1‑508‑435‑1000
www.EMC.com
Copyright © 2003 ‑ 2008 EMC Corporation. All rights reserved.
Published July 2008
EMC believes the information in this publication is accurate as of its publication date. The information is subject to change
without notice.
THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONS
OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY
DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.
For the most up‑to‑date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.
All other trademarks used herein are the property of their respective owners.
Table of Contents
Preface ........................................................................................................................... 7
List of Figures
List of Tables
You use Workflow Manager to create workflows. A workflow formalizes a business process, enabling
users to repeatedly perform the business process.
For more information about workflow, including technical details about managing workflows through
the Documentum application programming interface, see Documentum Content Server Fundamentals.
Intended Audience
The manual assumes that you are familiar with Webtop. Webtop is a WDK‑based
application. A WDK‑based application is built on WDK (Web Development Kit)
functionality. A WDK‑based application lets you access an EMC Documentum
repository over the web. WDK functionality lets you access, edit, and manage content in
multiple repositories. WDK functionality lets you distribute content through automated
business processes, restrict access to content according to permission sets, and assign
version numbers to content to help keep track of revisions.
Revision History
The following changes have been made to this document.
You use Workflow Manager to create workflows. A workflow formalizes a business process, enabling
users to repeatedly perform the business process.
This chapter introduces the basic concepts of Documentum workflow. The following topics are
included:
• Introducing Workflows, page 9
• Workflow Templates and Associated Objects, page 12
• Planning Workflow Activities, page 13
For more information about workflow, including technical details about managing workflows through
the Documentum application programming interface, see Documentum Content Server Fundamentals.
Introducing Workflows
A workflow formalizes a business process such as an insurance claims process or
an engineering development process. After the business process is formalized in a
workflow definition, called a workflow template, users can use the template to repeatedly
perform the business process. Because a workflow’s template is separate from its runtime
instantiation, multiple workflows based on the same template can be run concurrently.
A workflow template consists of multiple activities linked together by flows. Activities
represent the tasks users must perform to process the documents being routed
through the workflow, such as reviewing a document, checking it into the repository,
or approving it. Flows are the links between the activities, specifying the sequence of
activities and the packages that are exchanged between them. Packages contain the object,
generally a document, passed between activities so that work can be performed on it.
See Workflow Templates and Associated Objects, page 12 for further details about these
workflow components.
Workflows can describe simple or complex business processes. You can create workflows
that have both serial segments, in which activities follow one another in a specified
sequence, and parallel segments, in which two or more activities happen concurrently.
You can also create a cyclical workflow, in which the completion of an activity restarts a
previously completed activity. The path that a document takes through the workflow can
differ depending on what happens along the way; for example, a purchase order could be
routed to different activities depending on whether the manager approves it or rejects it.
You can create a workflow template that can be used in many contexts. This is done by
including activities whose performers are identified by aliases instead of actual user
names. When aliases are used, the actual user is selected at runtime. For example, a
typical business process for new documents has four steps: authoring the document,
reviewing it, revising it, and publishing the document. The actual authors and reviewers
will be different people for different documents. Rather than creating a separate
workflow for each document with the author and reviewer names hard‑coded, you
create one workflow template with activity definitions that use aliases for the author
and reviewer names. Depending on how you design the workflow, the actual people
represented by the aliases can be chosen by the person who starts the workflow, by the
person who performs the previous activity, or automatically by the server when the
containing activity is started. For more information about using aliases in workflows,
refer to Using Aliases, page 17.
A workflow’s process definition is stored in a workflow template, implemented by
Documentum Content Server as a dm_process object. The definitions of individual
activities in a workflow are stored in dm_activity objects. Storing activity definitions and
workflow templates in separate objects allows activity definitions to be used in multiple
workflow templates. When you design a workflow, you can include existing activity
definitions in addition to creating any new activity definitions needed.
When you start a workflow, the server uses the workflow template (the dm_process
object) to create a runtime instance of the workflow (a dm_workflow object). When an
activity starts, the server creates one or more work items, which are tasks that the server
adds to the Inbox of the users who are the designated performers of the activity.
Figure 2, page 11 illustrates how the components of a workflow template and runtime
instance work together. For more details about the object‑level implementation of
workflow, see Documentum Content Server Fundamentals.
There are two types of flows: forward flows and reject flows. Forward flows advance
packages from an activity to the next activity in the normal workflow, for example
moving a package from the Edit activity to the Approve activity. Reject flows determine
what happens when the performer of an activity rejects the package being routed. They
direct packages in a backward loop, for example sending a package from the Approve
activity back to Edit.
All Step activities must have at least one flow coming in and one flow going out. A Begin
activity has at least one outward flow, but no incoming flow. An End activity must have
at least one incoming flow, but no outward flow.
Each flow in a workflow template has a unique name. The definition of a flow also
includes a set of attributes that define the packages that each activity can handle.
Choosing Activities
Each workflow template must have one or more Begin activities and a single End
activity. The template can have any number of Step activities. The number of Step
activities you include depends solely on the structure of the workflow, which will
depend on its business purpose.
Each activity in a workflow must have a name that is unique within the workflow
template. The name is assigned when you add the activity to the workflow template.
Choose activity names that are descriptive of the work performed by the activity.
You can include any activity that you create or any activity for which you have at least
Relate permission.
You can use an activity definition more than once in a workflow. For example, suppose
you want all documents to receive two rounds of review. You might design a workflow
with the following activities: Write, Review1, Revise, Review2, and Publish. The
Review1 and Review2 activities can use the same activity definition.
However, if you use an activity multiple times in a workflow, you must structure the
workflow so that only one instance of the activity is active at any time. A workflow
cannot start an activity if a previous activity based on the same definition is still running.
Choosing Performers
An activity definition includes the information that lets Workflow Manager determine
who will perform the activity. Workflow Manager supports a wide range of choices for
a manual activity’s performer. For automatic activities, you must still identify a user
whose permissions will be used when running the script or program.
When a manual activity starts, the server adds a queue item to the Inbox of the user or
users designated as the performer of that activity.
Table 1, page 15 lists the categories from which you can choose a performer. Each
category is represented by an integer value. Only the first four options are available
for automatic activities.
When you create the activity, you must define the performer type, the user category. You
can also define the actual performer at that time or you can configure the activity so that
the actual performer is selected at runtime:
• By the workflow initiator when the workflow is started
• By the server, when the activity is started
• By the performer of a previous activity, when the previous activity completes
Defining the actual performer in an activity definition is the least flexible structure.
Allowing the performer of a previous activity to choose an activity’s performer is the
most flexible structure, since it lets decisions about performers be based on current
circumstances and business rules.
If you select category 0 (Workflow supervisor), 1 (Repository owner), or 2 (Previous
activity’s performer) as the user category, the actual user is defined by the category. For
example, an executing workflow has only one workflow supervisor and the repository in
which it runs has only one repository owner. It isn’t necessary to define the actual person
when you create the activity. The server determines it when the activity is started.
If you select category 3 (Specific user), you can provide a user name when you create
the activity to identify the actual person. To have the actual person selected when the
workflow runs, use an alias in place of a specific user name; see Using Aliases, page
17 for information about aliases. The alias can be resolved automatically by the server
using an alias set or by the performer of a previous activity. The same options apply to
categories 4, 5, or 6, except that you provide the name of a group instead of an individual
user. Provide a group name if you are choosing the actual group when you create the
activity; use an alias if you want the actual group selected at runtime.
For categories 8 and 9, you provide the names or aliases for a list of multiple users. Just
as with the other categories, you can choose the actual performers when you create the
activity, have the performer of a previous activity chose the performer, or use aliases
to have the performer chosen at runtime.
Using Aliases
An alias is a descriptive name for a category of user or group that you use in place of an
actual user or group name. At runtime, the server replaces the alias with the name of the
actual user or group who fits the category in that time and place. Using aliases in activity
definitions creates a flexible workflow template that can be used a variety of contexts.
For example, suppose you are creating a workflow for vacation requests. Each
department in your company has a different manager who must approve vacations.
Rather that create a different workflow template for every department, you want to
create one template for everyone to use. After all, the business process is the same for
every department. In place of specific performer names for the activities, you use an
alias, such as Manager. When the workflow runs, the server answers the question ʺWho
is the Manager of the workflow initiator?ʺ and sends a work item to that user.
The server resolves aliases at runtime by searching one or more alias sets to find the alias
and its associated actual value. An alias set is an object that defines a list of aliases and
their corresponding actual values. You create alias sets in Documentum Administrator;
see the Documentum Content Server Administration Guide for details. You can associate
alias sets with particular users, and in Workflow Manager you can identify a default
alias set for the workflow.
When you include an alias as the performer for an activity, you can specify that the
server resolve the alias at runtime by referring to the default alias set for the workflow,
to the alias set associated with the user who starts the workflow, to the alias set for the
performer of a previous activity, or to any other alias set you choose. You can also have
the server require the workflow initiator to manually provide values for the aliases when
the workflow starts; to require the workflow initiator to resolve the aliases, you define a
default alias set for the workflow template that contains the aliases but not the names to
which the aliases are mapped. See Choosing manual performers, page 49 for details.
In addition to priority settings Low, Medium, and High, Workflow Manager enables you
to set a Dynamic priority for an activity. Dynamic priority is when the priority of the
activity is set using custom code as the workflow runs rather than being set as part of
the workflow template. You should assign Dynamic priority only when your system
includes custom code to set the priority at runtime.
See Setting Activity Definitions, page 56 for information about setting the priority
of an activity.
Defining Packages
When you define a flow linking two activities, you need to specify what objects are
passed along the flow. An object, usually a document, passed between activities is called
a package. Each flow must have at least one package that it transports from one activity to
the next. The flow can include more than one package if necessary.
To define a package, you identify the document or other object to route, including which
repository version. You also have the option to choose the operation that the performer
of the activity receiving the package needs to perform.
There are three basic options for what an activity does with a package it receives:
• The activity can send on the package without change.
• The activity can send on the package with a new version of the object contained
within it.
• The activity can send a new package to the next activity.
In many workflows, the same package passes through all activities. For example, a
workflow for reviewing and approving purchase orders will pass the same purchase
order document as a package to all the necessary activities. In this case, each activity
passes along to the next activity the same package it received. In Workflow Manager,
you accomplish this scenario by configuring the flows leading into and out of the activity
so that they use the same package name, package type, and version.
In other cases, the work performed by an activity results in a new version of a document
from the incoming package. For example, a user might receive a document for review.
He or she checks out the document, adds comments or revisions, and checks in the
document. In this case, you want the activity to send the new version of the component
when it sends the package to the next activity. In Workflow Manager, you accomplish
this scenario by configuring the incoming and outgoing flows to use the same package
name and type, but a different version. You can specify the version using an actual
version number, such as 2.5, or a symbolic version label, such as Draft or CURRENT.
The work performed in some activities requires the activity to send on a package that is
entirely different from the package it received. For example, suppose an activity accepts a
personnel action notice. The performer (an HR employee) must file the notice, then send
Setting Up Notifications
When you configure an activity, you can set timers that send a message to the workflow
supervisor if work does not appear to be flowing as it should. For example, you might
want the workflow supervisor to receive a warning if the activity is not started within 12
hours of when the workflow started, or if the activity has not been completed 4 hours
after its start. When you create the activity, you would provide these values (12 and
4) as the timer settings.
Workflow Manager supports two kinds of warning timers for activities:
• A pre‑timer that alerts the workflow supervisor if an activity has not started within a
designated number of hours after the workflow starts
• A post‑timer that alerts the workflow supervisor if an activity has not completed
within a designated number of hours after the activity starts
The task of checking the warning timers and sending the notices to the workflow
supervisor is performed by the dm_WfmsTimer system administration tool. The
dm_WfmsTimer tool is installed with the system administration tool suite. It is not
installed in the active state. If you intend to use warning timers in workflows, make sure
that your system administrator activates this job. When it is active, it runs by default
once an hour. See the Content Server documentation for further information about
dm_WfmsTimer.
The workflow supervisor receives warning notifications in the form of an item in their
Inbox queue.
See Setting Notifications, page 57 for information on how to set notification timers.
If you let performers select the next activities, you can limit the number of following
activities the performer can select. For example, if an activity has three outgoing flows,
you can let the performer send packages to all three, or you can require the performer to
select just one or two of them.
If you let a group of performers select the next activities that is, if the performer category
is 4 or 8 and the transition option is Let performer select the next activity you also need to
advise the server about how to combine the performers’ selections. When a group selects
activities, it is possible that some performers might select forward activities while others
select reject activities. Which activities should the workflow engine start in this case?
All of the selected activities, just the reject activities, or just the forward activities? You
can also decide to complete the activity immediately whenever any performer selects a
reject activity or a forward activity.
If you choose an conditional transition type, you must define at least one transition
condition for that activity.
Transition conditions enable you to define activities that route packages differently
depending on the results of the activity. A transition condition is a logical condition
and one or more associated flows. When an activity is complete at runtime, the server
evaluates the activity’s transition conditions to determine which following activities to
start as the next step in the workflow. It delivers packages to the activities associated
with the first transition condition that is TRUE. An activity can have multiple transition
conditions, although the server always selects just one the first TRUE one at runtime.
For example, you could define an activity that routes a document differently depending
on whether the performer checked in a new version of the document. The server uses the
following logic to determine where to send the document next:
If
(New version checked in) then Route to activity Evaluate Updates Else
Route to activity Continue Approval
Transition conditions must be Boolean expressions. They are typically used to check
attributes of the package’s components, the containing workflow, or the last completed
work item. If the transition condition includes a reference to a repeating attribute, the
attribute must have at least one value or the condition generates an error when evaluated.
When you use transition conditions, you always include an Else option. The Else option is
the action that the server takes if none of the transition conditions apply. The Else option
does not have a condition associated with it. An activity can only have one Else case.
For information about defining transition conditions for an activity, see Setting Activity
Transition Rules, page 58.
Workflow Manager is a graphical tool for laying out and defining your workflow. The Workflow
Manager window is divided into two major panes:
• The left pane is the workflow template editor, which displays a graphical representation of your
workflow template as you create it
• The right pane contains the Activities palette and Workflow palette, which display predefined
activities and workflows that you can add to the template
You can control the size of the two panes by positioning the mouse over the border between them and
dragging the border to a new position.
A pair of arrows appears between the two panes. To expand one of the panes to fill the window, click
the arrow pointing away from the pane you want to expand. To return the Workflow Manager
to its two‑pane view, click the arrow facing the other direction, which now appears at the edge
of the window.
A configurable toolbar appears across the top of the window, providing quick access to common
commands.
If the workflow is too large to display on the screen, you can use the Navigator to view the complete
workflow and specify which portion appears.
Activities Palette
The Activities palette displays predefined activities that you can drag and drop on to
the workflow template editor, adding them to the template. You control which activities
appear on the palette by specifying search conditions. You can search for activities
using these conditions:
• The name of cabinet where the activity is located
• The owner of the activity
• The activity name
• The state that the activity is in
You also have the option to enter a Documentum Query Language (DQL) statement
that selects activities.
5. To further restrict the list of activities from the selected cabinet, fill in the appropriate
conditions:
• To display only activities owned by a particular user, select an operator from the
Owner’s name drop‑down list and enter a user name in the adjacent text box.
The operator specifies the relationship between the name of the activity owner
and the value that you enter in the text box.
• To display only activities with particular activity names, select an operator from
the Activity name drop‑down list and enter a name or partial name in the text
box.
• To display only activities with a particular definition state, select the state from
the Definition state is drop‑down list.
If you leave any of these fields blank, the list of activities will not be restricted based
on that criterion.
6. If you selected Use results from this query in the repository, enter a DQL query
in the adjacent text box.
The Activities palette will include all activities returned by the query.
7. Specify whether the selected activities replace or supplement the activities currently
displayed on the Activities palette.
• To replace the current list of activities with those selected in this dialog box,
select the Replace repository templates in palette check box.
• To add the selected activities to those already on the palette, do not select the
check box.
Note: The standard Workflow Manager activities remain on the palette regardless of
the option you choose. You can only replace user‑defined activities.
8. Click OK to close the dialog box.
The Activities palette displays the updated list of activities. A message box appears,
telling you how many activities were added or removed from the palette.
9. Click OK to close the message box.
Workflow Palette
The Workflow palette displays predefined workflow templates that you can drag and
drop on to the workflow template editor, adding their activities and flows to the new
workflow template. You control which workflow templates appear on the palette by
specifying search conditions. You can search for templates using these conditions:
• The name of cabinet where the workflow template is located
• The owner of the workflow template
• To replace the current list of workflow templates with those selected in this
dialog box, select the Replace repository templates in palette check box.
• To add the selected templates to those already on the palette, do not select the
check box.
Note: The standard Workflow Manager workflow templates remain on the palette
regardless of the option you choose. You can only replace user‑defined templates.
8. Click OK to close the dialog box.
The Workflow palette displays the updated list of workflow templates. A message
box appears, telling you how many templates were added or removed from the
palette.
9. Click OK to close the message box.
Aligning activities
The Alignment options enable you to position workflow activities precisely. You can
align activities vertically or horizontally by their left or right edges, top or bottom edges,
or by their center points.
To align activities:
1. Select the activities you want to align.
You must have two or more activities selected to enable the Alignment options.
See Workflow Template Editor Pane, page 30 for information about how to select
activities.
2. If the alignment toolbar is active, click the icon corresponding to the alignment
option you want.
The available alignment options are:
• Align top edges
• Align vertical centers
• Align bottom edges
3. If the alignment toolbar is not active, select Alignment from the Edit menu.
The Task Alignment dialog box displays.
4. Select the icon that represents the alignment you want.
5. Click OK.
Snap to grid
The snap to grid option provides added precision for aligning workflow activities and
flows.
When the snap to grid option is turned on, a grid appears in the background of the
workflow template editor. Each square in the grid measures a third of an inch. When
you move activities or flows in the editor, they will automatically align themselves with
the grid, making it easier to align objects with each other. Turning on snap to grid does
not effect the layout of existing objects in the template.
When the snap to grid option is turned off, the grid does not appear and objects are
placed exactly where you drop them. Turn the option off when you want to have fine
control over the position of the objects.
Zooming in or out
If the Display toolbar buttons are active, the current level of zooming appears in a box
between the Zoom In icon and the Zoom Out icon . Each time you click the Zoom
In or Zoom Out icon, Workflow Manager zooms in or out by one magnification level.
• 50%
• Last Toggles between the current zoom option and your previous zoom setting
• Width Sizes the workflow template so that its full width fits within the visual
dimensions of the workflow template editor pane
• Fit Magnifies or shrinks the appearance of your workflow template so that it fits
within the visible dimensions of the workflow template editor pane
Navigator
When you are defining a workflow template, the graphical representation can easily
grow beyond a size that can be displayed on the screen all at one time. The workflow
template editor automatically scrolls as you add objects and create a larger layout.
The Navigator enables you to control which portion of a large template appears on
the screen.
Workflow templates represent the business process through which a given object or set of objects
flows. They define the overall workflow from beginning to end. You create workflow templates in
Workflow Manager, then make them available for users to create individual workflow instances from.
There are three possible states for workflow templates: draft, validated, and installed. The current
state of the open template appears in the title bar of the Workflow Manager window.
A template in the draft state has not been validated since it was created or last modified. A template
in the validated state has passed the server’s validation checks, which ensure that the template is
correctly defined. A template in the installed state is ready for use in an active workflow.
This chapter explains how to create templates, validate them, and install them. The topics are:
• Opening Existing Templates, page 35
• Creating Templates, page 36
• Setting Template Properties, page 38
• Saving Templates, page 39
• Validating Templates, page 41
• Installing Templates, page 41
• Modifying Templates, page 42
• Printing Workflow Templates, page 43
Creating Templates
The procedure below provides an overview of creating templates. Several of the steps
provide links to other topics where you can find more detail about the task described by
that step.
• To add a new activity that will be performed manually by a person, select the
default Activity that appears at the top of the Activities palette.
• To add a new automatic activity, select the default Auto‑Activity.
• To add a copy of an activity previously defined, select that activity from the
Activities palette. If the activity you want does not appear on the Activities
palette, see Activities Palette, page 27.
6. Connect each activity to the activity that precedes it in the logical flow.
The first activity in the workflow must be connected to the Initiate task, and the last
activity must be connected to the End task.
To connect two activities, select one of the flow icons described below, move your
mouse over the first activity until you see its selection box, then drag the mouse to
the second activity. Release the mouse button when you see the selection box for the
second activity. Workflow Manager draws a line between the activities.
You connect activities using one of three Create Flow icons in the Workflow Manager
toolbar:
• To connect activities in a forward movement of data, click either the Create
Single Segment Flow icon or the Create Multi‑Segment Flow icon . The
difference between the two is visual: one draws a straight line to represent the
flow between activities, the other draws a line consisting of multiple segments.
• To connect activities in a backward movement of data, click the Create Reject
Flow icon . Reject flows represent the path taken when the user of an activity
rejects the object being processed.
7. Configure each flow line, specifying the package that the workflow routes.
See Setting Package Requirements, page 66 for details about configuring flows. Do
not add a package to the flow connecting the final activity to the End task.
8. Configure each activity.
See Chapter 4, Working with Activities
for details about configuring activities.
9. Adjust the visual layout as necessary.
For information about the options available for laying out the workflow template
display, see Workflow Template Editor Pane, page 30.
10. Save the workflow template.
See Saving Templates, page 39.
11. Validate the workflow template.
See Validating Templates, page 41.
12. Install the workflow template.
See Installing Templates, page 41. Once you have installed the template, it is
available to users.
selected, the prompts do not display, and you need to validate and install the
template as separate steps.
8. Click OK.
Saving Templates
When you have completed a workflow template, you must save it before you can validate
and install it. Saving the template copies your changes to the repository.
The process of saving differs depending on whether you are saving changes to an existing
template or saving a template with a new name. You can only save workflow templates
that are in a draft state or a validated state, and you must have at least Write permission
on the template. The current state of the template appears in the Workflow Manager title
bar. If the Save options are grayed out on the File menu, it may mean that the template
has been installed. You must uninstall it before you can make any changes to it.
If installation and validation prompts are set to display, a dialog box appears asking
whether you want to validate the template. (Installation and validation prompts are
set on or off in the Template Properties dialog box; see Setting Template Properties,
page 38.)
6. Choose whether to validate the workflow template.
See Validating Templates, page 41 for more information about validating templates.
If you choose to validate the template, Workflow Manager attempts the validation.
If validation fails, a dialog box appears telling you so. Click the Details button to
see the error that prevented validation.
If the validation is successful, a dialog box appears asking whether you want to
install the template, making it available for use.
7. Choose whether to install the workflow template.
See Installing Templates, page 41 for more information about installing templates.
Validating Templates
Validating a template verifies that the process defined in the template meets system
requirements.
You can validate a template at any time by selecting Validate from the File menu. If
installation and validation prompts are set to display, a dialog box appears when you
save asking whether you want to validate the template. Installation and validation
prompts are set on or off in the Template Properties dialog box; see Setting Template
Properties, page 38.
If validation fails, a dialog box appears telling you so. Click the Details button to see
the error that prevented validation. If the validation is successful, a dialog box appears
asking whether you want to install the template, making it available for use.
Please note that any errors that occur will refer to activities by their names. If you label
activities with the performer name, you might want to temporarily change the display
setting to Name in order to locate the activity. See Changing Display Settings, page
62 for information about this display setting.
You can only validate if your open template is in the draft state and you have Write
permission, or your template is in run‑time mode and you have at least Relate permission.
Validating a workflow template verifies that:
• The referenced activities have unique names within the template
• There is at least one Begin activity and only one End activity
• There is a path through the workflow from each activity to the End activity
• All package definitions are valid
• All referenced objects exist as local objects
Installing Templates
A workflow template must be installed before it is available for use in an active
workflow. You can only install a template if it is in the validated state and you have
Write permission, or it is in run‑time mode and you have at least Relate permission. The
current state of the open template appears in the title bar of the Workflow Manager
window. If it is not validated, select Validate from the File menu. See Validating
Templates, page 41 for more information.
If you need to make changes to an installed template, you must uninstall it first. Any
active workflows based on the template are halted. After making the changes, validate
and install the template again.
When you reinstall, you can choose how you want to handle any workflows that
were halted when you uninstalled the template. You can choose to resume the halted
workflows at the point from which they were halted. Or, you can choose to abort
the workflows. Which option you choose depends on the changes you made to the
workflow. Perhaps you added an activity that you want to perform on all objects in the
workflow. In that case, you abort the workflows and then start each again. The default
behavior is to resume all halted workflows that reference that template.
Modifying Templates
You can change a workflow template by changing its process flow or activity definitions.
When you change a workflow template, you can either overwrite the existing template
with the changes or create a new version of the template. Any changes you make are
governed by object‑level permissions.
To make changes to a workflow template and save the changes without versioning,
you must uninstall the template. To uninstall a template requires Relate permission
on the template or sysadmin or superuser privileges. To save your changes requires
Write permission.
To create a new version of a workflow template, you must check out the template before
you begin modifying it. You must have at least Version permission on the template.
You can create a new version of a template without uninstalling the current version.
Versioning a workflow template has no impact on the running workflows based on the
previous version of the template.
When you save or check in your changes, the server sets the new version to the draft
state. The new version must be validated and installed before you can start a workflow
based on it.
See also Saving Templates, page 39.
8. Click OK.
If you elected to print to a file, the Print to File dialog box appears. Otherwise, the
workflow template is sent to the printer you selected.
9. In the Print to File dialog box, enter the name of the file to create, including the
full path.
• Fit to The size of the workflow template will be adjusted so that it fits on a
specified number of pages across and down. If you select this option, you must
enter a number in each of the two adjacent text boxes.
6. Click OK to save the page setup options and exit from this dialog box, or click Print
to print the current template with these settings.
Activities are the tasks that comprise the workflow. Most of the configuration of the workflow relates
to configuring its activities. For information about planning the configuration of workflow activities,
see Planning Workflow Activities, page 13.
You configure activities using the Activity Inspector. You access the Activity Inspector by
double‑clicking on an activity in the workflow template editor pane, or by selecting one or more
activities and choosing Activity Inspector from the Tools menu. There is also an Activity Inspector
icon on the toolbar.
The Activity Inspector has several tabs, each corresponding to one aspect of activity configuration:
• The Performer tab enables you to select who performs the activity and what actions the
performers have available to them; see Selecting Performers, page 48 for details.
• The Definition tab sets the priority for automatic activities and lets you provide instructions for
manual performers; see Setting Activity Definitions, page 56.
• The Trigger tab settings determine when the activity starts; see Setting Activity Triggers, page 56.
• The Notification tab sets timers to warn the workflow supervisor if work bogs down; see Setting
Notifications, page 57.
• The Transition tab settings determine which activities come next in the workflow; see Setting
Activity Transition Rules, page 58.
• The Display tab controls how the activity appears in the visual display of the workflow template;
see Changing Display Settings, page 62.
The name of the activity you are configuring appears in the text box at the top of the Activity
Inspector. Each activity must have a unique name within the template. To change the activity name,
enter the new name in the text box, replacing the previous name. If more than one activity is selected,
arrow buttons appear on either side of the text box, enabling you to scroll through the selected
activities. The settings you make apply to the activity whose name appears in the box, unless you
select the Apply to all selected option.
When multiple activities are selected, each tab in the Activity Inspector displays one or more check
boxes labeled Apply to all selected. When this check box is selected, Workflow Manager applies the
associated settings that is, those settings that appear to the right of the check box to all selected
activities, not just the one whose name appears in the text box at the top. For example, you can select
multiple activities and choose the same performer for all of them at once. Any settings for which
the check box is not selected apply only to the current activity.
Selecting Performers
The first task when defining an activity is to specify who performs the activity.
Activities can be performed manually by an individual, group, or alias that you identify,
or automatically by a workflow method. For manual tasks, you can select specific
performers or allow the workflow participants to choose performers. For automatic tasks
you must specify a user whose permissions the automatic task takes on.
a. Choose the action to automatically perform from the Execute this method
automatically drop‑down list. The actions in the drop‑down list are workflow
methods.
Note: To make a custom method available here, the attribute a_special_app
must be set. a_special_app is a dm_sysobject attribute reserved for use by
Documentum products. This attribute must have the value Workflow. See the
Content Server documentation for details.
b. To save an execution log when the automatic method runs, select Yes for Save
Execution Results.
c. Specify how long the workflow server tries to run this method before quitting.
Enter a number of seconds in the Method times out in box.
d. Decide whether the workflow will stop or continue if the workflow method
encounters problems. Selecting Stop Execution causes the task to be placed in a
paused state and be reassigned to the workflow supervisor. Selecting Continue
Execution causes the task to be placed in an acquired state and forces the
completion of the task.
Note: We recommend choosing Stop execution for any automatic activity that
has other activities following it.
6. Click Apply to save your updates without closing the Activity Inspector, or click OK
to save your updates and close the Activity Inspector.
• If you selected Single user on the previous screen, highlight the name of a group
or <All users> in the Groups list box, then select the performer of this activity from
the users in the selected group from the Users in Group list box. After selecting a
user, click Finish.
• If you selected All users in group or Single user from group on the previous screen,
select a group from the Groups list box, then click Finish.
• If you selected Some users from a group or Multiple sequential performers, you
can designate multiple users, groups, or alias names to perform the activity. See the
procedure in the topic Have performer(s) of <activity> determine performer(s) of this
activity, page 52 for details about the options that appear when you click Next.
Note: Because you chose Assign users now, the server will select all users in the list
you build as performers, not use the list to provide a selection list to the performer
of a previous activity as described in the topic Have performer(s) of <activity>
determine performer(s) of this activity, page 52.
This feature is also known as dynamic performer selection. This option gives the performer
of one activity the ability to choose which users will perform the next activity in the
workflow. At runtime, the performer of the activity can choose one or more users from
the group you specify.
If you selected Some users from a group or Multiple sequential performers, you can
designate a combination of multiple users, groups, or alias names from which the
performer of the previous activity can choose at runtime. If you selected any of the
other performer types, no further definition of the performer is necessary. This page
does not appear.
For more information about aliases and alias sets, see Using Aliases, page 17.
• To choose a new alias set, click Create new alias set and enter a name and
description for the alias set. The server will create a new alias set using the
information you enter on this page and the next.
Click Next when you have identified the alias set.
5. If you chose Performer alias(es) which will be resolved by the workflow initiator,
identify one or more aliases for which the workflow initiator needs to enter values
for when starting the workflow.
a. Specify whether you will Create a new performer alias or Use an existing,
undefined performer alias. An existing, undefined alias is an alias that appears
in the alias set but does not have a specific user name assigned to it in the alias set.
b. To create a new performer alias, enter a name and description for the alias, then
click Add to add it to the Selection List.
c. To use an existing performer alias, select the appropriate alias from the Existing
performer alias drop‑down list, then click Add to add it to the Selection List.
Optionally, you can modify the description of the alias so that its purpose is
clear to the workflow initiator.
d. When the Selection List includes all the aliases you want, click Next or Finish
(depending on whether you chose the final option at step 1).
6. If you chose Performer alias(es) which will be resolved at run‑time from the alias
set, select the aliases that the server will resolve from selected alias sets.
a. Select an alias set from the Alias Set list, then a specific alias from the list below it.
b. Click Add to add the alias to the Selection List.
c. Repeat steps a and b for each alias you want to include.
7. Click Finish.
When you select this option, you need to specify which alias set and alias the workflow
server will use at runtime to determine the actual person to perform this activity. First
you choose an alias set, then identify a specific alias within that set.
For more information about aliases and alias sets, see Using Aliases, page 17.
• Default alias set (workflow initiator will resolve when workflow is started)
The server refers to the alias set defined as the default for this workflow. The
default alias set is defined on the Template Properties dialog box; if no alias set
has been selected, you will have a chance to set it on the next page.
• Specific alias set The server refers to the alias set whose name you select from
the adjacent drop‑down list. The list includes alias sets in the repository to which
you are currently connected and on which you have Write permission.
• Alias set of document in package The server refers to the alias set assigned to a
document in a package that this activity receives. Select which package’s alias set
to use from the adjacent drop‑down list. If you choose <Any>, the server will
scan through the alias sets of all packages until it finds the first match to the
specific alias you will identify at step 4.
• Alias set of previous performer The server refers to the alias set assigned to the
performer of the previous activity. Use this option, for example, if this activity
needs to be performed by the Manager of the previous activity’s performer. If,
at runtime, the previous performer does not have an associated alias set, the
server will use the alias set belonging to the previous performer’s group. If
the group does not have an alias either, the failed activity task is sent to the
workflow supervisor.
2. Click Next.
If you chose Default alias set but have not yet selected a default alias set for this
workflow, you need to choose an alias set.
If you chose one of the other options or have already set the workflow’s default
alias set, clicking Next takes you to a page where you can choose the specific alias
within that set. Skip step 3.
3. If you have not yet defined a default alias set for this workflow, choose one.
• To choose an existing alias set, click Choose from existing alias sets and select
an alias set from the drop‑down list. The list includes alias sets in the repository
to which you are currently connected and on which you have Write permission.
• To choose a new alias set, click Create new alias set and enter a name and
description for the alias set. The server will create a new alias set using the
information you enter on this page and the next.
Click Next when you have identified the alias set.
4. Identify the specific alias within the selected alias set.
If you chose a specific alias set at step 2, the Performer Alias drop‑down list includes
the aliases defined in that alias set.
If you chose an alias set that will be selected at run time, such as the previous
performer’s alias set, the Performer Alias drop‑down list is empty. Type the name
of the alias in the box, making sure that the name exactly matches the name in the
alias set that the server will find. If at runtime the server does not find a match
between the performer alias and the available aliases in the alias set, the activity task
is returned to the workflow supervisor along with a notification.
5. Click Finish.
To choose the user whose security access is used for an automatic activity:
1. On the Activity Inspector’s Performer tab, select Automatically on behalf of a
performer and click the Select Performer button.
The Select Performer dialog box appears.
2. Choose which user’s security access will be used by the automatic activity:
• Workflow supervisor The automatic activity will use the permissions of the
workflow supervisor, which by default is the user who starts the workflow.
• Repository owner The automatic activity will use the permissions of the
repository owner.
• Previous activity’s performer The automatic activity will use the permissions of
the user who performed the previous activity in the workflow.
• Specific user The automatic activity will use the permissions of a user you
choose in the next step.
3. If you chose Specific user, select the user whose permissions will be used.
a. Click the Choose button to display the Select User dialog box.
b. In the Groups list box, highlight the name of a group or <All users>. The users
in the selected group appear in the Users in Group list box.
c. Select the user from the Users in Group list box. The user name appears in
the Selection text box.
d. Click OK.
The selected user name appears in the User text box.
4. Click Finish.
The selected user name appears in the text box next to the Select Performer button.
2. Specify how many of the activities input flows must have been completed before
this activity starts.
• To start this activity only when all preceding activities are complete, check All
input flows are selected.
• To start this activity when some number of its preceding activities are complete,
check This number of input flows selected and enter the number of preceding
activities that must be complete before the activity runs. The total number of
input flows for this activity is shown next to the text box.
When an activity has only one input flow, these options are not different.
3. To ensure a specific action occurs before the selected activity is run, check the And
when this event arrives check box and enter an event name in the adjacent text box.
The event can be a system‑defined event, such as dm_checkin, or you can make
up an event name, such as promoted or released. If you include a trigger event in
the starting condition, the server must find the event you identify queued to the
workflow before starting the activity. See the chapter ʺTasks, Events, and Inboxesʺ
in Documentum Content Server Fundamentals for further details about defining and
queuing events using the Documentum API.
4. To enable the activity to be run more than once in the same workflow, check the This
activity can run more than once in a workflow check box.
A repeatable activity is an activity that can be used more than once in a particular
workflow. By default, activities are defined as repeatable activities. Activities with
multiple performers performing sequentially cannot be repeatable. (Choosing
Performers, page 14 describes the user categories for performers.)
If you use an activity multiple times in a workflow, you must structure the workflow
so that only one instance of the activity will be active at any time. The server cannot
start an activity if a previous activity based on the same definition is still running.
5. Click Apply to save your updates without closing the Activity Inspector, or click OK
to save your updates and close the Activity Inspector.
Setting Notifications
Workflow Manager supports two kinds of warning timers for activities:
• A pre‑timer that alerts the workflow supervisor if an activity has not started within a
designated number of hours after the workflow starts
• A post‑timer that alerts the workflow supervisor if an activity has not completed
within a designated number of hours after the activity starts
The task of checking the warning timers and sending the notices to the workflow
supervisor is performed by the dm_WfmsTimer system administration tool. The
dm_WfmsTimer tool is installed with the system administration tool suite. It is not
installed in the active state. If you intend to use warning timers in workflows, make sure
that your system administrator activates this job. When it is active, it runs by default
once an hour. See the Content Server documentation for further information about
dm_WfmsTimer.
• To start the selected next activities only after the number of performers identified
in step 3 have completed the task, click the All performers complete the
task radio button. With this option, the server combines the selections of all
performers. If some users select forward activities and others select reject
activities, the server determines which activities to start based on the final set
of radio buttons on this tab.
— To start all of the activities selected by performers, both forward activities
and reject activities, click Start all selected activities.
— To start only the selected reject activities (if there are any), click Start only
reject activities. Forward activities are started only if all performers select
forward activities.
— To start only the selected forward activities (if there are any), click Start
only forward activities. Reject activities are started only if all performers
select reject activities.
6. Specify the conditions that the server uses to determine which activities receive
packages.
See Creating transition conditions, page 60 for information about creating transition
conditions.
7. Click Apply to save your updates without closing the Activity Inspector, or click OK
to save your updates and close the Activity Inspector.
3. If you elected not to use the wizard, edit the condition in the Transition Condition
Editor.
a. Enter the condition in the Condition text box. The format of a condition is
object_type.attribute_name=ʺconditionʺ. You can include multiple conditions
connected by AND. See step 4 for information about the available objects.
b. Select the activities to which packages are routed when this condition is met.
c. Click OK and skip to step 14 of this procedure.
4. In the wizard dialog box, choose the object to which you want this condition to apply:
• The running workflow The condition will check attributes of the dm_workflow
object.
• The last completed work item for the activity The condition will check attributes
of the dmi_workitem object.
• This input package’s documents The condition will check attributes of the
dmi_package object that you select from the drop‑down list. If this option is
grayed out it is because no packages are attached to the activity.
5. Click Next.
The next page of the wizard appears, and your selection is added to the Condition
box at the top of the dialog box.
6. Choose the attribute whose value you want to use in the condition.
The drop‑down list includes the attributes for the object type you selected at step 4.
If a drop‑down list labeled Repeating attribute, choose or type an index appears, it
means that the attribute you chose is used in more than one place in the workflow.
Indicate which index value to use in this condition by selecting one of the four
options in the list, or by typing a valid index value.
7. Click Next.
The next page of the wizard appears, and the attribute information is added to the
Condition box at the top of the dialog box.
8. Specify the test you want to perform on the selected attribute.
Choose a logical comparison operator from the drop‑down list and enter a
comparison value in the text box. The data type for the selected attribute is shown
below the box.
9. Click Next.
The complete transition condition appears in the Condition text box.
10. Decide whether to add another clause to this condition.
• If you want the transition condition to include an additional clause, appended to
the condition you have just defined with an AND, select Add another clause
to this condition.
3. To change the size of the graphic representing the activity, select a percentage from
the Image Size drop‑down list.
The percentage is the percentage of the actual size of the graphic.
4. Set the font and style used to label the activity in the template.
a. Select a font from the Label Font list.
b. Select a point size from the Point Size drop‑down list.
c. To set the font style of the label, check or de‑select Bold and Italic.
5. Choose whether to label the activity with its activity Name or the Performer.
Please note that error messages, such as any that occur when you validate the
template, will refer to activities by their names. If you label activities with the
performer name, you might want to temporarily change this setting to Name in
order to locate the activity.
6. Click Apply to save your updates without closing the Activity Inspector, or click OK
to save your updates and close the Activity Inspector.
The flow lines that connect the activities in a workflow represent the flow of the document or
object that the workflow routes. Flows enable the movement of packages, their properties, and
dependencies between the connected activities. See Workflow Templates and Associated Objects,
page 12 for a description of flows. For each line, you need to identify what packages are sent to the
next activity; see Defining Packages, page 19 for more information.
Once you have added a flow to the template, you configure it using the Flow Inspector. You access the
Flow Inspector by double‑clicking on a flow in the workflow template editor pane, or by selecting one
or more flows and choosing Flow Inspector from the Tools menu. There is also a Flow Inspector
icon on the toolbar.
The Flow Inspector has two tabs, each corresponding to one aspect of flow configuration:
• The Packages tab enables you to specify what documents get passed along the flow; see Setting
Package Requirements, page 66 for details.
• The Display tab controls how the flow appears in the visual display of the workflow template;
see Changing Flow Display Settings, page 67.
The name of the flow you are configuring appears in the text box at the top of the Flow Inspector. If
more than one flow is selected, arrow buttons appear on either side of the text box, enabling you to
scroll through the selected flows. The settings you make apply to the flow whose name appears in the
box, unless you select the Apply to all selected option.
When multiple flows are selected, each tab in the Flow Inspector displays one or more check boxes
labeled Apply to all selected. When this check box is selected, Workflow Manager applies the
associated settings that is, those settings that appear to the right of the check box to all selected flows,
not just the one whose name appears in the text box at the top. For example, you can select multiple
flow and choose the same packages for all of them at once. Any settings for which the check box
is not selected apply only to the current flow.
Creating Flows
You connect activities using one of three Create Flow icons in the Workflow Manager
toolbar:
• To connect activities in a forward movement of data, click either the Create Single
Segment Flow icon or the Create Multi‑Segment Flow icon . The difference
between the two is visual: one draws a straight line to represent the flow between
activities, the other draws a line consisting of multiple segments.
• To connect activities in a backward movement of data, click the Create Reject Flow
icon . Reject flows represent the path taken when the user of an activity rejects the
object being processed.
See Workflow Templates and Associated Objects, page 12 for a description of the types
of flows.
2. Determine whether the flow line appears as a Single line straight between
the connected activities or as Multi‑segment lines with each segment running
horizontally or vertically.
Multi‑segmented lines in a flow are generally easier for users to follow.
3. Set the font and style used to display the names of the packages routed over the flow.
These settings are relevant only if you elect to display the package names in the
next step.
a. Select a font from the Label Font list.
b. Select a point size from the Point Size drop‑down list.
c. To set the font style of the label, check or de‑select Bold and Italic.
4. To label the flow with the names of the packages it routes, select the Show the names
of packages routed over this flow check box.
5. Click Apply to save your updates without closing the Flow Inspector, or click OK to
save your updates and close the Flow Inspector.
When you participate in a running workflow, you can display Workflow Manager to view the status
of the workflow. When you select View Instance from Workflow Reporting, Workflow Manager
displays a representation of the workflow template with a status bar under each activity showing
its current status.
The status of each activity is shown by the position and color of the box in the status bar:
Inactive
Failed
Halted
Active
Completed
If the workflow is based on a template you created, you can also use Workflow Manager to halt,
abort, or restart the workflow.
Halting Workflows
If you want to pause a running workflow without uninstalling its activities, you must
use the Halt command. When you halt a workflow, the server changes the state of all
dormant or acquired work items to D/A/P paused and changes the state of the workflow
to Halted. The running activities and current work items cannot change states and
new activities cannot start. For example, if a workflow is halted after a user acquires a
work item and the user completes the task and tries to mark the work item as finished,
the server will not accept the change. See Documentum Content Server Fundamentals for
information about these states.
Only the workflow supervisor or a user with superuser or sysadmin privileges can halt
a workflow. You cannot halt a workflow if any work items generated by automatic
activities are in the acquired state.
To halt a workflow:
1. Open a running workflow in Workflow Manager.
2. Select Halt from the Control menu.
To restart a halted workflow, select Resume.
Aborting Workflows
Aborting a workflow terminates the workflow.
You must be the workflow supervisor or a user with sysadmin or superuser privileges
to abort a workflow. You cannot abort a workflow if any automatic work items are in
the acquired state.
To abort a workflow:
1. Open a running workflow in Workflow Manager.
2. Select Abort from the Control menu.
Resuming Workflows
The Resume command is available only for workflows that have been halted.
Resuming a workflow returns any work items in the D/A/P paused state work items
to their previous state, changes the halted activity instances to the running state, and
changes the workflow’s state to running. See Documentum Content Server Fundamentals
for information about these states.
A choosing
aborting workflows, 70 automatic performers, 55
activities manual performers, 49
aligning, 31 copying activities, 30
choosing which to include, 14 creating
copying, 30 flows, 66
described, 12 workflow templates, 36
moving, 30
pasting, 30 D
performers, choosing, 14
default alias set, 53
repeatable, 57
define performer alias, 53
selecting conditionally, 22
delegation, 18
transition types, 21
deleting objects, 30
trigger condition, 20
display settings
activities palette
changing, 62, 67
changing activities displayed on, 27
Display tab, 62, 67
Activity Inspector, 47
draft state, 35
alias sets
default, 53
specific, 53 E
aliases extension, 18
using in workflow, 17
aligning activities, 31
Apply to all selected option, 47, 65
F
assign performers now, 51 Flow Inspector, 65
automatic activities flows, 12, 65
priority values, 18 creating, 66
valid performers, 55
automatic performers G
choosing, 48, 55
grid, snap to, 32
tasks, 48
C H
halting workflows, 69
changing
activities displayed on activities
palette, 27 I
display settings, 62, 67 installed state, 35
workflow template properties, 38 installing workflow templates, 41
workflow templates displayed on
Workflow Palette, 28
M T
manual activities tasks
aliases as performer, 17 automatic performers, 48
delegation, 18 manual performers, 48
extension, 18 Transition Condition Wizard, 60
valid performers, 14 transition conditions, 22
manual performers transition rules, 58
choosing, 48 to 49 Transition tab, 58
tasks, 48 transition types, for activities, 21
moving activities, 30 trigger conditions, 20
trigger events, 20
N
Notification tab, 20, 57 U
notifying supervisor, 20, 57 uninstalling workflow templates, 41
O V
objects validated state, 35
deleting, 30 validating workflow templates, 41
selecting, 31
W
P warning timers, 20, 57
packages, 12, 19 work items, 12
Packages tab, 66 Workflow Palette
page setup, 44 changing workflow templates
pasting activities, 30 displayed on, 28
performer aliases workflow templates
defining, 53 architecture, 12
Performer tab, 48 to 49, 55 changing properties, 38
performers creating, 36
automatic , 48, 55 described, 12
manual , 48 to 49 installing, 41
print preview, 44 printing , 43
printing workflow templates, 43 saving, 39
priority values, for activities, 18 states, 35
uninstalling , 41
validating, 41
R workflows, 9
resuming halted workflows, 70 aborting , 70
halting , 69
S packages, 12
resuming, 70
saving workflow templates, 39
Select Performer, 49, 55
selecting objects, 31 Z
snap to grid, 32 zoom options, 32
supervisor, notifying, 20, 57