OpenText Documentum Workflow Designer CE 22.4 - User Guide English (EDCPKL220400-AWF-EN-01) PDF
OpenText Documentum Workflow Designer CE 22.4 - User Guide English (EDCPKL220400-AWF-EN-01) PDF
Designer
User Guide
EDCPKL220400-AWF-EN-01
OpenText™ Documentum™ Workflow Designer
User Guide
EDCPKL220400-AWF-EN-01
Rev.: 2022-Oct-06
This documentation has been created for OpenText™ Documentum™ Workflow Designer CE 22.4.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com
One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.
Disclaimer
Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1 Introduction ................................................................................ 7
This guide describes how to use Documentum Workflow Designer to design and
configure workflows.
You can define a simple or complex business process using a workflow. You can
create workflows that have following information flow characteristics:
• Serial: Has activites that follow a specified sequence with only one activity
running at an instance.
• Parallel: Has activities that can run simultaneously at an instance.
The path that a document follows in a workflow depends on the result of activities
in a business process; for example, a purchase order could be routed to different
activities depending on whether the manager approves it or rejects it.
You can create generic workflow processes that can be used in different scenraios.
You can create a workflow where activity performer is mapped to an actual user
name at the runtime. For example, a typical business process for creating a new
document has five steps: authoring the document, reviewing it, incorporating the
reviews, getting approval, and publishing the document. The authors and reviewers
are different for different documents. Hence, instead of creating a separate workflow
for each document with the author and reviewer names, you can create a workflow
process with activity definitions that maps to the author and reviewer at runtime.
When you start a workflow, the server uses the workflow process (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 (tasks) and communicate
to the designated activity performer.
The following flowchart illustrates how the components of a workflow and runtime
instance work together. For more details about the object-level implementation of
workflow, see OpenText Documentum Server Fundamentals Guide.
2.1.1 Activities
Activities represent the tasks that make a business process. A workflow has three
types of activities:
• Initiate activity is the first activity in the workflow. A workflow process must
have only one initiate activity.
• Automatic or Manual activity is the intermediate activity between the initiate and
the end activities. A workflow can have multiple automatic or manual activities.
• End activity is the last activity in the workflow. A workflow process can have
only one End activity.
When an activity is initiated in the server, work items are created and a
communication is initiated to the activity performers. The work items contain the
packages that the user needs to work on and instructions to complete the task.
2.1.2 Packages
Packages are the objects on which a task is performed. A package is defined for a
business workflow process. By default, a package is available to all the activities in a
business process. You can configure whether a package is available to all the
activities or to a specific activity in the workflow process. You can define whether a
package is mandatory in a business process. If a package is mandatory, all the
activities should have the package in a workflow.
2.1.3 Flows
A flow connects two activities, defines the workflow, and enables the movement of
packages, their properties, and dependencies between the connected activities. A
single flow can handle multiple packages.
There are two types of flows: forward flows and reject flows. A forward flow passes the
packages from the current activity to the next activity in the 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. A reject flow is used to direct packages in a backward loop. For example,
sending a package from an Approve activity back to the Edit activity.
An automatic or manual activity has atleast one incoming flow and one out flow. An
Initiate activity has only one or more outgoing flow(s) and an End activity has only
incoming flow(s).
Each flow in a workflow must have a unique name. You can set the following
attributes for a flow:
• Label Styling
• Font Size
• Label settings such as customizing the label
• For automatic activities, what should be the priority? For more information, see
“Activity priority” on page 18.
• What packages are passed across the activites in the workflow? For more
information, see “Packages” on page 13.
• When does an activity start? For more information, see “Trigger conditions”
on page 19.
• Whether an activity requires notification or not? For more information, see
“Notifications” on page 20.
• What happens next in the workflow? For more information, see “Understanding
activity transitions” on page 20.
You can include an activity more than once in a workflow. For example, if you want
all documents to receive two rounds of review. The workflow can have 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 ensure that
only one instance of the activity is active in the workflow at a time. A workflow
cannot start an activity if a previous activity based on the same definition is still
running.
If you select the Workflow supervisor, Repository owner, or Performer from last
activitycategory, the actual user is defined by the category. For example, a workflow
has only one workflow supervisor and the repository has only one repository owner.
If you select Specific group category, you can provide a group name when you
create an activity. In case of alias, the performer is selected at the runtime. The same
options apply to theGroup from Alias Set or User from Alias Set categories, except
that you provide the name of a group instead of an individual user.
For the Group from Alias Set and User from Alias Set categories, you provide the
names or aliases for a list of multiple users.
The server resolves aliases at runtime by searching one or more alias sets to find the
alias and the corresponding value. An alias set is an object that defines a list of
aliases and the corresponding actual values. You can create alias sets in
Documentum Administrator, for more information, see OpenText Documentum
Administrator User Guide.
When an alias is defined as the performer for an activity, you can specify that the
server resolves the alias:
When an automatic activity is started, the activity is placed in the queue of a server
facility that runs periodically. The server runs the activities in the order of priority.
By default, it runs all queued automatic activities each time it is invoked. However, a
system administrator can limit the number of activities run in a batch. If the server
configuration setting max_wf_jobs is set to a low number and there are a large
number of queued activities with high priority, a lower priority activity is moved
down in the queue.
You can configure priority of an activity to Low (Blue), Medium (Yellow), or High
(Red). For more information, see “Setting activity definitions” on page 54.
2.2.5 Packages
A package is attached to a business process and is available to all the activities in the
process. You attach a package to a workflow process in the Process Properties. A
package is an object that is processed and passed along the workflow.
In some business cases, the same package may pass through all the activities. For
example, a workflow for reviewing and approving purchase orders passes the same
purchase order document as a package to all the necessary activities.
In some busniess cases, an activity may result in a completely different package. For
example, suppose an activity accepts a personnel action notice. The performer (an
HR employee) must file the notice, then send a different form to the accounting
department.
• SysObjects
• Content
• Folder
• Cabinet
You can also define custom data types derived from one of the supported data
types. For more information about how to create a custom data type, see OpenText
Documentum Administrator User Guide.
If an activity has multiple incoming flows, you can specify the number of previous
activities that must complete before this activity starts. The trigger condition is the
minimum number of flows that must have delivered packages to the activity before
the activity starts. For example, if an activity has three incoming flows, you can
configure the activity to start when two of the three packages have arrived.
A trigger event is an event queued to the workflow. The event can be a system-
defined event, such as dm_checkin, or you can specify an event name, such as
promoted or released. However, because you cannot register a workflow to receive
event notifications, the event must be explicitly queued to the workflow using the
Documentum API. 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.
The same event can be used as a trigger for multiple activities, however, the event is
queued once for each activity. OpenText Documentum Server Fundamentals Guide
provides more details about defining and queuing events.
2.2.8 Notifications
When you configure an activity, you can set notification timers that send a message
to the workflow supervisor if there is delay in the activities. For example, you might
want the workflow supervisor to receive a notification if an activity is not started
within a specific time or if an activity does not complete within a specific time
period. When you create the activity, you can configure these notification timer
settings.
• A pre-timer that alerts the workflow supervisor if an activity has not started
within a specified time after the workflow starts.
• A post-timer that alerts the workflow supervisor if an activity does not complete
within a specified time after it starts.
The dm_WfmsTimer system administration job in the server checks the timers and
sends the notices to the workflow supervisor. The dm_WfmsTimer job is installed
with the system administration job suite. It is not installed in the active state. To use
the timers in workflows, make sure that the system administrator has activated the
functionality. The dm_WfmsTimer tool runs every hour. The workflow supervisor
receives warning notifications in the form of an item in the Inbox. For more
information, see “Configuring notifications” on page 56.
The transition type defines how the following activities are selected when an activity
is completed. There are three types of transitions:
• Select all connected activities: Packages are sent to all following activities linked
to the activity, including both forward flows and reject flows.
• Let performer select the next activities: The performer of this activity chooses
the activities to which the packages are sent at the runtime.
• Select next activities based on conditions: The server determines the activities
that receive packages at runtime by evaluating a set of transition conditions.
For a group activity, if the performer category is Specific group, you must specify
the number of members that must complete the task before the server considers the
overall activity complete and forwards the packages to the following activities. For
example, if five users receive a work item for an activity, you can specify that the
activity is complete when any three performers have completed the activity.
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, the performer can decide number of following activites that receive the
packages.
If a group of performers select the next activity, the performer category is Specific
group, and the transition option is Let performer select the next activity, you also
need to advise the server about how to combine the selection options for a
performer. When a group selects activities, it is possible that some performers might
select forward activities while others select reject activities. The server configuration
determines the activities to start. If you choose an conditional transition type, you
must define at least one transition condition for that activity.
For example, you could define an activity that routes a document 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:
If
(New version checked in) then Route to activity Evaluate Updates
Else
Route to activity Continue Approval
A transition condition should have an Else option that the server runs if none of the
transition conditions are met. The Else option should 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 “Configuring activity transition
rules” on page 56.
Documentum Workflow Designer is a web-based graphical tool for laying out and
defining your workflow. The Documentum Workflow Designer is divided into two
panes:
• Navigation pane or the left pane provides the option to navigate between
processes. It also provides options to import, export, migrate a process.
• Designer pane or right pane contains a canvas areas, Activity toolbar, and a
Function toolbar.
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.
You can also change to a single-pane view using the Pane button .
A configurable toolbar appears across the top of the window, providing quick access
to common commands.
• Processes menu
• Process list
• Import: Imports the selected processes from a package into the Documentum
Workflow Designer repository.
• Create From: Use this option to create a copy of the selected process. For more
information about how to create a copy of a process, see “Duplicating a process”
on page 45 section.
• Delete: Use this option to delete a process. For more information about how to
delete a process, see “Deleting a process” on page 44 section.
Icon Description
Process is migrated but not installed.
Process is installed.
Icon Description
Save the process.
Save
Open process properties dialog box.
Process Properties
Validate the process.
Vaidate
Install the process.
Install
Uninstall the process.
Uninstall
Cut the selected activity.
Cut
Copy the selected activity.
Copy
Paste the selected activity to the canvas.
Paste
Select all the activites.
Select All
Undo the previous action.
Undo
Redo the previous action.
Redo
Align the selected activities to the left.
Align Left
Icon Description
Align the selected activities to the center.
Align Right
Align the selected activities to the top.
Align Top
Align the selected activities to the middle.
Zoom In
Print the process diagram in the canvas.
Icon Description
Adds an automatic activity to the workflow
process.
Automatic Activity
Adds a manual activity to the workflow
process.
Manual Activity
Selection tool to select objects in the canvas.
Select
Icon Description
Defines flow of information in a workflow.
Straight Flow
Defines flow of information in a multilevel
process.
Multisegment Flow
Defines flow of information when an activity
is rejected.
Reject Flow
• To add objects to the workflow process, drag an activity or workflow from the
toolbar and drop it in the workflow process editor canvas.
• To move objects within the workflow process, select them and drag the object to
their new location. When you move an activity that has flows connecting it to
other activities, the arrows representing the flows move along with the activity.
Flows cannot be moved on their own.
• To remove objects from the workflow process, select the object and click the
Delete icon.
• To copy an activity, select the activity and click the Copy icon from the toolbar.
To add the new copy to the process, click the Paste icon from the toolbar.
• To see the actions that are available for a given object, select the object. A group
of icons appears at the location of the mouse cursor, showing the available
actions.
These actions require you to select the objects you want to act on.
1. Click the visual representation of the object in the workflow process editor
pane.
A dotted-line rectangle appears around the selected object, indicating that it is
selected. Click outside the object to de-select it.
2. To select additional objects, hold down the Shift key as you click each of the
objects.
If you do not hold down the Shift key, selecting one object automatically de-
selects any previously selected objects.
To align activities:
• Align left
• Align center
• Align right
• Align top
• Align middle
• Align row
• Align column
If you choose to align activities, the extreme most activity determines the
placement of the other activities; that is, the selected activities will align the
activity with most extreme position. For example, if you choose to align the
bottom edges of your activities, the lowest or bottommost activity determines
the placement of the other activities.
3. Click Save.
• 150%
• 100% (default)
• 75%
• 50%
• Last
Toggles between the current zoom setting and your previous zoom setting.
• Width
Sets the size of the workflow process so that its full width fits within the
visual dimensions of the workflow process editor pane.
• Fit
Magnifies or shrinks the appearance of your workflow process so that it fits
within the visible dimensions of the workflow process editor pane.
• Show grid lines
Displays the grid lines in the Workflow Designer canvas area.
• Snap to grid
Aligns the selected object in the Workflow Designer canvas with the grid
line
1. From the Documentum Workflow Designer toolbar, click the Print icon.
2. The Print Setup Dialog is opened to configure print properties. The following
table describes the available print properties:
Parameter Description
Page Format Select the page size to print the diagram.
• A3 (11.7 x 16.5 inch)
• A4 (8.3 x 11.7 inch)
• A5 (5.8 x 8.3 inch)
• US Executive (8.5 x 11 inch)
• US Legal (8.5 x 14 inch)
• US Letter (7.5 x 10.5 inch)
Page Orientation Select the page layout:
• Portrait
• Landscape
Margins Select the unit of measurement as inches
or centimeters and corresponding margins
in the selected unit.
• Top
• Bottom
• Left
• Right
3. Click Print.
The following table describes the various process properties in the General tab:
Parameter Description
Label Name of the workflow process.
System Name Respository system name.
Description Description of the workflow process.
Default Alias Set Default alias set for the process.
Create New Alias Set Creates a new alias set that is automatically
set as the default alias set for the process.
Workflow instruction Additional workflow instructions.
Audit Process Events Enables logging the process events in the
audit log.
Always show validate and install prompt Enables the validate and install prompt to
after saving the process appear after a process is saved.
The following table describes the various process properties in the Data tab:
Parameter Description
Add Package Adds a package to the workflow process.
Name Package name.
Type Package type.
Version Named version number, can be text or
numeric.
Visible across entire process The package is available to all the activities
in the process workflow.
This is a mandatory package Indicates that every activity should have that
package.
• Task
• Performer
• Trigger
• Notification
• Transitions
• Data
• Display
Label Description
Subject Basic description of the activity.
Instructions Special instructions for an activity.
Priority Specifies the priority of a task.
Label Description
Execution Setting
Perform this task as Performs this task on behalf of the workflow
supervisor, repository owner, or the
performer of the last activity.
Automatic Execution Parameters
Execute this method automatically Choose the action to automatically perform
from the Execute this method automatically
list. The actions in the list are workflow
methods.
Label Description
Timeout (sec) Specifies the time-out for an activity. The
valid range of time-out is from 0 to
2147483647 seconds.
Enable troubleshooting logging
Retry on timeout exception • Maximum tries: Specifies the maximum
number of attempts on timeout exception.
• Interval (min): Specifies the time
interval between each retry attempt.
On failure Specifies the action to perform when an auto
activity fails.
• Continue: Proceed to next activity.
• Terminate Process: Terminates the
process.
• Halt Process: Halts the process.
The following table describes the parameters in the Performer tab (manual activity):
Label Description
Performers
For more information about how to configure a performer for a manual activity, see
“Configuring performers for a manual activity” on page 51.
Workflow Supervisor The system selects the user designated as the
workflow supervisor when the activity starts.
By default, the user that starts the Process is
the workflow supervisor.
Repository Owner The system selects the user identified as the
owner of the active Documentum repository.
Label Description
Performer From Last Activity The system selects the performer from the
previous finished activity that satisfied the
trigger condition of the current activity. The
Performer from Last Activity is an alias for
the user that performed the last activity. It
can include multiple performers and users
from other previous activities. This
performer is identified at runtime because
the performer can be from a group.
Notes
• You can only select this performer
type if the activity does not have any
other performer type selected from
the list.
• If this performer type is already
selected in the list, then you cannot
select any other performer type
unless this performer type is
removed from the selected list.
Specific Group You select a group from the list of groups
from the connected repository. The server
assigns a work item to each performer in the
group at the runtime.
Group from Alias Set You select a group alias from an alias set as
the performer of the activity. The server
assigns a work item to each performer in the
group alias at runtime.
User from Alias Set You select a user alias from an alias set as the
performer of the activity. The server assigns
a work item to a member of a user alias at
runtime.
Processed By
Individual users and group member at the Sends one task to every user in each group.
same time
Label Description
Individual users and the first group member Sends one task to each user and one task to
to accept the task, at the same time each group. The group receives the task and
it is assigned to the first member of this
group who accepts the task.
Individual user or group member with Sends one task to the performer who has the
fewest tasks fewest pending tasks.
Individual users and the first group member Sends one task to the first individual user
to accept the task, in sequence listed in the performer list or the first group
member to accept the task. The task is sent in
the order of the list from top to bottom. After
this task is completed, another task is sent to
the second individual user or the first group
member to accept the task in the list.
Label Description
Trigger
All input flows are selected Indicates that the activity is triggered when
all the input flows are selected.
The number of inputs flows selected Specifies the minimum number of input
flows to trigger an activity.
And when the signal arrives Specifies the event to trigger an activity.
Label Description
Frequency
The activity can run more than once in a Indicates whether an activity can run
workflow multiple times in a workflow.
Label Description
Notify the workflow manager when
The activity does not trigger within Specifies the time limit within which an
activy should start.
The activity work is not finished Specifies the time limit within which an
activy should complete.
Label Description
When this activity completes Specifiy the logic to determine the next
activity. You can select from the following
options:
• Select all connected activities
• Let performer select the next activity
• Select next activities based on conditions
Complete the activity when
All performers should complete the task Indicates that an activity is marked complete
only when all the performers have
completed the task.
Number of performers complete the task Indicates that an activity is marked complete
only when the specified number of
performers have completed the task.
Label Description
Name Name of the package.
Type Type of the package.
Version Version of the package.
Visible Indicates whether a package is visible to all
the activities in a workflow process.
Mandatory Indicates that each activity in a workflow
process should have this package.
Label Description
Label Styling
Font Font type to use for label.
Point size Size of the font.
Label Description
Label Styling
Font Font type to use for label.
Point size Size of the font.
Show Label Indicates whether the flow label is displayed.
Show visible packages at destination activity Name of the package(s) available to the next
activity.
Custom label Display the custom text entered in the
corresponding text-field.
A Process represent the business procedure through which a given object or set of
objects flows. They define the overall workflow from beginning to end. You create
workflow processes in Documentum Workflow Designer that can be reused to
create individual workflow instances.
This chapter explains how to create processes, validate them, and install them.
To create a process:
1. Design the business process and the workflow that implements it.
For details about designing workflows, see “Defining workflow activities”
on page 13.
2. Click New Process from the Processes navigation pane.
3. Enter process name in the Label field. Set the process properties. For more
information about process properties, see “Setting process properties”
on page 42.
Note: A process name can have maximum of 127 characters and all the
special characters are allowed except for the percentage (%).
4. Click Save.
The Initiate and End tasks are added in the canvas for the new process.
5. Drag and drop activities from the Activities palette on to the workflow process
editor pane until you have one activity for each task in your workflow.
• To add a new manual activity, click Manual Activity icon from the
Activities palette.
• To add a new automatic activity, click the Auto Activity icon from the
Activities palette.
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, 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 to draw a line between the two activities.
You connect activities using one of three create flow icons in the Documentum
Workflow Designer toolbar:
2. Click the Process Properties icon. The Process Properties dialog box is
displayed.
3. On the General tab, select an alias from the Default Alias Set list to set it as the
default alias set. The Default Alias Set list displays the alias sets from
repository and those created in Workflow Designer.
3. In the Add Performer dialog box, select Group from Alias Set or User from
Alias Set.
4. From the Select Alias Sets list, select the alias set that is marked as Default
Alias Set.
5. From the Select Alias list, select an alias set user and click OK.
You must uninstall the process before you modify it. When you uninstall a process,
all the workflow instances are halted. You can create a copy of a process without
uninstalling it. Updating a process has impact on the active workflows, you must
update the process when there are no active workflows running .
The updated process must be validated and installed before you can start a
workflow based on it.
Field Description
Label Name of the process.
System Name Name of the system.
Description Description of the process model.
Default Alias Set Specify a default alias set for a process
from the list of alias sets.
Create New AliasSet Creates a new alias set that is
automatically set as default alias set for the
process in the Workflow Designer.
• Alias set label: Unique name for the
alias set.
• Alias set description: Description of the
alias set.
Workflow Instructions Instructions for the performer of the
activities.
Audit Process Events Specify whether to enable event auditing
for system events.
Always show validate and install prompts Specifies that the system should prompt to
after saving the process validate and install a process after it is
saved.
6. To select the package type, click Ellipsis for Type field to open Package
Type dialog box. To select an object type, perform one of the following steps:
• Click Filter to filter object types. Select an object type category and
click the Back arrow to return to Package Type dialog box. Select an object
type from the list and click Save.
• Search for an object type in the Search field and select an object type. Click
Save.
• Use the scroll-bar to locate an object type, select it, and click Save.
7. In the Version text-field, specify a version for the package or type CURRENT.
8. (Optional) Select the Visible across entire process option to make the package
visible to every activity in the business process.
9. (Optional) Select the This is a mandatory package option to make this package
as required by the process.
10. (Optional) To delete a package, select a package from the list and click the X
(cross) icon besides the Add Package option.
Note: If you do not save the changes to repository and close the browser, all
the changes to the workflow are lost.
Before validating, you need to save the process. If validation fails, error information
is listed in the Errors panel at the bottom of the canvas. To validate a process, click
the Validate icon.
If you need to make changes to an installed process, you must uninstall the process
first. When you uninstall a process, all the active workflows based on the process are
halted. After making the changes, validate and install the process again.
• If a process has workflow instances, only a user with sysadmin permission and
documentum_workflow_designer role can uninstall it.
3. Click OK to confirm.
Notes
• You cannot delete a process while another user is editing that process.
• The delete process may take a long time to complete for installed processes
and the Workflow Designer may become unresponsive during the delete
process.
• If a process has workflow instances, only a user with sysadmin permission
and documentum_workflow_designer role can delete it.
• If a process has no workflow instance, any user with the documentum_
workflow_designer role can delete it.
1. Hover the mouse pointer over the process to copy and click the ellipsis button
to open the context menu for the process.
3. Enter the process name in the Label field and click Save.
Note: A duplicate copy of the process with all the attributes is created
with the specified name and added under the process list.
1. In the Process Navigator pane, click Processes to open the Processes context
menu.
2. Click Export.
3. In the Export Process dialog box, select a process to export from the list of
processes. You can also select multiple processes to export. To select all the
processes, select Name.
4. Click Export.
5. Save the .pkg file containing all the selected processes and process
dependencies to the local system.
Notes
• When you export a process, only the process templates and definitions are
exported. Process dependencies such as packages, users, groups, aliassets,
and methods are not exported. You must export the dependencies as a .dar
file and install into the destination repository before exporting the processes.
A process installed before installing the dependencies is disabled for export.
• You can import the downloaded package to another repository.
• A process name can contain a maximum of 127 characters.
• Composer is not supported for exporting a Workflow Designer process.
1. In the Process Navigator pane, click Processes to open the Processes context
menu.
2. Click Import.
3. In the Import Processes dialog box, in the Add processes file area, click Click
here to add files.
Note: You can also drag and drop a package into the Add processes file
area to import the processes in a package.
4. In the File Upload dialog box, navigate to the location of the package file (.pkg)
and click Open. The package is analyzed and all the processes in the package
are listed in the dialog box.
Notes
5. Select the required processes from the list in the Import Processes dialog box
and click Next.
6. If you import a process with a name that already exists in the destination
repository, a conflict is flagged. Such processes are highlighted in red font in the
Import Processes dialog box. You can either override a process or rename the
process you are importing to resolve the conflict.
Note: The process must not be in the installed state for the override
functionality to work. You cannot override an installed process.
b. To rename the imported process, click the Edit icon, enter a new name for
the imported process and click the Tick icon.
Notes
Notes
• If you migrate a process that has transition conditions with attributes that are
not supported in Documentum Workflow Designer (for example, process
metadata), process validation does not capture such migration errors. In
Workflow Designer, transition conditions are validated when you open the
transition condition editor from the activity properties.
• While migrating a process, modifying the process may lead to loss of data.
1. In the Process Navigator pane, click Processes to open the Processes context
menu.
2. Click Migrate.
3. In the Migrate Processes dialog box, select the process to migrate and click
Next. You can select multiple processes for migration.
4. If you migrate a process with a name that already exists in the destination
repository, a conflict is flagged. Such processes are highlighted in red font in the
Migrate Processes dialog box. You can either override the process or rename
the process you are migrating to resolve the conflict.
b. To rename the migrated process, click the Edit icon, enter a new name for
the imported process in the Target field, and click the Tick icon.
• WFImport.log: Contains all the log messages related to import and export.
Note: You can access Documentum Workflow Designer logs for more
information about auto sync related errors.
3. In the Process Properties dialog box, on the General tab, select a different alias
set from the Default Alias Set list. When you change the default alias set, all the
performers attached to the task are reset.
4. In the Reset Performer Aliases dialog box, click Yes to reset the existing
performers for the activity or click Discard to cancel the process.
Activities are the tasks that comprise the workflow. Workflow configuration
involves configuring the various activities that form a workflow. You configure
activities using the Activity properties. You can access the Activity properties by
double-clicking on an activity in the workflow template editor pane.
The Activity properties dialog box has the following tabs for activity configuration:
• The Task tab sets the priority for automatic activities and provides instructions
for manual performers. See “Setting activity definitions” on page 54.
• The Performer tab enables you to select the activity performer and the actions a
performer can perform. For more information, see “Selecting performers”
on page 49.
• The Trigger tab provides configuration settings that determine when an activity
starts. For more information, see “Configuring activity triggers” on page 55.
• The Notification tab sets timers to notify the workflow supervisor if a task does
not start or complete within a specific time. For more informaiton, see
“Configuring notifications” on page 56.
• The Transitions tab settings determine the next activities in the workflow. For
more information, see “Configuring activity transition rules” on page 56.
• The Data tab is used to select a package for the activity. For more information,
see “Setting process properties” on page 42
• The Display tab configures the visual display settings of the workflow process.
For more information, see “Changing display settings” on page 59.
The name of the activity you are configuring appears in the text box at the top of the
activity properties dialog box. Each activity must have a unique name within the
process. You can change the activity name in the activity dialog box.
4. Click Add.
• Individual users and the first group member to accept the task at the same
time
• Individual users and the first group member to accept the task in sequence
Note: The options Individual users and the first group member to accept
the task in sequence is not available for performers from Specific Group
or Group from Alias Set. If you have added performers from another type
apart from performers from Specific Group or Group from Alias Set, this
option is available.
• Select Allow user to delegate task to enable the performer to pass the task to
another user or group. When you select this option, you must also specify
where the task is sent if the user to whom the performer delegates it is also
unavailable. The task can be forwarded to the workflow supervisor or
returned to the original performer.
• Select Allow performer to add additional performers to this task to enable
the performer to choose another user or group to also perform this task.
For details about the delegation and extension options, see “Defining activity
delegation and extension” on page 17.
7. Click another tab on the Activity properties dialog box to save the changes and
proceed or click OK to save the changes and close the Activity properties dialog
box.
To choose Performer From Last Activity as performer for the manual activity:
4. From the Select User type list, select one of the following options:
• Any User
• Any Group
• Specific Group > Select a Group.
• Group from Alias Set > Select an Alias Set > Select an Alias of type Group.
2. In the Add Performer dialog box, from the Select a performer who will work
on a task list, select Specific Group.
For more information about Specific Group as task performer, see “Performer
tab” on page 33.
3. From the Select the user parameter that will contain the performer search list,
select a group. You can also search or filter the groups using the search field.
To choose a performer from a Group from Alias Set for the manual activity:
2. In the Add Performer dialog box from the Select a performer who will work
on a task list, select Group from Alias Set.
For more information about Group from Alias Set as task performer, see
“Performer tab” on page 33.
3. From the Select Alias Set search list, select an alias set. If you have already
configured a default alias set, it is displayed as the first entry in the search list.
You can also search or filter the alias sets using the search field.
4. From the Select Alias search list, select an alias of group type.
5. Click Add. The selected alias is added to the Performers list with the alias_
set.alias_of_type_group naming convention.
To choose a User from Alias Set performer for the manual activity:
2. In the Add Performer dialog box, from the Select a performer who will work
on a task list, select User from Alias Set.
For more information about User from Alias Set as task performer, see
“Performer tab” on page 33.
3. From the Select Alias Set search list, select an alias set. If you have already
configured a default alias set, it is displayed as the first entry in the search list.
You can also search or filter the alias sets using the search field.
4. From the Select Alias search list, select an alias of user type.
5. Click Add. The selected alias is added to the Performers list with the alias_
set.alias_of_type_user naming convention.
To choose the user whose security access is used for an automatic activity:
1. Open Activity Properties dialog box and navigate to the Performer tab, choose
one of the following performers from the Select a performer who will work on
a task list:
• Workflow supervisor
The automatic activity uses the permissions of the workflow supervisor,
which by default is the user who starts the workflow.
• Repository owner
The automatic activity uses the permissions of the repository owner.
• Performer from Last Activity
The automatic activity uses the permissions of the user who performed the
previous activity in the workflow.
2. Select an action from the Execute this method automatically.
3. Specify the activity time-out inerval in the Timeout (sec) field.
4. (Optional) Select the Enable troubleshooting logging option to enable logging.
5. (Optional) Under the Exception handling section, select the Retry on timeout or
exception option if you want to rerun the activity after a timeout or an
exception.
• Select an option from the On failure list to specify the action to take when an
activity fails. The three options available are:
– Continue
– Terminate Process
– Halt Process
6. Click another tab in the Activity Properties dialog box to save the changes and
proceed or click OK to save the changes and close the Activity Properties
dialog box.
2. From the Performers list, select a performer and click the Delete icon
corresponding to the performer to delete it.
The performer is deleted and removed from the Performers list.
2. From the Performers list, select a performer and drag it upwards or downwards
to reorder the performer as required.
3. Enter instructions you want to include for the performer of the activity in the
Instructions field.
If the activity has more than one incoming flow, you can specify the number of the
previous activities that must complete before this activity starts. For example, if an
activity has three input ports, you may decide that the activity can start when two of
the three activities have accepted packages.
For more information about activity triggers, see “Trigger conditions” on page 19.
2. Specify the number of incoming flows that must be completed before this
activity starts.
• To start this activity only when all preceding activities are complete, select
the All input flows are selected option.
• To start this activity when some number of its preceding activities are
complete, select the The number of input flows selected option and enter
the number of preceding activities that must be complete before the activity
runs in the corresponding text-field.
When an activity has only one input flow, these options are not different.
3. To ensure a specific event occurs before the selected activity is run, select the
And when the event signal 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. OpenText Documentum Server
Fundamentals Guide provide more details about defining and queuing events
using the Documentum API.
4. To enable an activity to run more than once in the same workflow, select check
the This activity can run more than once in a workflow check box.
By default, all the activities are defined as repeatable activities. Activities with
multiple performers performing sequentially cannot be repeatable. 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. The server cannot start an
activity if a previous activity based on the same definition is still running.
• 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 job in DA.
The dm_WfmsTimer job 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.
2. To notify a supervisor when a task fails to start after a specific number of days
or hours, select the The activity does not trigger within check box, and enter
the number of days, hours, or minutes from the drop-down field.
4. Click another tab on the Activity properties to save the changes and proceed or
click OK to save your updates and close the Activity properties dialog box.
If an activity has only one outgoing flow, there is no need to set a transition
condition. The Transition tab is grayed out with the Select all connected activities
option selected.
2. Specify the action when this activity is completed using the When this activity
completes drop-down list:
• If you require all the performers to complete the task, select the All
performers complete the task option.
• If you require To complete the activity when a certain number of performers
complete the task, select the [ ] performers complete the task option and
enter the required number of performers in the adjacent text. If the number
you enter is greater than the number of performers who receive work items
for this activity at runtime, the server completes the activity when all
performers complete the task.
4. Specify the conditions that the server uses to determine the activities that
receive the packages.
See “Creating transition conditions” on page 58 for information about creating
transition conditions.
5. Click another tab on the Activity properties dialog box to save the changes and
proceed or click OK to save your updates.
Notes
• While creating or editing an If condition, you can use only the pre-
defined functions that are listed under the Functions tab. If a user-
defined function is used, the following error message is displayed.
Expression is invalid. Unsupported function name ...
• While creating or editing an If condition, you can use only the following
pre-defined Process Instance and Task:
– Process Instance
○ Created By
○ Created On
○ Process ID
○ Process Instance ID
○ Process Instance Name
○ Process Name
– Task
○ Activity ID
○ Activity Name
○ Created On
○ Performer
○ Priority
○ Task ID
○ Task Name
○ Task State
5. To create a transition condition using the context data, on the Context Data tab,
select an attribute from the Process Instance or Task list and click Ok.
Note: Use the Add Condition (+) icon to add another condition.
6. When all of the specific transition conditions are defined, select the activities to
which packages are routed if none of the conditions are met.
navigation area of the Workflow Designer. For more information about these icons,
see the “Process list” on page 25 section. You can configure the frequency of auto
sync job, by default the auto sync job is run once every day.
Note: We recommend you to configure the auto sync job to run every hour or
10 minutes in development and testing phase.
Auto sync feature raises a flag for the following events in the repository:
Notes
• If a group is deleted and then another group is created with the same name
as the deleted group, Auto Sync flags an error.
• If an object type, alias set, or a group is deleted from the repository and
added again in the repository, you must manually re-adopt these instance:
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 processes and objects” on page 12 for a description of flows. After you
have added a flow to the process, you configure it using the Flow Inspector. To open
the Flow Inspector dialog box, double-click the flow.
The Flow Inspector dialog box provides fields to control how the flow appears in the
visual display of the workflow process. For more information, see “Configuring
flows” on page 62.
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 you select this option,
Documentum Workflow Designer 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.
• To connect activities in a forward movement of data, click either the Single flow
icon or the Multisegment 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 Reject flow icon .
Reject flows represent the path taken when the user of an activity rejects the
object being processed.
See “Workflow processes and objects” on page 12 for a description of the types of
flows.
2. Set the font and font size specification for the package names routed over the
flow.
Note: These settings are relevant only if you select to display the package
names or custom information in the next step.
3. Select the Show label check box if you want to display the package name or
custom information for a flow.
4. Click Ok to save the changes and close the Flow inspector dialog box.
Building expressions
7.1 Tasks
7.1.1 Building an expression using the selector
The selector restricts the data available to build an expression to the context you
select.
1. Click Select.
c. Select a data item for the context. For example, select a business object
attribute.
d. Click OK.
a. Click Functions.
c. Select a function.
• When there is any existing Set Value subscription without any event trigger, the
subscription is moved to the Value expression.
• When there are multiple Set Value subscriptions without any event trigger, then
one of those subscriptions is moved to the Value expression.
7.2 Concepts
7.2.1 Expressions
You can build expressions that the system evaluates at runtime to compare and set
application data. An expression can include hard-coded literals and data from the
context in which you build the expression. The expression evaluates to a type that is
consistent with how you are using the expression. For example, use a Boolean
expression to return a value for a condition.
The following table describes a situation where you can build expressions:
Situation Description
Defining a condition for selecting next Returns a boolean value that will be used to
activity determine the next activity to run.
• If a long expression wraps to the next line in the expression editor, the expression
editor might indicate an error by underlining the part of the expression in red
even if the expression is valid. To clear the line, use the divider next to the
Artifact navigator to expand the width of the expression editor so the expression
does not wrap to the next line.
• Use curly brackets to include a multivalue attribute in the expression. For
example:
{1,2,3,4,5}
You can use operators, functions, and context data inside the brackets.
• To include a particular element of a multivalue attribute in an expression, use
square brackets to extract the element from the attribute. In the expression
customer.keywords[0] = = 'VIP', customer is the business object, keywords is
an attribute of the business object, and [0] is the element. The system treats the
attribute and element as a single value when evaluating the expression.
• Use single quotation marks for string literals. For example:
'dog'
7.2.2 Operators
The expression editor supports the operators listed in the following table:
Type Operator
Math +
-
/
*
Comparison >
>=
<
<=
==
!=
Boolean logic AND
OR
NOT
You can use the + operator to concatenate string, float, and integer data types in
expressions. The expression editor concatenates data types as follows:
7.2.3 Functions
WorkFlow Designer has built-in functions that you can use in expressions. Java-
based functions are evaluated in a server context.
The related topics define each of the functions available through WorkFlow
Designer and indicate in which context they are available.
February 1, 2012
7:28:29 PM - January
31, 2012 11:13:45 AM
differenceDays(create
Date(2012,2,1,19,28,29
),createDate(2012,1,31
,11,13,45))
returns 1
differenceDays(create
Date(2012,1,31,0,00,00
),createDate(2012,1,31
,23,59,59))
returns 0
differenceSeconds(cre
ateDate(2012,1,31,0,00
,
00),createDate(2012,1,
31,23,59,59))
returns -86399
getDay(DateTime Returns the integer value of the employee.hire_date = Yes
<date>) : Integer day of the month (1-31) used in January 30, 2012
<date>. 8:05:23 AM (or rather
the DateTime
representation of
January 30, 2012)
getDay(employee.hire
_date) returns 30
getHour(employee.hi
re_date) returns 8
getMinute(DateTime Returns the integer value of the employee.hire_date = Yes
<date>): Integer minute (0-59) used in <date>. January 30, 2012
8:05:23 AM (or rather
the DateTime
representation of
January 30, 2012)
getMinute(employee.
hire_date) returns 5
getMonth(DateTime Returns the integer value of the employee.hire_date = Yes
<date>): Integer month (1–12) used in <date> January 30, 2012
8:05:23 AM (or rather
the DateTime
representation of
January 30, 2012)
getMonth(employee.h
ire_date) returns 1
getUserTimeZone(): Returns the user time zone. getUserTimeZone() No
String returns GMT
getYear(DateTime Returns the integer value of the employee.hire_date = Yes
<date>): Integer year used in <date>. January 30, 2012
8:05:23 AM (or rather
the DateTime
representation of
January 30, 2012)
getYear(employee.hir
e_date) returns 2012
isValidDateTime ()
validates the
DateTime
representation of
3/15/2014 11:00:00
AM and returns the
True value for the
correct format.
toLocaleDateString Returns the localized string var date = new No
(DateTime date, representation of the date. Date(Date.UTC(2012,
String locale) : String 11, 20, 3, 0, 0));
toLocaleDateString(d
ate,'en-GB') returns
“20/12/2012”
// US English uses
date in the month-
day-year format
toLocaleDateString(d
ate, 'en-US') returns
“12/20/2012”
toLocaleTimeString(d
ate,'en-GB') returns
“03:00:00”
// US English uses 12-
hour time with AM/
PM
toLocaleTimeString(d
ate, 'en-US') returns
“7:00:00 PM”
toLocaleString Returns the localized string var date = new No
(DateTime date, representation of the date and Date(Date.UTC(2012,
String locale) : String time. 11, 20, 3, 0, 0));
toLocaleString(date,'e
n-GB') returns
“20/12/2012 03:00:00”
toLocaleString(date,
'en-US') returns
“12/19/2012, 7:00:00
PM”
The return value will be of the same type as the input parameters.
compare({ 'Peter',
'Mary', 'Paul'}, {'Paul',
'Mary', 'Peter'},
TRUE)
returns FALSE
and
contains({ 'Peter',
'Mary', 'Paul'}, 'Jane')
or it returns
'Customer is not a
VIP' if
customer.net_worth >
parameters.<namespa
ce>.vip_net_worth_m
inimum is FALSE.
ifThenElse(Boolean Returns <result1> if ifThenElse Yes
<condition>, Boolean <condition> is TRUE, (customer.net_worth
<result1>, Boolean and returns <result2> >
<result2>) : Boolean if <condition> is parameters.<namespa
FALSE. ce>.vip_net_worth_m
inimum, TRUE,
This ifThenElse FALSE)
function is
specifically for This example returns
returning a Boolean TRUE if
result. customer.net_worth >
parameters.<namespa
ce>.vip_net_worth_m
inimum is TRUE.
or it returns FALSE if
customer.net_worth >
parameters.<namespa
ce>.vip_net_worth_m
inimumis FALSE.
ifThenElse(customer_
refund_request.refun
d_or_exchange ==
'Cash
Refund',addDays(no
w(), -7),
addDays(now(), -30))
or it returns
December 31, 2011
8:05:23 AM (or rather
the DateTime
representation of
ifThenElse
(customer.credit_scor
e >= 750, 0.035,
ifThenElse(customer.
credit_score >= 700,
0.055, 0.0899))
or it returns 0.055 if
customer.credit_score
is greater than or
equal to 700 and less
than 750.
or it returns 0.0899 if
customer.credit_score
is less than 700.
Server
context:mod(Integer
<numberDividend><>,
Integer
<numberDivisor>) :
Integer
Accepts an integer
value as the first
argument.
Browser Returns the result of power(3.0,3) Yes
context:power(Float raising <num>* to the
<num>, Integer power <power>*. returns 27.0
<power>) : Float
Accepts a float value
Server as the first argument.
context:power(Float
<numberBase>, Integer
<numberExponent>) :
Float
random( ) : Float Returns a random random( ) Yes
float number
between 0 and 1. returns 0.1263
Browser Returns <num>* round(4.235, 2) Yes
context:round(Float rounded to the
<num>, Integer nearest float number returns 4.24
<precision>) : Float with the specified
<precision>* in
Server significant digits. A
context:round(Float tie-breaking situation
<number>, Integer is handled by
<precision>) : Float rounding up.
stringToFloat(String Returns the float stringToFloat('92.123' Yes
<number>) : Float representation of the )
string <number>.
returns 92.123
stringToInt(String Returns the integer stringToInt('92') Yes
<number>) : Integer representation of the
string <number>. returns 92
In the browser
context only one
function is provided
for both variations of
substring.
substring(String Returns the string substring('Loan Yes
<str>, Integer <start>, produced by Dates',0,9)
Integer <end>) : String extracting characters
from <str> beginning This example returns
from the position 'Loan Date'.
indicated by <start>
up to and not
including position
<end>.
In the browser
context, only one
function is provided
for both variations of
substring.
toLower(String Returns the string toLower('LOAN Yes
<str>) : String produced by AMOUNT')
converting all of the
characters in <str> to This example returns
lowercase. 'loan amount'
toUpper(String Returns the string toUpper('Due Date') Yes
<str>) : String produced by
converting all of the This example returns
characters in <str> to 'DUE DATE'.
uppercase.
The timezone is
based on the
timezone of the JVM
doing the evaluation.
dateToStringUTC(Da Returns the string Assume now( ) Yes
teTime <dateValue>, representation of returns the DateTime
String <format>) : <dateValue> formatted representation of
String according to the rules January 31, 2012
specified by <format> 11:37:23 AM, and the
using Universal user is in the Pacific
Time, Coordinated timezone.
(UTC).
dateToString(now(),'
This function only MMM dd, yyyy
supports date text in hh:mm a')
the English locale.
For example, This example
November is returnsJan 31, 2012
understood, but 11:37 AM.
novembre is not.
8.1 Concepts
8.1.1 Workflow migration
Use the Migration navigator to migrate legacy business processes developed using
Workflow Manager to the Documentum Workflow Designer. The main objective of
the workflow migration is to migrate important and complex parts of process design
automatically—expressions, data mapping, transition paths, process variables,
packages, endpoints, and performers. The migration process is seamless to ensure
that the process data mapping, expression, and process flow remains intact.
Workflow migration is supported from Documentum Repository.
In Documentum Workflow Designer, if an activity has a single output flow, the Let
Performer select next activity option is invalid. When you migrate a process to
Workflow Designer, if an activity has only one output flow configured with the Let
Performer select next activity option for transition, WorkFlow Designer converts
this option to Select all Connected Activities.
The following table lists the workflow properties that are supported and auto
migrated as part of migration process:
The following table lists the components that are supported as part of process data
migration:
The following table lists the components that are supported as part of process flow
migration:
The following table lists the components that are supported as part of activity
migration:
Previous Activity
Performer to choose
at runtime
>Individual users
and the first group
member to accept the
task, in sequence
Multiple sequential Previous Activity
performers > Have Performer to choose
performer(s) of at runtime > Group
activity determine from Aliasset :
the performer of this <aliasset name> or
activity > Performer Group from
alias(es) which will Aliasset : <name of
be resolved at run- group alias>
time from the alias
set Previous Activity
Performer to choose
at runtime
>Individual users
and the first group
member to accept the
task, in sequence