Document Um Process Builder User Guide Version 6.5

EMC® Documentum®
Process Builder
Version 6.5
User Guide
P/N 300-007-247 A01
EMC Corporation
Corporate Headquarters:
Hopkinton, MA 01748-9103
1-508-435-1000
www.EMC.com
Copyright © 2004 - 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 .......................................................................................................................... 11
Chapter 1 Understanding Business Process Design ............................................. 13
Introducing workflows ............................................................................... 13
Process templates and associated workflow objects ....................................... 16
Activities ............................................................................................... 17
Initiate activities ................................................................................. 18
Wait for message activities .................................................................. 18
Fault handler activities ........................................................................ 19
Process data ........................................................................................... 19
Enabling reporting for Business Activity Monitor (BAM) ...................... 20
Flows ..................................................................................................... 21
Planning workflow processes ...................................................................... 22
Choosing or creating activity templates .................................................... 23
Choosing activities ................................................................................. 23
Choosing performers .............................................................................. 24
Defining when the performer is determined ......................................... 26
Using aliases ...................................................................................... 27
Enabling delegation and extension........................................................... 28
Defining task subjects ............................................................................. 28
Adding a signoff requirement ................................................................. 29
Setting priority values ............................................................................. 30
Setting initial priority and aging of tasks .............................................. 30
How the system resolves the initial priority of a task......................... 31
How the system increases the priority of a task................................. 31
Setting static priority and aging logic for tasks ...................................... 32
Setting dynamic priority and aging logic for tasks ................................ 32
Sample priority module .................................................................. 33
Understanding process data .................................................................... 34
Understanding packages ..................................................................... 34
Understanding process variables ......................................................... 35
Understanding process parameters .......................................................... 36
Associating form templates with packages ............................................... 37
Setting trigger conditions ........................................................................ 37
Setting timers ......................................................................................... 38
Setting up notifications ........................................................................... 39
Defining activity transitions .................................................................... 40
Determining transition conditions ....................................................... 41
Chapter 2 Using Process Builder ........................................................................... 43

Process Builder design environment ............................................................ 43
Process Builder toolbar ............................................................................... 44
Setting process template preferences ............................................................ 45
Sharing process templates with Process Analyzer ..................................... 45
Setting process sharing folder locations ................................................ 46
Setting the port number for debugging inbound activities ......................... 47
EMC Documentum Process Builder Version 6.5 User Guide 3

Table of Contents
Managing activity template folders .......................................................... 47

Setting process template message preferences .......................................... 48
Updating process data in the BAM database............................................. 49
Activity Templates window ........................................................................ 50
Structured Data Types window ................................................................... 51
Creating structured data type categories and groups ................................ 51
Creating structured data types ................................................................ 52
Editing structured data types .................................................................. 54
Creating a complex structured data type from an XML schema ................. 55
Process template editor pane ....................................................................... 56
Aligning activities .................................................................................. 57
Replacing an activity............................................................................... 58
Snap to grid ........................................................................................... 58
Zooming in or out .................................................................................. 58
Adding notes ......................................................................................... 59
Viewing multiple processes by using tabs ................................................ 61
Navigator .................................................................................................. 61
Chapter 3 Working with Process Templates .......................................................... 63

Process templates overview ......................................................................... 63
Opening existing process templates ............................................................. 64
Creating process templates .......................................................................... 64
Setting process template properties.............................................................. 66
Managing process data ............................................................................... 69
Managing packages ................................................................................ 69
Managing process variables..................................................................... 72
Managing process parameters ................................................................. 73
Overriding activity-level settings ............................................................. 74
Configuring advanced options .................................................................... 75
Setting Access Control List (ACL) options ................................................ 75
Selecting a calendar for the process .......................................................... 77
Assigning a Process Parameter form ........................................................ 77
Creating correlation sets.......................................................................... 78
Enabling inbound web services ............................................................... 79
Saving process templates ............................................................................ 79
Validating process templates ....................................................................... 81
Installing process templates ........................................................................ 82
Modifying process templates ....................................................................... 83
Checking in, checking out, and versioning process templates ........................ 84
Deleting process templates .......................................................................... 87
Importing process templates ....................................................................... 87
Keeping shared processes in sync ................................................................ 88
Exporting process templates ........................................................................ 89
Printing process templates .......................................................................... 90
Setting page setup options ...................................................................... 90
Previewing printed processes .................................................................. 91
Chapter 4 Connecting Activities ........................................................................... 93

Creating flows ............................................................................................ 93
Changing flow display settings.................................................................... 94
4 EMC Documentum Process Builder Version 6.5 User Guide

Table of Contents
Chapter 5 Creating Sub-Processes ........................................................................ 97

Creating a sub-process using top-down modeling......................................... 97
Creating a sub-process using bottom-up modeling ....................................... 98
Setting sub-process properties ..................................................................... 99
Using the Timers tab ............................................................................... 99
Using the Display tab............................................................................ 100
Managing sub-processes ........................................................................... 100
Expanding and collapsing a sub-process ................................................ 100
Removing activities from a sub-process.................................................. 101
Adding notes to a sub-process ............................................................... 101
Deleting a sub-process and its contents .................................................. 101
Chapter 6 Working with Activity Templates ......................................................... 103

Creating activity templates ........................................................................ 104
Managing activity templates within folders ................................................ 105
Configuring activity templates .................................................................. 105
Validating and installing activity templates ................................................ 107
Chapter 7 Working with Activities ........................................................................ 109

Setting activity properties ......................................................................... 110
Selecting performers ................................................................................. 112
Associating a work queue priority module with an activity ..................... 114
Choosing manual performers ................................................................ 114
Assign performer(s) now .................................................................. 117
Have performer(s) of <activity> determine performer(s) of
this activity ...................................................................................... 118
Define performer alias (performer(s) will be assigned when
workflow is underway) ..................................................................... 119
Select performer based on conditions ................................................ 121
Select performer based on process data and process
parameters ....................................................................................... 123
Mapping process data to a work queue skill set ...................................... 124
Choosing automatic performers............................................................. 125
Setting activity triggers ............................................................................. 126
Setting warning timers .............................................................................. 127
Sending a notification ........................................................................... 129
Starting a process ................................................................................. 130
Running a Java method ......................................................................... 131
Delegating a task .................................................................................. 131
Completing a task................................................................................. 132
Setting activity transition rules .................................................................. 133
Creating transition conditions ............................................................... 135
Setting notifications .................................................................................. 137
Using the Notification Template Wizard ................................................ 138
Changing process data in an activity .......................................................... 141
Changing display settings ......................................................................... 143
Chapter 8 Mapping Process Data Elements ........................................................ 145

Understanding the data mapping tool ........................................................ 145
Adding or editing process data in the mapper ............................................ 147
Mapping package attributes ...................................................................... 147

Table of Contents
Adding message properties ....................................................................... 148

Adding an XML schema to activity content ............................................... 149
Adding a node based on a condition .......................................................... 149
Mapping the data ..................................................................................... 150
Using repeating attributes ..................................................................... 151
Input context .................................................................................... 152
Using data mapping functions ............................................................... 153
Understanding message correlation ........................................................... 157
Using correlation identifiers .................................................................. 157
Using correlation sets............................................................................ 158
Chapter 9 Debugging a Process Template ........................................................... 161

Understanding the process debugger ......................................................... 161
Using the process debug environment ................................................... 163
Preparing to debug the process.................................................................. 164
Adding breakpoints .............................................................................. 165
Starting a workflow in the debugger ...................................................... 165
Testing a process in the debugger .............................................................. 167
Using the Task Manager tab .................................................................. 168
Managing a manual task ................................................................... 168
Managing an automatic task.............................................................. 169
Debugging automatic workflow methods....................................... 170
Using the Process Data tab .................................................................... 170
Using the Console tab ........................................................................... 171
Using the Manage Workflow tab............................................................ 172
Appendix A Delivered Activity Templates ............................................................... 173

Content Services ....................................................................................... 175
Create Folder ....................................................................................... 175
Lifecycle Apply .................................................................................... 176
Lifecycle .............................................................................................. 176
Link To Folder ...................................................................................... 178
ECIS (Enterprise Content Integration Services) ....................................... 179
Flow ....................................................................................................... 181
Decision Split ....................................................................................... 181
Join ...................................................................................................... 182
Post Event to Parent Process .................................................................. 182
XSL Transformation .............................................................................. 183
Integration .............................................................................................. 183
BOF Module......................................................................................... 184
Database Inbound — Initiate and Step ................................................... 186
Database Read ...................................................................................... 188
Database Stored Procedure.................................................................... 190
Example Search Patterns ................................................................... 192
Database Write ..................................................................................... 193
DQL Inbound — Initiate and Step.......................................................... 195
DQL Read ............................................................................................ 197
DQL Write ........................................................................................... 197
Dynamic Web Service ........................................................................... 198
Invoking non-secure Web Services ..................................................... 199
Invoking secure Web Services ............................................................ 200
Mapping Web Service parameters .................................................. 201
Configuring the HTTP proxy server ............................................... 202
Configuring HTTP proxy parameters in Windows ...................... 202

Table of Contents
Configuring HTTP proxy parameters in UNIX-based

systems .................................................................................... 203
Invoking DFS (Documentum Foundation Services) services
from Process Builder ......................................................................... 204
Email Inbound — Initiate and Step ........................................................ 206
Fax Outbound ...................................................................................... 208
FTP Inbound — Initiate and Step ........................................................... 211
FTP Outbound ..................................................................................... 214
HTTP Inbound — Initiate and Step ........................................................ 215
HTTP Outbound .................................................................................. 218
JMS Inbound — Initiate and Step ........................................................... 220
JMS Outbound ..................................................................................... 222
Process Data Mapping .......................................................................... 223
SMTP .................................................................................................. 224
Invoke Process ..................................................................................... 226
Web Service.......................................................................................... 227
Web Service Inbound - Initiate and Step ................................................. 229
Sample..................................................................................................... 231
Sample Activity Template ..................................................................... 232
Set Queue Task Skill.............................................................................. 232
Queue Task Rework Decision ................................................................ 232
Deprecated activity templates.................................................................... 233
Start Sub-Process .................................................................................. 234
SMTP................................................................................................... 234
Publish to JMS Topic ............................................................................. 236
FTP...................................................................................................... 236
HTTP Post............................................................................................ 237
Send to JMS Queue ............................................................................... 237
Send to MQ JMS ................................................................................... 238
Lifecycle Apply (5.3x and earlier) .......................................................... 239
Lifecycle Demote .................................................................................. 239
Lifecycle Promote ................................................................................. 240
BAM ................................................................................................... 240
Observation Point ............................................................................. 241
Workflow Publish Events job ......................................................... 242
Appendix B Substitution Variables for Custom Activity Template

Properties ............................................................................................ 243
Appendix C Process Builder Conguration File ..................................................... 247

Table of Contents
List of Figures
Figure 1. Process templates capture business processes ................................................... 14

Figure 2. Components of a workflow ............................................................................. 16
Figure 3. Fault handler activity ..................................................................................... 19
Figure 4. Process Builder ............................................................................................... 44
Figure 5. Notes add text to the visual layout ................................................................... 59
Figure 6. Mapping an HTTP Inbound message to process data ...................................... 146
Figure 7. Manual activity in debugger ......................................................................... 163
Figure 8. Approval process without and with decision split activity ............................... 181
Figure 9. Review process without and with join activity ................................................ 182

Table of Contents
List of Tables
Table 1. Activity performer selection categories ............................................................ 24

Table 2. Activity template states and related icons ......................................................... 51
Table 3. Permission requirements for a process ............................................................. 75
Table 4. Permission requirements for process variables .................................................. 76
Table 5. Process template states and related icons.......................................................... 84
Table 6. Default sender and recipient based on event ................................................... 138
Table 7. Data Mapping Functions ............................................................................... 153
Table 8. Fields used to configure correlation ID ........................................................... 158
Table 9. Process debugger graphical elements and their purpose .................................. 164
Table 10. Process debugger buttons ............................................................................. 167
Table 11. Lifecycle template mappings ......................................................................... 177
Table 12. Supported Substitution Variables for Activity Configuration Fields ................. 244
Table 13. bpmconfig Parameters .................................................................................. 247

Table of Contents

Preface
This guide is intended to help users design and build business process templates by using EMC
Documentum Process Builder. Process Builder is the design center of the Process Suite, which enables
and supports all phases of the business process lifecycle.
Intended audience
This guide is intended for users who design business processes. It assumes familiarity
with basic EMC Documentum functionality, especially with the runtime workflow
features available through Documentum Webtop or TaskSpace.
Revision history
This section contains a description of this document’s revision history.
Revision history
Revision Date Description

July 2008 Initial publication
Support information
EMC Documentums technical support services and policies are available at the EMC
Powerlink website (http://Powerlink.EMC.com).
Note: You must register online at Powerlink before using it.

Preface
Related documentation
Process Builder is a design tool for business process templates. Workflows are created
from these templates at runtime The user documentation for Documentum Webtop or
TaskSpace includes information about running and participating in workflows.
In addition to this guide, the documentation set for Process Builder includes:
• EMC Documentum Process Builder Development Guide
• EMC Documentum Process Builder Installation Guide
• EMC Documentum Process Builder Release Notes
• EMC Documentum Process Builder Localization Guide

Chapter 1
Understanding Business Process
Design
This chapter introduces the basic concepts of Documentum workflow and business process design.
The following topics are included:
• Introducing workflows, page 13
• Process templates and associated workflow objects, page 16
• Planning workflow processes, page 22
Introducing workows
You use Process Builder to create process templates. A process template captures the
definition of a business process, enabling users to repeatedly perform the process.
Individual process instances generated from a process template are called workflows.
A workflow formalizes a business process such as an insurance claims process or an
engineering development process. A workflow consists of the following elements:
• A process template is the business process represented as a formalized workflow
definition.
Users can use the template to repeatedly perform the business process. Because a
process template is separate from its runtime instantiation, multiple workflows
based on the same template can be run concurrently.
• A process template consists of multiple activities.
Activities represent the tasks needed to complete the process, such as receiving an
email, reviewing a document, checking it into the repository, or approving it.
• Flows are the links between the activities, specifying the sequence of activities

Understanding Business Process Design
• Process data refers to the different types of data that flow through the process such
as a document, a form, process variables like part numbers or customer addresses,
or process parameters that enable administrators to modify a constant value for a
specific parameter throughout the process instance.
Process data is comprised of the process variables, process parameters and packages that
move through the workflow.
— Process variables are individual or grouped data types or execution data used
during the life of the process.
Different data elements that represent various types of customer information are
an example of process variables. See Process templates and associated workflow
objects, page 16 for further details about these workflow components.
— Process parameters are values that enable application administrators to modify
constant values that are used in a process. Process parameters can be used
in values that are fixed within a process such as escalation roles, transition
conditions, performer conditions, dynamic performer assignments, task
name, and task instructions. When an administrator changes the values of the
parameter from the Administration tab in TaskSpace, the value is updated in any
new process instances.
— Packages contain the object, generally a document or image file, passed between
activities so that work can be performed on it.
A loan application is an example of an object contained in a package.
Figure 1. Process templates capture business processes
Process templates 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 process template that can be used in many contexts. This is done by
including activities whose performers are identified by process data or aliases instead of
actual usernames. When process data or 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 assigned during the design process, you create one process template with activity
definitions that use process data to define author and reviewer names. Depending
on how you design the workflow, the author and reviewers can be chosen by the
person who starts the workflow, by the person who performs the previous activity,
automatically by the server when the activity is started, or based upon conditional logic
defined in the workflow.
You add activities to a process template by creating a blank activity or by selecting
the appropriate activity template for the type of task represented by the activity. The
activity template determines what configuration attributes are necessary for a particular
type of task, including attributes common to all activities (such as a name and a list of
performers) and custom attributes unique to a particular task. For example, the activity
template for activities that post files to a website would include an attribute containing
the URL to use for posting. Process Builder ships with predefined activity templates
representing typical activity types, and you can create custom activity templates that
exactly match your needs.
Both packages and activities can have an associated form template. The form template
defines the data entry fields that are displayed to the users performing the activity and
specifies how the entered data is stored in the Documentum repository. You create
forms using Documentum Forms Builder and associate them with processes using
Process Builder.
A workflow’s process template is implemented by Documentum Content Server as
a dm_process object. The definitions of individual activities in a process template are
stored in dm_activity objects. 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 process 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 (dmi_workitem), which are tasks that the
server adds to the inbox of the users who are the designated performers of the activity.
Figure 2, page 16 illustrates how the components of a process template and runtime
instance work together.

Figure 2. Components of a workow
Process templates and associated workow

objects
The Process Builder workflow process data model consists of a process template, a set
of activity definitions, a collection of data carried through the process, a set of flows
connecting the activities, and process data, including one or more packages representing
the documents being processed.

The process template defines the structure of a business process. It is composed of

activity definitions and a set of attributes that define the flows connecting the activities.
Activities
Activities represent the tasks that comprise the business process. Workflows can contain
several kinds of activities:
• Initiate activities are the first activities in the workflow.
• Start activities are connected to initiate activities.
• The end activity is the last activity in the workflow. A process template can have
only one end activity.
• Step activities are the intermediate activities between the start and the end. A process
template can have any number of step activities.
• Wait for message activities are receive activities that participate in asynchronous
communication with external applications and are designed to wait for a response
from the application.
• Fault handler activities enable you to specify an action to take if an automatic activity
fails.
An activity can be either manual or automatic. A manual activity is performed by a
person or multiple people. An automatic activity is performed by the system on behalf
of a user.
The attributes of an activity definition describe the characteristics of the activity,
including:
• How the activity is executed
• Who performs the work
• How the performer is assigned
• What starts the activity
• What triggers are necessary
• What is the transition behavior when the activity is completed
Activities can also have characteristics that are specific to the type of task they represent.
For example, an activity that sends documents to an external vendor would include an
attribute containing the vendor’s email address. The set of custom attributes associated
with an activity is configurable through the use of activity templates.
When the server starts an activity, it creates work items and adds them to the inboxes
of the users identified as the performers of the activity. These work items contain the
packages that the user needs to work on and instructions about the required task. The
server adds a queue item to the inbox, linked to the work item. The Documentum Content
Server Object Reference has more information on this subject.

Initiate activities
Initiate activities specify the conditions that begin a process instance. Initiate activities
can connect to any start activities and can be manual or automatic activities. You can
begin a workflow with one manual initiate activity, multiple automatic initiate activities,
or a combination of one manual activity and several automatic initiate activities. If the
initiate activity is an automatic activity, you must specify the channel configuration and
mapping rules to copy data from the message to the process data carried through the
process. If the initiate activity is manual, you can configure the activity to automatically
launch a form created in Forms Builder that starts the process.
For example, a loan application process flow can have multiple initiate activities. It can
be started with a manual initiate activity that automatically launches a loan application
form that a processor can complete during a phone-in application. The same process
can also have an automatic initiate activity that receives a loan application through
an email message.
You assign a form created in Forms Builder to the manual initiate activity on the
Properties tab of the Activity Inspector.
To include an automatic initiate activity, you could create an activity named Email Form
Received, where the email account is configured and details of the email header and
body are mapped to process data that has been defined for the process.
A manual initiate activity has only the Properties, Data, and Display tabs available
for configuring. Other initiate activities such as the Email Inbound - Initiate activity
template has all standard tabs as well as a tab to configure the email server connection.
Wait for message activities
A business process can participate in asynchronous communication with other external

applications. One application can send the other a message and wait for a response.
Process Builder uses correlation sets that consist of data unique to the message to match
the response to the original request. Any receive activity template can be configured
as a Wait for Message activity.
For example, in one activity of a purchasing process, a JMS message is sent to the
supplier requesting information on whether an item from a purchase order has shipped.
The message specifies both the vendor ID number and the item purchase order number.
Later, the vendor’s system replies with a shipping status message for purchase order and
the system uses the purchase order number and vendor ID carried within the message to
match the request to the response.

Fault handler activities
A fault handler activity is a secondary activity that is triggered when an associated

automatic activity fails at runtime. A fault handling activity can be either a manual or
automatic activity and can be linked from more than one automatic activity. A fault
handler activity cannot have an outgoing flow. It can only be used as a fault handler
in the process.
When a fault handler is assigned to an automatic activity, the fault handler runs every
time the method associated with the activity fails. So if you have configured the system
to retry the method at a specified interval and for a specified number of times, the fault
handler will run after each method failure until the system has run through the specified
number of retries.
Once the system has cycled through the specified number of retries, it will take a final
action based upon the settings in the performer tab and will either continue, stop, or
terminate the workflow. Selecting performers, page 112 gives more specifics on how
to set up the number of retries and the interval between retries for failed automatic
activities.
Figure 3. Fault handler activity
In the editor pane, you associate the fault handler activity with the automatic activity by
using the Assign Fault Handler flow button in the toolbar. The system identifies the fault
handler activity with a lightening bolt icon on the activity template and uses a dashed
line to link the fault handler activity with its associated automatic activities.
Process data
Process data refers to the different types of data that flow through the process such as:
• Documents
• Forms
• Process variables like part numbers or customer addresses

• Process parameters that enable administrators to modify a constant value for a

specific data element throughout the process instance
Exposing and leveraging process data enables users to see meaningful business data
when viewing their list of tasks such as the applicant’s name, the approval status of a
request, a loan amount, and so on. This information enables a task performer to work
more efficiently on the tasks in their inbox.
Process data is comprised of several types of data:
• Process variables that are defined in the context of the process.
These variables can be assigned default values at design time as part of the process
or can be initialized from a form that is associated with the process. Process variables
can be simple variables such as Boolean or string values or they can be complex
data types that are based on data types defined as Structured Data Types. See
Understanding process variables, page 35 for more information on process variables.
• Process parameters that enable application administrators to modify constant values
that are used in a process. Process parameters can be used in escalation roles,
transitions, selecting performers, and for other values that are fixed across a process.
When administrator changes the values of the parameter from the Administration
tab in TaskSpace, the value is updated in any new process instances.
Understanding process parameters, page 36 provides more information on this topic.
• Data sourced from workflow collateral such as package data or incoming data from
web services.
See Understanding packages, page 34 for more information on package data.
• Execution data sourced from the current workflow and work items such as workflow
creation date and the workitem runtime state. This information is maintained by the
process engine and are discarded when the workflow is finished.
Enabling reporting for Business Activity Monitor (BAM)
Process Builder can be used to configure which execution data to the BAM database
where it can be used to create BAM reports. Process designers can select specific process
variables, structured data types, and objects contained in packages to be used in BAM
reports.
To update business data from Process Builder in the BAM database, follow these steps:
• Activate the audit trail for a specific process.
The audit trail is the means by which reporting data is published to the BAM
database. Setting process template properties, page 66 provides instructions on
enabling the audit trail.

• Create structured data types with attributes that are selected for reporting.
Creating structured data types, page 52 provides instructions on creating structured
data types that can be monitored for BAM reporting.
• Select the packages to include in reporting from the process level or from the
individual activity.
Managing packages, page 69 and Changing process data in an activity, page
141 provide instructions on selecting packages for monitoring at the process level
and at the activity level.
• Select the variables to include in reporting from each activity.
Variables can be simple types (Boolean or string) or can be structured data types that
were selected for reporting when they were created. Changing process data in an
activity, page 141 provide instructions on selecting variables and structured data
types for monitoring at the activity level.
• Ensure that any changes to the business data you are monitoring have been updated
in the BAM database. Updating process data in the BAM database, page 49 provides
more information on updating process data in the BAM database.
The Documentum Business Activity Monitor Implementation Guide provides more details
on configuring BAM reporting.
Flows
Flows connect activities together in the process. They enable the movement of packages,
process variables, properties, and any dependencies that exist between the connected
activities.
There are three types of flows:
• Forward flows advance packages from an activity to the next activity in the normal
workflow such as moving a package from the Edit activity to the Approve activity.
• Reject flows determine what happens when the performer of an activity rejects the
task being routed. They direct packages in a backward loop such as sending a
package from the Approve activity back to Edit
• Fault handler flows determine what action to take if an associated automatic activity
fails. Fault handler activities, page 19 gives more specifics on this topic.
All step activities must have at least one flow coming in and one flow going out. An
initiate 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.

Planning workow processes

Each time you create a process template, there are design decisions to make. You must
decide what types of process data are involved in the process, which activities to include,
and how to structure the workflow.
First, review the business process you want to automate and identify the sequence of
activities required to complete it. Choosing activities, page 23 provides some guidance
for the decisions about activities.
For each activity in the workflow, you must make the following decisions:
• Is an appropriate activity template available?
Choosing or creating activity templates, page 23 explains how to decide whether
you need to create additional templates.
• Who performs the activity?
Choosing performers, page 24 describes this choice.
• For manual activities:
— Can the user delegate or extend the activity? Enabling delegation and extension,
page 28 describes these choices.
— What message should be displayed to the performers to provide information
about the work item? Defining task subjects, page 28 describes this option.
— Must the user sign off to complete the activity? Adding a signoff requirement,
page 29 describes this option.
— Should the user complete a custom form template in order to complete the
activity? Associating form templates with packages, page 37 describes this
option.
• For automatic activities, what is their priority?
Setting priority values, page 30 discusses priority values for automatic activities.
• What process data does the process carry throughout the flow?
Understanding process data, page 34 describes a process for Understanding
packages, page 34 and Understanding process variables, page 35 gives some
guidelines on adding process variables to the process flow. Understanding process
parameters, page 36 provides instructions for creating process parameters.
• If you will create reports based on the flow, what process data should be exposed
for reporting?
Creating structured data types, page 52 provides more information on making
process data available for reporting.

• When does the activity start?

Setting trigger conditions, page 37 provides information about this decision.
• What actions will the activity take if it has not been started or completed in a
reasonable amount of time?
Setting timers, page 38 outlines the available actions.
• For automatic activities, what actions should occur if a method fails?
Fault handler activities, page 19 provides more details on this topic.
• What notifications will this activity send out when system events occur?
Setting up notifications, page 39 discusses notification options.
• What happens next in the workflow?
Defining activity transitions, page 40 describes the transition options.
Choosing or creating activity templates

As you identify the business tasks necessary at each step in the process, you must
determine whether there is an activity template that supports each activity you will add
to the process. Many activity templates include one or more custom attributes that are
unique to a particular task. For example, the activity template for activities that send
email includes an attribute that contains the target email address. The template may also
provide default values for attributes common to all activities.
Process Builder comes with predefined activity templates representing typical activity
types. If your business process includes special-purpose activities to which none of the
available templates apply, you must create custom activities whose custom attributes
reflect the tasks performed with the activities. You may also develop a custom workflow
method to perform the required task. If you commonly use a particular type of custom
activity, you can create a custom activity template based on a custom activity.
Chapter 7, Working with Activities provides more details on creating activity templates.
Choosing activities
Each process template must have one or more initiate 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 process template.
The name is assigned when you add the activity to the process 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 Process Builder determine who
will perform the activity. Process Builder 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 work item to the inbox of the user
or users designated as the performer of that activity. For high-volume document
processing, you can add the work item to a work queue that many different users work
from. The Documentum Webtop User Guide Documentum TaskSpace Configuration Guideor
the provides more information about work queue management and performers.
The following table lists the categories from which you can choose a performer. Each
category is represented by an integer value. Only the first four options (0 through 3) are
available for automatic activities.
Table 1. Activity performer selection categories
User category How performers are selected

0 Workflow supervisor The server selects the user designated as the
workflow supervisor when the activity starts. By
default, the user who starts the workflow is the
workflow supervisor.
1 Repository owner The server selects the user identified as the owner
of the active Documentum repository.


2 Previous activity’s performer The server selects the performer from the previous
finished activity that satisfied the trigger condition
of the current activity. (See Setting trigger
conditions, page 37 for information about trigger
conditions.) This can include multiple performers
and can include users from other previous
activities.
3 Specific user You select an actual username when you create the
template.
4 All users in group You select a group name when you create the
template. At runtime, the server assigns a separate
work item to each group member.
5 Single user from group (First You select a group name when you create the
to acquire the work item) template. At runtime, the server assigns a new
work item to every group member. When one
member of the group acquires the work item, the
work items are removed from all other group
member’s inboxes.
6 Single user from group (Least You select a group name when you create the
amount of unfinished work template. At runtime, the server determines
items) which user in the selected group has the smallest
workload and assigns a new work item to that user.
Workload is measured as the number of dormant
and active work items.
8 Some users from a group You select a list of multiple users or aliases as the
performer of the activity. The server assigns a
work item to each of the users who are chosen as
performers.
9 Multiple sequential performers You select a list of multiple users or aliases as the
performer of the activity. The server assigns the
work item to the first user in the list of chosen users.
When that user completes the work item, the server
creates another work item for the next user in the
list of chosen users. This continues until all chosen
users have completed their work items.
10 Work queue The server assigns the work item to the work queue
you select. Users assigned to work on that queue
pull work items from the queue in priority order, or
the queue manager assigns the item to a particular
user. For more information about work queue


processing, see the Documentum Webtop User Guide
or the Documentum TaskSpace Configuration Guide.
Participants in a workflow have the option to mark themselves as unavailable for
workflow tasks. When the workflow runs, if the user selected as the performer is
unavailable, the workflow engine attempts to give the work item to the user’s delegated
user. See Enabling delegation and extension, page 28 for information about delegated
users.
For information about selecting performers for an activity in Process Builder, see
Selecting performers, page 112. For details about creating activities whose performers
are selected at runtime, see Defining when the performer is determined, page 26 and
Using aliases, page 27.
Dening when the performer is determined
When you create the activity, you must define the performer type and 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
• Based on conditional logic that you define in the activity.
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 more
flexible, since it lets decisions about performers be based on current circumstances
and business rules. Configuring a performer based on conditions is the most flexible
structure used to determine a performer.
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 is not 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 choose the actual person when you create
the activity. To have the actual person selected when the workflow runs, use an alias or
define conditional logic to determine the user. Using aliases, page 27 or Select performer
based on conditions , page 121 provide more details on these subjects.
When using an alias, the user 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, 6, or 10, except that you provide the name of a group or work queue instead of an

individual user. Provide a group or queue name if you are choosing it when you create
the activity. Use an alias if you want the actual group or queue 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 choose the performer, or use aliases
to have the performer chosen at runtime.
With user categories work queue, specific user, all users in a group, single user from a
group, some users from a group, or multiple sequential users, you can define conditional
logic in the activity that resolves the performer based on process data and other logic
that you define in a decision table. At runtime, the process engine evaluates the rules as
they have been set up and assigns a performer for the activity. Select performer based on
conditions , page 121 provides more information on this topic.
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 process template that can be used in 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 than create a different process 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.
The Documentum Content Server Administration Guide provides more details on alias
sets. You can associate alias sets with particular users, and in Process Builder 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
• Alias set associated with the user who starts the workflow
• Alias set for the performer of a previous activity
• 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 process template that contains the aliases
but not the names to which the aliases are mapped. See Choosing manual performers,
page 114 for details.
Enabling delegation and extension

When you create a manual activity, you specify whether the user performing the activity
is able to delegate the activity to another performer or extend the activity by identifying
an additional performer.
With delegation, the original performer does not complete the activity. With extension,
both the original performer and the designated additional performer complete the
activity.
If delegation is allowed, it can occur automatically or manually.
• Automatic delegation occurs when the server checks the availability of an activity’s
performer or performers, and determines that the person or persons is not available.
When this happens, the server automatically delegates the work to the users that
the original performer designated in the Workflow Availability dialog box. If there
is no user identified or that user is not available, the work item is either reassigned
to the workflow supervisor or returned to the original performer depending on a
configuration option set when the activity is designed.
• Manual delegation occurs when the work item’s performer, the workflow supervisor,
or a superuser elects to delegate the work item.
If extension is allowed, when the original performers complete an activity’s work items,
they can identify a second round of performers for the activity. The server generates
new work items for the second round of performers. Only after the second round
of performers completes the work does the server evaluate the activity’s transition
condition and move to the next activity. The second round of performers do not have the
option to extend the activity any further.
See Selecting performers, page 112 for information about setting these options.
Dening task subjects

The task subject is a message that provides a work item performer with information
about the work item. The message is part of the activity definition. It can include
references to one or more attributes whose values the server substitutes at runtime. For
example, suppose the task subject is defined as:

Please work on the {dmi_queue_item.task_name} task

(from activity number {dmi_queue_item.r_act_seqno})
of the workflow {dmi_workflow.object_name}.
The attached package is {dmi_package.r_component_name}.
Assuming that task_name is "Review", r_act_seqno is 2, object_name is "Engr Proposal",

and r_package_name is "First Draft", at runtime the user sees:
Please work on the Review task
(from activity number 2) of the workflow Engr Proposal.
The attached package is First Draft.
Task subjects can be up to 255 characters (before variable references are resolved) and
can contain references to the following object types and attributes:
• Any attribute of the dm_workflow object
• Any attribute of the dmi_workitem object associated with the current task
• Any attribute of the dmi_queue_item object associated with the current task, except
for task_subject.
• Any attribute of a dmi_package object
Note: The name of the document in a package is available only if you select the Store
document name to the package at runtime option in the Process Properties dialog
box (see Setting process template properties, page 66).
The reference must be enclosed in curly brackets. The object type name and attribute
name must be lowercase and must be separated by a period.
The server uses the following rules when resolving the string:
• The server does not place quotes around resolved object type and attribute references.
• If the referenced attribute is a repeating attribute, the server substitutes all values,
separating them with commas.
• If the constructed string (after variables are resolved) is longer than 512 characters,
the server truncates the string.
• If an object type and attribute reference contain an error. For example, if the object
type or attribute does not exist, the server does not resolve the reference. The
unresolved reference error appears in the message.
The resolved string is stored in the task_subject attribute of the task’s associated queue
item object. Once the server has created the work item, the value of the task_subject
attribute in the queue item will not change, even if the values in any referenced attributes
change.
Adding a signoff requirement

Many business processes require accountability. One way to provide accountability is to
require performers to sign off the tasks that they perform. When you define a manual

activity in Process Builder, you can specify that the performers must sign off in order to
complete the activity. Signing off requires the performer to type his or her password
to confirm that they performed the task.
Note: Content Server also supports electronic signatures and digital signatures as
ways to sign off tasks or the documents associated with a task. See the Content Server
documentation for details about these advanced sign-off options.
Setting priority values

For automatic activities, you designate a priority value that determines the order in
which the server runs the activity relative to other actions in its queue. You can set a
priority value for manual activities as well, which is reflected in the list of tasks found
in the performer’s inbox. An inbox is a user-specific area that lists the tasks currently
assigned to the performer.
When an automatic activity is started, the activity is placed on the execution queue for a
server facility that runs periodically. The server facility executes the activities in order of
priority. By default, it executes all queued automatic activities each time it is invoked,
but a system administrator can limit the number of activities handled each time the
facility runs. 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
may have to wait several invocations for execution.
See Setting activity properties, page 110 for information about setting the priority of
an activity.
Setting initial priority and aging of tasks
For most queue processors, work items appear in the inbox based on their priority. The
highest priority items are assigned to be worked on before lower priority work items.
Priority and aging settings are essential elements in the processing of work queue tasks.
When the system creates a new work item, the server identifies the task as a work queue
item and checks for logic to enable it to assign an initial priority to the item. After the
task is in the queue, an aging job increases the priority of the task based upon other logic,
which moves the task higher in the inbox until the task is worked on. Priority escalation
may trigger the queue administrator to redistribute tasks or reallocate resources between
work queues.
The priority level at which a task first appears and the speed at which it increases in
priority can be set either in the work queue policy or in the activity template for the task.
Using a work queue policy, the queue administrator or queue manager can specify the

initial priority of the task and the frequency and percentage at which it increments based
on different values you set up in the policy.
For more complex initialization and aging scenarios, you use Documentum Composer
to create a priority module that contains logic to dynamically calculate and update the
priority based on process data or other attributes that belong to the process. A priority
module can be associated with a work queue policy or a Process Builder activity.
How the system resolves the initial priority of a task
When the system creates a work queue task, the Process Engine determines the initial
priority of the task by using the following criteria in this order:
1. Priority module associated with the activity definition: If there is a priority module
associated with the activity definition, the system uses the getInitialPriority() method
of the module and sets the return value as the initial priority.
2. Priority module associated with the work queue policy: If there is a priority
module associated with the queue’s work queue policy, then the system uses the
getInitialPriority() method of the module and sets the return value as the initial
priority.
3. Work queue policy: If there is not a priority module associated with the task, the
system uses the initial_priority setting of the work queue policy object to set its
initial priority.
How the system increases the priority of a task
Each time that the dm_QmPriorityAging job runs, it increases the priority of all work
queue tasks by using the following criteria in this order:
1. Priority module associated with the activity definition: If there is a priority module
associated with the activity definition, the system uses the getIncrementPriority()
method of the module and uses the return value as the increment priority.
2. Priority module associated with the work queue policy: If there is a priority
module associated with the queue’s work queue policy, then the system uses the
getIncrementPriority() method of the module and uses the return value as the
increment priority.
3. Work queue policy: If there is not a priority module associated with the task, the
system uses the increment_priority setting of the work queue policy object to set
the increment priority.

Setting static priority and aging logic for tasks
Work queue policies enable queue administrators or managers to define the frequency at
which the tasks in a work queue are aged and the priority to which they are set initially.
When the system creates a work queue task, the task’s initial priority is set based upon
the initial priority setting from the work queue policy associated with that task. As
long as the task remains in the queue, whenever the dm_QmPriorityAging job runs, it
increases the priority of the task by the amount specified in the increment priority setting
of the work queue policy associated with the task. The Documentum Webtop User Guide
provides more information on setting priority and aging logic for tasks based on work
queue policies.
Setting dynamic priority and aging logic for tasks
There may be situations where both the initial priority and the amount that priority
increments both must be calculated dynamically. In these cases, you create a priority
module that the system uses instead of the work queue policy to set priority and aging
logic. A priority module can be selected when creating the work queue in Webtop or
TaskSpace or can be selected when creating the activity in Process Builder.
Associating a work queue priority module with an activity, page 114 provides more
details on assigning a priority module to an activity.
Process data can be used to set the initial priority and increase the priority based on
values in the workflow. For example, if a loan application belonging to a preferred
customer comes through a work queue, it can be immediately placed at a higher priority
value than a loan application from other customers. In addition, if the loan request is
for a greater amount or comes from a preferred loan broker, then the priority can be
increased at a higher rate, ensuring that the queue supervisor is alerted if the task is not
completed within a specified period of time. This kind of logic can be especially useful
to increase the priority of a task as it nears a deadline or some other time restriction.
The priority is increased more rapidly as the deadline approaches, pushing the task up
the queue at a higher rate.
To set the priority and aging values:

1. Create a priority module.
Create a Java class for the IWQTaskPriority interface and the IDfModule interface.
The IWQTaskPriority has two methods:
int getInitialPriority(IDfSession session, IDfWorkitemEx witem)
throws DfException;
int getIncrementPriority(IDfSession session, IDfWorkitemEx witem)

throws DfException;
The IDfModule interface does not have any method.

The Documentum Composer User Guide provides more details on building a module.
2. Using Composer, create a module that uses the class you created in step 1.
Ensure that you include bpm_infra.jar and dfc.jar in the client class path.
Sample priority module
/*
* Copyright © 1994-2008. EMC Corporation. All Rights Reserved.
*/
package com.documentum.bpm.priority.test;
import com.documentum.bpm.IDfWorkitemEx;
import com.documentum.bpm.priority.IWQTaskPriority;
import com.documentum.fc.client.IDfModule;
import com.documentum.fc.client.IDfSession;
import com.documentum.fc.common.DfException;
public class SamplePriorityModule2 implements IWQTaskPriority, IDfModule {
/**
* This example calculates priority from Process Data Variables.
* There are two Process Data Variables defined on the workflow template:
* - is_vip (boolean)
* - loan_info
* -loan_amount (int)
* - broker_class (String)
*/
public int getInitialPriority(IDfSession session,

IDfWorkitemEx witem) throws DfException
{
//
// If is_vip == true
// initial_priority = 10
// Else
// initial_priority = loan_info.loan_amount / 1000
//
Boolean is_vip = (Boolean) witem.getPrimitiveVariableValue("is_vip");

if (is_vip.booleanValue() )
return 10;
else {
Integer loan_amount = (Integer)witem.getStructuredDataTypeAttrValue
("loan_info", "loan_amount");
return (loan_amount.intValue() / 1000);
}
}

public int getIncrementPriority(IDfSession session,

IDfWorkitemEx witem) throws DfException
{
//
// If loan_info.broker_class = "A"
// increment_priority = 10
// Elseif loan_info.broker_class = "B"
// Else
//
String broker_class = (String) witem.getStructuredDataTypeAttrValue

("loan_info", "broker_class");
if (broker_class.equalsIgnoreCase("A"))
return 10;
if (broker_class.equalsIgnoreCase("B"))
return 5;
else
return 0;
}
}
Understanding process data

When you define a business process, the data that is managed in the flow needs to be
represented in a meaningful way. The data in a flow can be either a workflow variable, a
process variable, or a package that is associated with the flow.
Process data refers to the different types of data that flow through the process such as a
document, a form, or process variables like part numbers or customer addresses. There
are two main types of process data that you can define in a process: package data and
process variables. Both of these types of data must be defined at the process level to be
used in an individual activity within that process.
Understanding packages
Packages are the objects on which activities perform their work. A package can be a
document, a form, or other data that is associated with an activity. You list all of the
packages handled by a process object as part of the process properties, then specify for
each activity which of the packages it works with. An activity can handle multiple
packages. Each package can have a form template associated with it, defining the user
interface that the activity performers see when working on the package.

When you define a business process, you identify what objects the workflow handles.
An object, such as a document or an image, that is processed by a workflow is a package.
The package represents the content that the activities work on. An activity can work
with one or more packages.
To define a package, you identify the item to process with the workflow. You also have
the option to choose a form that the performer of the activity working with the package
uses to perform the task.
An activity can do the following things with a package:
• Make no changes to the package.
• Modify the package and save it as a new version in the repository.
• Introduce a new package into the workflow, not forwarding the package it received.
• Modify an attribute associated with the package.
In many workflows, all activities work on the same package or packages. For example,
a workflow for reviewing and approving purchase orders will use the same purchase
order document as a package for all the necessary activities.
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.
The user 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 Process Builder, you accomplish
this scenario by configuring the activity to forward the same packages it receives, but
forward a different version. You can specify the version by 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
a different form to the accounting department. In Process Builder, you can configure an
activity to accept certain packages as inputs and pass along other packages as outputs.
For information about configuring flows and packages in Process Builder, see Changing
process data in an activity, page 141.
Understanding process variables
Process variables are instances of different types of data that flow through your
business process. These can be simple data types (a string, Boolean, or date) or they
can be complex data types—groups of logically related data such as purchase orders,
manufacturing items, and so on. Complex data types are defined in the Structured Data
Type window, where, as structured data types, they can be reused in multiple process
templates in a repository.

Default values can be set only in the simple data type. Complex data types have the
default values in the type definition.
The attributes of structured data types (process variables) can be identified to use in
reporting. The process engine exposes the elements so that reporting tools can consume
the data and create static reports and BAM reports. Process variables are defined for a
process using the Process Properties component.
Managing process variables, page 72 provides more information about defining process
variables for a workflow. Creating structured data types, page 52 provides more
information on defining structured data types for your repository.
Understanding process parameters

Process parameters enable application administrators to use the Administration tab
in TaskSpace to modify constant values that are used throughout a process. Process
parameters can be used in thresholds, deadlines, escalation roles, and other values that
are fixed across a process. When the administrator changes the values of the parameter
from the Administration tab, any new or currently running process instances use the
updated value.
Process parameters can be simple data types (string, Boolean, integer, float, or date)
and are defined within the process template, and are specific to that template. Unlike
process variables, process parameters cannot be shared or reused in multiple process
templates in a repository.
For example, an application administrator may need to make changes to performer
values to respond to different business requirements. The process designer creates a
process template that includes a process parameter approver1 and creates a constant value
of manager. Once the process is complete and installed, the application administrator
can open the process template from the Administration tab in TaskSpace, and use the
associated Process Parameter form to change the value of approver1 from manager to
another performer. All new workflows will use the updated value.
Process parameters can also be used in mappings as process data from the source (left)
side of the data mapper. A process designer can create a mapping to change the recipient
for an email notification by creating the process parameter recipient2 that has a value
of sam_smith@yourcompany.com. The process parameter appears on the source side of
the data mapper in the activity template and is available for mapping. Later, once the
process is installed and running, the application administrator can open the process and
change the email recipient by typing a new value in the Process Parameter form.
Managing process parameters, page 73 provides more information about defining
process parameters in Process Builder.

Associating form templates with packages

You can associate a form template with each package passed to a manual activity. A form
template provides a custom user interface for the performer who viewing and entering
data. Depending on the configuration options, the performer may see the form when one
of the following occurs:
• A user opens the package from their Documentum inbox
• When viewing the properties of the package
The performer fills in the form to complete the activity or to update the package
properties. If the activity receives more than one package, the performer fills in the
forms associated with each package. If a package does not have an associated form, the
performer sees a default Task Manager dialog box.
You can associate a form template with each package when you add it to the workflow,
as described in Managing packages, page 69. You can also associate a form template with
a package when you configure a manual activity. A package can have only one form
associated with it at a time, but which form it is may change as the package moves
through the workflow. For example, the form displayed to a manager who approves a
purchase request may be different from the form completed by the person making the
request. The data underlying the two forms is the same, but the user display is different.
When configuring an activity, you can set the form template used for that activity to be
different from the form template associated with the package at the business process
level.
To associate a form template with a package, the form template and the package must
have the same underlying data model. When you are choosing forms, Process Builder
displays only those form templates whose data model matches the data type selected for
the package. If you select the form template before setting the object type of the package,
Process Builder sets the object type to match the selected form template’s data model.
For more information about form templates and forms, see the Documentum Forms
Builder User Guide.
Setting trigger conditions

A trigger is a signal that the activity can begin. Trigger conditions define the starting
criteria for an activity. At runtime, the server does not start an activity until the activity’s
trigger condition is met. The trigger condition can optionally include a trigger event
that must occur before the activity starts.
If the activity has more than one incoming flow, you can specify how many of the
previous activities 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 may decide that
the activity can start when two of the three have delivered their packages. The trigger
condition must be a value between one and the total number of incoming flows.
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 make up 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 by 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 application must queue the
event once for each activity. See the Documentum Content Server Fundamentals for further
details about defining and queuing events.
For information about setting an activity’s trigger conditions, see Setting activity triggers,
page 126.
Setting timers
When you configure an activity, you can set timers that take action 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 you might send a message to the activity performer if the activity has not
been completed four hours after its start.
Process Builder supports two kinds of warning timers for activities:
• A pre-timer takes action if an activity has not started within a designated amount of
time after the workflow starts.
• A post-timer takes action if an activity has not completed within a designated
amount of time after the activity starts.
When a workflow starts, the system creates pre-timers for all activities that have
pre-timers configured. At the same time, the system creates the task for the first activity
of the workflow. If it is an automatic activity, the workflow agent processes the task
immediately and moves the workflow to the second activity. When the second activity is
triggered, the server deactivates the pre-timer.
Depending on the nature of the activity, an expired timer can take one of these actions:
• Notification — Send a notification message to one or more people.
• Start Process — Launch a new workflow process using the current activity’s
packages.
• Run Java Method — Run an automated workflow method (available for users with
superuser privileges only).

• Delegate Task — Delegate the task to another performer.

• Complete Task — Automatically complete a manual task and move the workflow
forward to the next activity.
The first two actions are available for any activity timer. Any timer can invoke a method
as long as the activity performer has the necessary superuser privileges. The Delegate
Task and Complete Task actions are available only as post-timer actions for manual
activities that handle a single work item.
When a timer completes a task, it can optionally set the value of an attribute on one of
the process variables or packages in the workflow. The transition conditions for the
activity can test for this value, and depending on the attributes of a package or process
variables, the flow can be processed differently.
An activity can have multiple timers. You can also tell the server to repeatedly perform
the final timer action at a specified interval until the activity is completed.
By default, users receive warning notifications in the form of an item in their inbox
queue. However, you can configure the timer to send email notification using a custom
email template.
See Setting warning timers, page 127 for more information.
Note: Post-timers are not stopped when a task is halted or suspended and will continue
to count the time. For example, when a workflow task is stopped, the associated
post-timer is not stopped. The post-timer continues to take into account the time
designated for the task as though the task is in progress.
The task of checking the warning timers and performing the requested actions is
performed by the dm_WfmsTimer job. The dm_WfmsTimer job is installed with Content
Server and is activated when you install Process Engine.
When it is active, the default setting is for the job to run once an hour. To change the
frequency at which the job runs, use Documentum Administrator. See Documentum
Administrator User Guide for further information about changing the configuration of jobs.
Setting up notications
Content Server has the ability to monitor for particular events and to notify interested
users when the events occur. Events are specific actions applied to Documentum objects.
In the context of Process Builder, the relevant events are actions related to the workflow,
such as a user starting work on a work item or delegating a work item to another user.
When you configure a process template or an activity, you can associate custom email
message templates with several key workflow-related events. An email template is a
specially formatted document stored in the Documentum repository that defines the
subject and body of a notification email message. The template can include variables

whose values the server replaces at runtime. The delivered message includes contextual
information such as the name of the current performer or the package that is being
routed. If an event has an email template associated with it, any user who has registered
to receive notification of the event will get a message generated from the associated
email template. The Documentum Process Builder Development Guide gives more specifics
on creating custom email templates.
Note: The server generates and sends notification messages only when one or more
users has registered to receive notification of the event. The Documentum Content Server
Fundamentals provides information about registering for event notifications.
See Setting notifications, page 137 for information on how to set notification options.
Dening activity transitions

When an activity has multiple outgoing flows, you may want packages sent to all of
the following activities, or you may want packages sent to only some of the following
activities depending on the outcome of the activity. For example, you might give a
performer who reviews the design of a new form the choice of forwarding the design
to the next reviewer or sending it back to the designer for revision. You set up this
branching logic by creating flows from this activity to the two possible following
activities, then allowing the performer to choose which path to follow.
An activity’s transition type defines how following activities are selected when the
activity is complete. There are three types of transitions:
• Select all connected activities — The flow continues to all following activities linked
to this activity, including both forward flows and reject flows.
• Let performer select the next activities — The performer of this activity chooses
which following activities to send packages to at runtime.
• Select next activities based on conditions — Which activities receive packages
or process variables is determined at runtime by evaluating a set of transition
conditions that are based on process data found in the activity.
If the activity is a group activity — that is, if the performer category is 4 (All users in
group) or 8 (Some users from a group) — you specify how many members of the group
must complete the task before the server considers the overall activity complete and
forwards 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 of them
are done. Alternatively, you can require that all five users complete the task.
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 must 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 a conditional transition type, you must define at least one transition
condition for that activity.
Determining transition conditions
Transition conditions enable you to define activities that route tasks 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 moves the workflow forward 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 at runtime, which is
the first TRUE one.
Transition conditions must be Boolean expressions. Transition conditions are typically
used to check attributes of the package’s components, the containing workflow, or the
last completed work item. When the workflow package is an XML document, you can
create transition conditions that check the value of an XML element in the document.
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 133.


Chapter 2
Using Process Builder
This chapter covers information about using the design environment of Process Builder and includes
the following topics:
• Process Builder design environment, page 43
• Process Builder toolbar, page 44
• Activity Templates window, page 50
• Structured Data Types window, page 51
• Process template editor pane, page 56
• Navigator, page 61
Process Builder design environment

Process Builder is a graphical tool for laying out and defining your business process. The
Process Builder window is divided into two major panes:
• The left pane contains the Resource Navigator subsystem , which displays the activity
templates and structured data types that you can add to the process template.
• The right pane is the process template editor, which displays a graphical
representation of your process templates as you create them.
You can control the size of the two panes by positioning the cursor over the border
between them and dragging the border to a new position.
A pair of arrows appears between the tops of the two panes. To expand one of the panes
to fill the entire window, click the arrow pointing away from the pane you want to
expand. To return Process Builder to its two-pane view, click the arrow facing the other
direction, which now appears at the edge of the window. You can also open multiple
processes from the same repository in the process template editor, enabling you to view
and compare processes. Viewing multiple processes by using tabs, page 61 gives more
specifics on this topic.

In the Resource Navigator, you can click the title bar buttons that display the name of
each sub-window to minimize and maximize each of the windows.
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 process template and specify which portion appears.
The following figure shows the Process Builder design environment.
Figure 4. Process Builder
Process Builder toolbar

You control which icons appear in the toolbar by using options on the View menu.
Process Builder offers three collections of toolbar icons:
• Standard toolbar icons provide access to commands from the File and Edit menus

• Workflow toolbar icons enable you to create activities or flows and to display the
properties of workflow objects
• Display toolbar icons enable you to zoom in and out on the process template editor
pane
By default, the toolbar displays all three collections of icons.
To select which icons appear in the Process Builder toolbar:

1. From the View menu, select Toolbars.
A submenu appears with the name of each available group of toolbar icons. The
groups currently appearing in the toolbar have a checkmark next to their names.
2. Select the group you want to add or remove from the toolbar.
If you select an unchecked option, that group of icons is added to the toolbar. If
you select a checked option, the checkmark is removed and that group of icons is
removed from the toolbar.
Setting process template preferences

This section describes the following functions available from the Preference menu:
• Sharing process templates with Process Analyzer, page 45
• Setting the port number for debugging inbound activities, page 47
• Managing activity template folders, page 47
• Setting process template message preferences, page 48
Sharing process templates with Process Analyzer

Once a business process has been defined or altered in either Process Analyzer or Process
Builder, the process can be shared with the other application as an XML file (in XPDL
format) that is saved to a shared folder. Either application can then access the XML file
from the shared folder, open it, and begin working with the process. Setting process
sharing folder locations, page 46 provides details on setting up shared folders.
Note: Process sharing is enabled when both Process Analyzer and Process Builder are
installed on the same machine. To share processes when the applications are not installed
on the same machine, use the import and export options. Importing process templates,
page 87 and Exporting process templates, page 89 provide more information on those
options.

Use Get process from Analyst to open a process in Process Builder that was created or
modified using Process Analyzer. Use Share process with Analyst to make a Process
Builder process available to an analyst using Process Analyzer.
Automatic and manual activity types are preserved during the sharing process, although
definitions such as methods and timers must be added by the developer in Process
Builder. Packages are not included in the shared processes.
Additionally, if you share a process from Process Analyzer that has multiple end
activities, Process Builder adds an extra empty activity to which all the end activities
connect. Process Builder supports only a single end activity, whereas processes exported
from Process Analyzer may contain multiple end activities.
To share a process with Process Analyzer:

1. From the File menu, select Share process with Analyst.
The system places the XPDL file in the Process Builder shared folder where Process
Analyzer can access the process.
2. Click OK.
To get a process from Process Analyzer:

1. From the File menu, select Get process from Analyst.
The Get Process from Analyst dialog box appears showing all files that are in the
Process Analyzer shared folder.
2. Select the XPDL file that you want to open
3. Click OK.
Process Builder creates a new draft process template based on the Process Analyzer
process.
If activity layout location information is available, it is applied to the shared process
template. Otherwise, the system will use default layout and graphical display
settings. Since user interface information such as graphics or images is not included
in shared processes, you must re-create them in Process Builder.
Next, you must define execution information for the process using the Activity
Inspector.
See Chapter 7, Working with Activities for more information on defining execution
details for activities.
Setting process sharing folder locations
When processes are shared between Process Builder and Process Analyzer, the location
of the folders in which the processes are saved can be configured from either application.

Note: The process sharing folder locations are saved locally as preferences for the
Process Builder instance.
To set process sharing folder locations:

1. From the File menu, select Preferences.
The Preferences dialog box appears.
2. To set the shared folder location for Process Analyzer, click Select.
The Open dialog box appears.
3. Navigate to the directory in which Documentum is installed and create a folder for
the Process Analyzer XPDL files (for example, PA_Shared).
Generally, this is C:\Documentum.
4. Click OK.
5. Repeat steps 2 through 4 to set the shared folder for the Process Builder XPDL files.
Setting the port number for debugging inbound

activities
To be able to debug an inbound activity in the process debugger, you must specify the
port number in the Preferences dialog box.
Setting the inbound port number:

1. From the File menu, select Preferences.
2. In the HTTP/WebService Inbound Port Number dialog box, select the port number
that the debugger will use to debug inbound activities.
Managing activity template folders

You control which template folders display by using the Process Builder Preferences
dialog box. The preferences you set apply to your user ID only. Each user can set
different preferences. For information about controlling which activity template folders
appear in the Activity Templates window, see Managing activity templates within
folders, page 105.
The Preferences dialog box also enables the configuration of process sharing folder
locations if both Process Analyzer and Process Builder are installed on the same machine.

Sharing process templates with Process Analyzer, page 45 provides more information on
setting sharing folder locations.
To add a new activity template folder to the Activity Templates window:

1. Select File > Preferences or right-click an existing folder and select New.
The Preferences dialog box appears. The list box on the left displays the available
folders, and the list box on the right displays the folders currently being displayed
in Process Builder.
Note: Preferences are saved separately for each user. The list of folders may differ if
you log in as a different user.
2. To add a new folder to the list of available folders, click New and type a name for the
folder in the dialog box that appears.
The new folder appears in the right list box when you click OK in the dialog box.
3. Click OK in the Preferences dialog box to add the folders in the right list box to the
Activity Templates window.
To remove a folder from the Activity Templates window:

1. Select File > Preferences.
The Preferences dialog box appears. The list box on the left displays the available
folders, and the list box on the right displays the folders currently being displayed
in Process Builder.
Note: Preferences are saved separately for each user. The list of folders may differ if
you log in as a different user.
2. To remove a folder from the Activity Templates window, highlight its name in the
right list box and click << Remove.
The name moves to the left list box and is removed from the Activity Templates
window.
3. Click OK.
Setting process template message preferences

You can specify when the system prompts you to validate or install templates after
you save them.
To set process template preferences:

1. Select File > Preferences.

Note: Preferences are saved separately for each user.

2. Specify whether Process Builder should ask whether to validate or install templates
when you save them.
Before you can use a process template to create a running workflow, it must be
validated and installed. If you select the Always show validate and install prompts
after save checkbox, Process Builder displays prompts whenever you save the
template, and asks whether you want to validate and install the template. If the
checkbox is not selected, the prompts do not appear. You must validate and install
the template and its activities explicitly before you can create workflows from it.
3. To resume displaying the message, select Reset to show the warning messages.
4. Click OK.
Updating process data in the BAM database

The Update BAM Data Definitions page enables you to update selected process data
from Process Builder with the existing reporting data in the BAM database. This ensures
that there is consistency between the structure of the data in Process Builder and the
structure in BAM. This option updates the BAM business data with the process data that
you select in the Update BAM Data Definitions page.
Data definitions need only be updated when they are used for the first time or if there
has been a change in the data definitions. For example, if you modify a structured data
type to add a new reportable attribute or change the name of a reportable attribute,
you must update this new definition with BAM. In addition, if you create a new object
type that is used in a package, these package type definitions must be updated with
the BAM database.
BAM must be installed and configured correctly on the Content Server for updating
to occur.
Note: Process data must be enabled for reporting from within Process Builder to update
the reporting data in the BAM database.
To update structured data types:

1. Select Tools > Update BAM Data Definitions.
2. Perform one of the following:
• From the list of structured data types, select the types that you want to update
in the BAM database.
Only structured data types that have not been updated appear in the list box.
• Click Select All to update all structured data types that appear in the text box.

3. Click Update.
To update object types contained in packages:

1. To update the object types used in a package with the BAM database, clickUpdate
in the Object Types group box.
2. Click Close.
Activity Templates window

The Activity Templates window, along the left side of the Process Builder window,
displays predefined activity templates that you can add to the process template. Activity
template folders provide a way of organizing activity templates into related groups.
For example, the names of the folders might represent general categories of activities,
such as Approvals and Integration.
Each activity template represents a particular type of activity and may include special
properties that are specific to that type of activity. For example, an activity template for
sending email to external partners includes a property for the email address. See Chapter
7, Working with Activities for more information about activity templates.
You control which template folders display by using the Process Builder Preferences
dialog box. Managing activity template folders, page 47 provides details on setting
which folders display in the window.
Each activity template folder corresponds to a system folder in the Documentum
repository. The folders have the same name as the folders that reside in the system folder
System/Workflow/Activity Templates. The folder contains the dm_activity objects that
correspond to the activity templates in the folder.
To add an activity to your process template, drag the appropriate activity template from
the Activity Templates window to the intended location in the process template editor,
then set the activity’s properties. To view or edit the properties of the activity template,
double-click its icon in the activity template folder. See Chapter 7, Working with
Activities for details about setting the properties for activities and activity templates.
Using the shortcut menu, you can perform many of the same functions that reside on
the File menu of the toolbar such as save, remove, and create new folders or activity
templates.
Activity templates appear in the window in one of three states: draft, validated, and
installed. Each state is represented by an icon. Only installed activity templates can
be added to a process template. You can validate, install, and uninstall an activity
template in the Activity Templates window by using the functions in the shortcut menu.
Validating and installing activity templates, page 107 provides more details on this topic.

Table 2. Activity template states and related icons
State Icon
Draft
Validated
Installed
Structured Data Types window

The Structured Data Types window shows all of the structured data types that have been
defined in the repository. They are displayed in a hierarchical structure organized into
categories that you define based on their use in your business.
Use this window to add and delete structured data types by using the Structured Data
Types Wizard, to create or delete categories, and view the details of the structured data
types. You can also use this window to launch a wizard that enables you to create a
structured data type from an XML schema.
Creating structured data type categories and groups

You can organize process data into hierarchical categories of data based on how your
business is organized. Nested within these categories are groups and attributes that
make up the structured data types.
To add a category to the list of structured data types:

1. Right-click within the Structured Data Types window and select Add Category.
You can also add a category by selecting Change Categories in the Add Structured
Data Types Wizard.
The Select Category dialog box displays the tree hierarchy and the available nodes.
2. Type the name of the category that you are adding.
3. Highlight the node or the category within the tree to which you will add the new
category and type the name of the new category.
4. Click to add the new category.

5. Click OK.

To delete a category:
1. In the Structured Data Types window, highlight the category you want to delete.
2. Right-click within the Structured Data Type window and select Delete Category.
Note: If there are structured data types that exist within the category, the system will
not delete the category.
To create a group within a structured data type:

1. Click the Add Group icon
2. Type the name of the group.
Note: The group Name field supports only single-byte characters.
To update the contents of the Structured Data Type window:

1. Right-click within the window.
2. Select Refresh.
The window is updated with any new structured data types available within the
repository.
Creating structured data types

A structured data type is a way to represent business data that pertains to the flow of
your process and is generally comprised of the following data elements: Name, Type,
[Default Value].
There are two kinds of structured data types: simple and complex. A simple data type is a
single attribute such as a string or Boolean value. A complex data type is made up of
several attributes. For example, elements of an appropriation request can be organized
into the group Request with the attributes submitter_name, submitter_address, and
equipment_type. Within each structured data type, you can also organize attributes
into related groups that give visual structure to the data type. For example, within the
customer structured data type, you can have an address group that contains the attributes
for city and state.
Note: You must have Create Type user privileges to create a structured data type.
To create a structured data type:

1. In Process Builder, select File > New > Structured Data Type.
Alternatively, click the Create New Structured Data Type icon in the Toolbar or
right-click in the Structured Data Type window and select Add Structured Data
Type.

The Add Structured Data Type Wizard dialog box appears.

2. To change categories or to create a new category, click Change Categories and add
a new category to the node that you have selected. Creating structured data type
categories and groups, page 51 provides detailed procedures for creating categories.
3. Type a Name for the structured data type.
Note: Names must be less than 70 characters and must use single-byte characters.
The name cannot be edited once it has been saved.
To change a name, you must ensure that the structured data type is not in use, delete
it, and then recreate it with the new name.
4. Type a Display Name for the structured data type.
The text in the Display Name field appears in the tree view in the Structured Data
Types window.
Note: Display names must be less than 70 characters in length. The Display Name
field does support double-byte characters.
5. You can create a group of attributes by selecting the Add Group icon .
Note: You can create a group at any point in the process of creating structured data
types.
6. Type the name of the group.
Note: The group Name field only supports single-byte characters.
7. Click the add icon to add an attribute to the structured data type.
You can remove an attribute by clicking the remove icon.
8. Type a Name for the attribute.
Note: Names must be less than 70 characters and must use single-byte characters.
9. Type a Display Name for the attribute.
The text in the Display Name field appears in the tree view in the Structured Data
Types window.
Note: Display names must be less than 70 characters. The Display Name field does
support double-byte characters.
10. Type an optional description for the attribute.
11. Select a data type for the attribute.
Valid values are: string, integer, float, date, or Boolean.
12. Depending on the data type you have defined, type a default value, if necessary.
Note: Process variables that will be used in correlation sets should not have default
values. Process variables that have default values do not possess the unique attribute

characteristics required to match an incoming message to a single instance of a

process. Understanding message correlation, page 157 provides more information
on using correlation sets to map message content to process data.
13. Define other options for the attribute, as necessary.
• Select Repeatable to enable repeating attributes.
• Select Searchable to enable BAM to create indexes for the attribute.
Select Reportable to expose this type to the BAM database and use in BAM reports.
14. To update the data type definitions with BAM, select Update BAM Database tables
based on this SDT definition.
This sends the new data type definitions to the BAM database where they are added
to the tables used for reporting.
15. Click OK.
To view the details of a structured data type:

1. Right-click the data type in the Structured Data Types window.
2. Select View Detail from the menu or double-click the structured data type.
The Structured Data Types dialog box appears and displays the details of the
structured data type.
Editing structured data types

After you have created a structured data type and before it is used in a process, you
can change properties of the attributes, as well as add attributes and groups. After
a structured data type is used in a process, minimal data can be changed in order to
preserve the integrity of any currently running instances of the process.
Structured data types that are used in a process have the text In Use... in the upper-right
of the dialog box. If you click this text, the system launches the Process List dialog box
that shows the processes that are currently referencing the structured data types.
Attributes cannot be altered or deleted while in use. You can change the display name
and description of the structured data type. You can also add a new group or a new
attribute.
Note: When you edit a structured data type that is used in BAM reports, select the option
on the page to update the new definition with the BAM database.
To change an attribute of an in-use structured data type:

1. Open each process that uses the data type.
2. Uninstall the process.

3. Remove it as a process variable.

4. Edit the structured data type.
Note: When you add a new attribute and save your changes, that attribute can no
longer be altered.
Creating a complex structured data type from an XML

schema
You can search for and retrieve an XML schema (as an .XSD file) and import it into the
repository as a structured data type object, enabling you to use data from an external
application or from another part of your business.
Note: If the schema that you are using has many elements, it is best to import them one
element at a time.
To create a structured data type from an XML schema:

1. Right-click in the Structured Data Types window and select Create Structured
Data Type from XML Schema.
The Create SDT from XML Schema dialog box displays the category to which you
will be adding the structured data type.
2. To change categories or to create a new category, click Change Categories and add a
new category to the node that you have selected.
3. Select an XML schema file to use:
• Click to select the schema from the local file system
• Click to select the schema from the current repository and navigate to the
schema you want to import.
• Type a URL and click to fetch a schema name or get content from a website.
4. Select the type of data you want to import.
• Complex Type displays all of the complex data types including nested attributes.
• Element Type displays the container object along with the hierarchical
information and attributes associated with the data type.
5. From the list box, select the data type to use as a structured data type.
The related information for the data type appears in the Structured Data Types
group box.
6. You can edit the more generic fields of the attributes such as Display Name,
Description.
7. Define other options for the attribute, as necessary.

• Select Repeatable to enable repeating attributes.

• Select Searchable to enable BAM to create indexes for the attribute.
Select Reportable to expose this type when creating BAM reports.
8. Click Apply to add the imported structured data types to the Structured Data Types
window.
Process template editor pane

The process template editor pane is the area where you design the business process
flow. To define a business process, drag predefined activity templates from the activity
templates folders into the process template editor or create new manual or automatic
activities, connect them with flows, and then define the properties of the activities and
flows. See Creating process templates, page 64 for more information. You can also add
text notes to label areas of the template.
The procedures you follow to control the visual layout of a business process are similar
to those in other graphical layout software.
• To add objects to the process template, drag an activity from the activity template
folder and drop it in the process template editor pane. The object is added to the
template at the location where you release the mouse button. The toolbar also
provides buttons for adding (blank) activities and flows.
• To move objects within the process template, select and drag them 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 process template, select them and click the Delete
Selected Objects icon from the toolbar or select Delete from the Edit menu.
• To copy activities, select them and click the Copy icon from the toolbar or select
Copy from the Edit menu. To add the new copy to the template, click the Paste icon
from the toolbar or select Paste from the Edit menu.
• To see the actions that are available for a given object, select the object then right-click
it. A context menu appears at the location of the mouse cursor, showing the available
actions.
To select one or more objects in the process template editor pane:

1. Enter selection mode by selecting the Select Objects icon in the toolbar, by
right-clicking in the editor page, or by pressing the Escape key.
2. Click the visual representation of the object in the process template editor pane, or
click in an open area and drag the mouse to draw a rectangle around the objects.

A set of black boxes appears around the selected objects. Clicking the object a second
time clears it and removes the black boxes.
3. To select additional objects, hold down the Shift key as you click each of the objects.
Note: If you do not hold down the Shift key, selecting one object automatically
clears any previously selected objects.
4. To select all objects in the template, select Select All from the Edit menu.
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 to align.
You must have two or more activities selected to enable the Alignment options. See
Process template editor pane, page 56 for information about how to select activities.
2. Select Alignment from the View menu, then select the correct alignment from the
submenu.
The available alignment options are:
• Left — Align the left edges of the selected objects.
• Vertical — Align the centers of the selected objects vertically.
• Right — Align the right edges of the selected objects.
• Top — Align the top edges of the selected objects.
• Horizontal — Align the centers of the selected objects horizontally.
• Bottom — Align the top edges of the selected objects.
If you choose to align the top edges of your activities, the highest or topmost activity
determines the placement of the other activities. That is, the selected activities will
move up to be in alignment with the topmost activity. Similarly, if you choose to align
the bottom edges of your activities, the lowest or bottommost activity determines the
placement of the other activities. This is also true for left and right alignment.

Replacing an activity
You can replace an activity in a process template with another activity template by
dragging the new activity template from the activity templates folder and dropping it
onto the existing activity.
For example, after a process developer imports a Process Analyzer process into Process
Builder, the process developer may need to replace the imported generic activities with
some existing activity templates. The developer simply drags a new activity to the correct
location in the process and drops it into place, which deletes the former activity and
replaces it with the new activity. Replacing an activity in this manner preserves the links
between the activities but does not preserve configuration information such as timers,
transitions, mapping rules, and so on. Use Activity Inspector to reconfigure the activity.
Snap to grid
The snap to grid option provides added precision for aligning workflow activities and
flows.
Select Snap To Grid from the View menu.
When the snap to grid option is turned on, a grid appears in the background of the
process template editor. 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 affect 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, Process Builder zooms in or out by one magnification level.
To zoom in or zoom out on a process template:

1. Expand the list box next to the Zoom In icon, or select Zoom from the View menu.
2. Select one of the zoom levels:
• 200% (Highest magnification)

• 150%
• 100% (Normal viewing - default)
• 75%
• 50%
• Last — Toggles between the current zoom option and your previous zoom
setting.
• Width — Sizes the process template so that its full width fits within the visual
dimensions of the process template editor pane.
• Fit — Magnifies or shrinks the appearance of your process template so that it fits
within the visible dimensions of the process template editor pane.
Adding notes
You can add text to the visual layout of the process template through the use of notes.
Notes have no effect on the how the business process actually runs, but can help to
clarify the process for people looking at the template. You can place a note anywhere in
the template layout. By default, the note appears with a yellow rectangle surrounding
the text, but you have a variety of display options. The following example shows notes
in a variety of formats.
Figure 5. Notes add text to the visual layout

Process Builder gives you the option to suppress the display of any notes. From the
Tools menu, select Notes then Show and toggle the option on or off.
To add a note to a process template:

1. Click the Note icon in the toolbar .
When you drag the cursor across the process template editing area, the icon appears.
2. Double-click the process layout at the location where you will add the note.
The first click creates a yellow rectangle on the page, and the second click opens
the Note Inspector dialog box.
3. Enter the text for the note on the Note Content tab.
4. Click the Display tab.
As you make changes to the display settings, the Preview list box at the bottom of
the dialog box shows the current selections.
5. Set the font and style for the note text.
a. Select a font from the Font list.
b. Select a point size from the Point size drop-down list.
c. To set the font style of the label, select or clear Bold and Italic.
6. Set the alignment and color of the note text.
a. Select one of the radio buttons Left, Center, or Right to specify how each line of
the note text is justified.
b. Select the text color from the Text Color drop-down list.
c. Select the background color for the note from the Background Color drop-down
list.
The outer edges of the note remain yellow regardless of the background color.
7. Specify how transparent the note is.
Using the Transparency slider control, set the degree of transparency. If the
transparency level is set to 100 percent, the note is opaque and completely obscures
any objects behind it in the process template. If the transparency level is 0 percent,
the note is completely transparent.
8. Specify the appearance of the border of the note.
a. Select the Border checkbox to display a yellow border.
b. Select the BPMN style checkbox to display the note in the Business Process
Modeling Notation format for text annotations. A heavy border appears along
the left side of the note.

9. Click Apply to save your updates without closing the Note Inspector, or click OK to
save your updates and close the Note Inspector.
The note appears in the process layout.
10. Resize the note box if necessary.
To resize the note, select the note object and drag one of the black handles that
appears along its edges.
Viewing multiple processes by using tabs

When you are creating a process template, you may need to view another existing
process. Process Builder enables you to open and view multiple processes on different
tabs. As you open a process, it appears in a new tab, leaving any other open processes in
separate tabs in the Process Editor window.
Double-click a tab to expand the display of the process to fit the entire window.
Double-click it again to minimize the process window and once again show the Resource
Navigator. The current state of the open template appears in the title bar of the Process
Builder window. If there is unsaved data on the tab, the name of the process is preceded
by an asterisk (*).
Note: Multiple tab view is available only for processes that exist within the same
repository. You cannot open or view processes from more than one repository.
To close the tab that you are currently viewing, either right-click the tab and select Close,
select File > Close, or click on the tab itself.
Navigator
When you are defining a process template, the graphical representation can easily grow
beyond a size that can be completely displayed on the screen. The process 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.
To navigate to the portion of a template to display on screen:
1. Select Navigator from the View menu, or click the Navigator icon in the toolbar .
The Navigator window appears in the right pane of the Process Builder window. It
displays a reduced representation of the current process template with a gray box
around the section displayed on the screen.

2. To change which area of the process template appears on screen, drag the gray box
in the Navigator window so that it is over the area you want to appear in the editor.
The editor pane scrolls to the selected location when you release the mouse button.

Chapter 3
Working with Process Templates
This chapter explains how to create templates, validate them, and install them. The topics are:
• Opening existing process templates, page 64
• Creating process templates, page 64
• Setting process template properties, page 66
• Managing packages, page 69
• Saving process templates, page 79
• Validating process templates, page 81
• Installing process templates, page 82
• Checking in, checking out, and versioning process templates, page 84
• Deleting process templates, page 87
• Modifying process templates, page 83
• Importing process templates, page 87
• Keeping shared processes in sync, page 88
• Exporting process templates, page 89
• Printing process templates, page 90
Process templates overview

Process 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
process templates in Process Builder, then make them available for users to create
individual workflow instances from.
There are three possible states for process templates: draft, validated, and installed. The
current state of the open template appears in the title bar of the Process Builder window.
The title bar also shows if the template is checked out and the username of the lock
owner if the template is checked out by another user.

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.
Opening existing process templates

You can open an existing template in order to review it, revise it, or save it under a new
name as a starting point for a new workflow.
To open a process template:

1. From the File menu, select Open.
The Open Process Template dialog box appears.
2. Navigate to the process template by double-clicking the cabinet and folder names
until the template name appears in the list box.
3. From the View list, select Show Current Versions to see only the current version
of the templates in the window or select Show ALL versions to see a listing of all
versions of the templates.
4. Highlight the template name and select the checkbox to Check out process on Open
to edit the process. View is only available when another user has the template
checked out and opens a read-only copy of the template.
Note: If the template is checked out by another user, a lock icon appears by the
template name, and View will be the only available option for the template. When
you place the cursor on the name, the text displays the name of the user who owns
the lock on the template.
5. Double-click the template name, or highlight it and click Open.
Creating process templates

The following procedure 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 create a process template:

1. Design the business process and the workflow that implements the process.

For details about designing business processes, see Planning workflow processes,
page 22.
2. From the File menu, select New > Process.
The blank template will open in its new tab with the default initiate and end tasks.
Note: To create a template based on an existing template, open the existing
template and save it with a new name.
3. Set the template properties.
See Setting process template properties, page 66 for details.
4. Identify the process data that is associated with or created as part of the business
process.
See Managing packages, page 69 for details.
5. Add activities to the process template until you have one activity for each task in
your workflow.
• Click the manual activity icon or the automatic activity icon from the
toolbar, then click in the process template editor pane where you want the
activity to appear.
• Drag and drop an activity template from the Activity Templates window on
to the process template editor pane.
If the Activity Templates window does not include a template representing the
type of activity you need, you can create a blank activity by clicking the manual or
automatic activity buttons in the toolbar, or you can create a new template. Chapter
7, Working with Activities provides more specifics on creating a new activity.
6. Connect each activity to the activity that precedes it in the logical flow.
The first activity in the workflow must be connected to an initiate activity (it can
be any type of initiate activity), and the last activity must be connected to the end
activity.
To connect two activities, select one of the flow icons, move the cursor 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.
Process Builder draws a line between the activities.
You connect activities by using one of four Create Flow icons in the Process Builder
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.

• To connect a Fault Handler activity to the flow, click

Note: Connect all activities into the flow before configuring the individual activities.
Some configuration steps are based on the activity’s position in the business process.
7. Configure each activity.
See Chapter 7, Working with Activities for details about configuring activities.
Typically, the best practice is to configure the activities in the order they appear in
the business process, starting with the initiate activity. Configure all of the necessary
tabs for each activity. For example, remember to configure the Trigger tab for Join
activities and the Transition tab for Decision Split activities. (For the initiate activity,
only the Properties, Data, and Display tabs are available.)
8. Adjust the visual layout as necessary.
For information about the options available for laying out the process template
display, see Process template editor pane, page 56.
9. Save the process template.
See Saving process templates, page 79.
10. Validate the process template.
See Validating process templates, page 81.
11. Install the process template.
See Installing process templates, page 82. Once you have installed the template,
it is available to users.
Setting process template properties

You use the Process Properties dialog box to provide basic information about the
workflow you are creating. The original creator and current state of the process template,
including lock status, lock owner, and version, appear at the top of the dialog box in
display-only fields.
Note: To edit an existing template, you must uninstall the process. Modifying process
templates, page 83 gives more information on modifying an existing property.
To set process template properties:

1. From the Tools menu, select Process Properties, or click the Template Properties
icon on the toolbar .
2. Select the General tab.
Basic template information appears as read-only text at the top of the template.

3. To change the owner of the process template, click the Change button that appears
next to the owner name and select a user from the dialog box that appears.
You are the default owner of any templates you create. You can only change the
owner if you are a superuser. If you are not a superuser, the Change button is not
available.
4. Enter a description of the process template in the Description text box.
5. To change the default alias set for this process template, click the Change button
that appears next to the current alias set.
For more information about alias sets and how they are used in workflow, see
Using aliases, page 27.
• To choose an existing alias set, check Choose from existing alias sets, select the
name of the alias set from the drop-down list, and click OK.
• To create a new alias set, check Create new alias set, type the name and
description of the new alias set, and click OK.
• To remove the currently assigned default alias set, check Remove alias set.
6. Enter instructions for the performer in the Workflow instructions box.
For example, you can give performers of all activities specific instructions about
their tasks.
7. Turn on or off the template Audit Trail Settings by clicking the appropriate option.
When auditing is on, audit trail information is saved for each workflow created from
this template. For more information about auditing in Documentum software, see
the Documentum Content Server API Reference Manual.
Note: Auditing must be turned on to enable the system to publish reporting data to
the BAM database.
8. Specify whether to make the names of routed documents available for display
to users.
By default, the package routed through a workflow does not include the names of
the documents in the package for security reasons. If you want to store the document
names as part of the package, so that the names can be used in the instructions
passed to workflow participants, select the Store document name to the package at
runtime checkbox.
9. To send an email message when a timer expires or another event occurs, click Add in
the Select template for event notification group box.
You can also delete a template and event from the group box by selecting the row
and clicking Remove.
10. Select the Event that will trigger the notification from the drop-down list.
11. Select the Email Template that will be used by server to send notifications for the
event.

An email template is a document in the Documentum repository that defines the

structure of the notification message. See the Documentum Process Builder Development
Guide for information about the structure of a document that serves as an email
template.
a. To open an existing template, navigate through the file structure and select it.
b. To Create a new Email template, select the option and click OK.
c. The Notification Template Wizard appears, enabling you to create a new
email template dynamically. Using the Notification Template Wizard, page
138 provides instructions on using the wizard to create an email template.
12. To associate custom email messages with specific workflow events, select the events
and email templates in the box at the bottom of the dialog box.
You can set the messages that the server sends in response to process-related
events. Users registered to receive notification of the event will receive a message
constructed by using the email template associated with the event. Setting up
notifications, page 39 provides more information on this subject.
Note: You can also associate email templates with events as part of an activity
definition.
• If you associate the email template with a process template, the email template is
used whenever the event occurs in workflows created from that process template.
• If you associate the email template with an activity definition, the template is
used whenever the event occurs during an instance of the activity.
• If a particular workflow instance and an activity in that workflow both have an
associated template for the same event, the template associated with the activity
is used.
a. Click the Add button to add a row to the event notification box.
b. Click in the Event column of the new row and select a workflow event from the
drop-down list that appears. The available events are:
• dm_changedactivityinstancestate — An automatic activity changes state
because the error handling flag is set to zero and the work item returned a
non-zero value.
• dm_startedworkitem — A work item is generated as part of the workflow.
• dm_delegatedworkitem — A user delegates a work item.
• Pre Timer Expires — An activity has not started within a designated number
of hours after the workflow starts.
• Post Timer Expires — An activity has not completed within a designated
number of hours after the activity starts.

c. Click in the Email Template column of the row and select the email template to
use for the event you selected at step b. An email template is a document in the
Documentum repository that defines the structure of the notification message.
See the Documentum Process Builder Development Guide for information about the
structure of a document that serves as an email template.
13. Do one of the following:
• Click OK to close the dialog box.
• Click the Data tab to add process data to the template.
Managing process data

The Data tab of the Process Properties dialog box displays a list of the packages, process
variables, and process parameters involved in workflows created from this process
template. Process data can be made up of:
• Workflow variables
• Process variables
• Process parameters
• Packages
Managing packages
In many workflows, the same package passes through all 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 other cases, the work performed
by some activities may result in the creation of a new document. 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. The list of
packages in the Process Properties dialog box must include all packages involved in the
workflow, including packages created or discarded in the course of the process. When
you configure the activities, specify which packages each activity deals with. Changing
process data in an activity, page 141 provides more details on this subject.
To set the packages for a business process:

1. If the Process Properties dialog box is not already open, select Process Properties
from the Tools menu, or click the Template Properties icon on the toolbar .
2. Click the Data tab.

3. To add a package to the business process, select the Packages node in the tree view
window and click the + button above the window.
The new package appears under the Packages node in the tree and in the Package
Definition list box along with the controls for defining the package.
4. Type the name of the package in the Name text box.
Choose a name that will enable you to identify the package when you configure the
activities in the business process.
Note: Package names are restricted to 16 characters.
5. From the Version drop-down list, select or type the default version of the content
you want to use.
Note: Process Builder can be configured to not display the Version list. Appendix C,
Process Builder Configuration File provides more details on this subject. When the
list does not appear, the workflow always uses the CURRENT version.
The specified version appears as the default version used for each activity that
handles the package. You can override the version when you configure the activity.
To specify the version, you can select or type:
• <Any>, which means that any version of the package can be used.
• A specific version number, for example, 2.5 or 3.0. If you type a specific version
number, the package will always contain that version of the document.
• A symbolic version label, for example, Draft. The symbolic version label is
case-sensitive, so be sure the version you type matches the version of the object
in the repository.
• CURRENT, which is the default selection. If you select CURRENT, the package
will always contain the version labeled CURRENT, which is typically the most
current version of the object in the repository.
6. Choose the object type of the object included in the package by selecting it from
the Type drop-down list.
Note: Process Builder can be configured to not display the Type list. Appendix C,
Process Builder Configuration File provides more details on this subject. If the Type
list does not appear, or if you want Process Builder to select the object type based on
the form template you select you may skip this step.
Most commonly, the object type of a package is document or a custom document
type you have created. Refer to Documentum Content Server Reference for a description
of object types.
7. To associate a form template with the package, select the template from the Form
drop-down list.
A form template defines a custom user interface for users who handle this package
during the workflow. See Associating form templates with packages, page 37 for
more information about using forms and form templates. To appear in the list, the

form must be in an installed state. The form template you specify here appears as the
default template used for each activity that handles the package. You can override
the form template when you configure the activity.
Note: If you select a form template before setting the object type of the package,
Process Builder displays all available form templates in the drop-down list and sets
the package object type based on the selected form template.
a. Select an existing form from the Form drop-down list. The list shows only those
form templates whose data model matches the object type you selected at step
5. If the intended form template does not appear, make sure you selected the
correct object type at step 5.
b. To create a new form template or edit the selected form template, click the button
with the Forms Builder icon to launch Forms Builder.
The Documentum Forms Builder User Guide provides more information on creating
custom forms for your workflow.
8. To use the selected form to display the properties of the package, select the Use Form
for Properties checkbox.
When the Use Form for Properties checkbox is not selected, the form from step 7
appears when the performer of an activity selects the package from his or her inbox.
The form is used to save the content of the package. When the checkbox is selected,
the form appears when the performer views the package properties. The form is
used to set the package’s properties in the repository, not the content of the package.
Note: The Use Form for Properties option is available only for form templates whose
storage mapping option is set to Store in Repository attributes. See the Documentum
Forms Builder User Guide for information about this storage mapping option.
9. To prevent Process Builder from making this package visible to all activities by
default, clear the Visible across entire process checkbox.
By default, Process Builder makes the package visible to every activity in the
business process, on the assumption that the package will flow through the entire
process. When you clear this option, the package will be visible only in activities
to which you explicitly add it.
Note: If you select an existing package that has been set to be visible in some
activities and not visible in others, the checkbox is unavailable. To reset all activities
to the same value, click the Change activity-level settings link, then click Yes in the
dialog box that appears.
10. To require that the package have an associated document or other content, select the
This is a mandatory package checkbox.
Note: If you select an existing package that has been set to be mandatory in some
activities and optional in others, the checkbox is unavailable. To reset all activities to

the same value, click the Change activity-level settings link, then click Yes in the
dialog box that appears.
11. To enable Process Builder to publish reporting data to the BAM database for the
package, select This package can be used to generate reports.
12. Click Apply to add the package to the list box.
13. To add another package to the flow, repeat steps 3 through 11.
14. Click OK to save your updates and close the dialog box.
15. Configure each activity to specify which packages it handles, starting with the
initiate activity and moving forward through the business process.
See Changing process data in an activity, page 141.
Managing process variables

Process variables represent different types of data that flow through your business
process. These can be simple data types (such as string, Boolean, or date) or they can
be complex data types—groups of logically related data such as purchase orders,
manufacturing items, and so on. Process variables can be grouped into collections of
logically related attributes of data types that can be reused in the repository.
These process variables, or structured data types, are available in the Structured Data
Types window and can be used in multiple process templates in a repository.
For example, you can create a process variable approved, which is a Boolean value, and
associate it with the process flow. You can then design a Forms Builder form with radio
buttons that signify the value for the approved field and associate it with the process flow.
To set the process variables for a business process:

3. To add a process variable to the business process, select the Process Variables node
in the tree view window and click the + button above the window.
The new variable appears under the Process Variables node in the tree and in the
Variable Definition list box along with the controls for defining the process variable.
4. Type the name of the variable in the Name text box using 255 characters or less.
Choose a name that will enable you to identify the variable when you configure the
activities in the business process.

Note: If you change the name of a variable that is already defined in the repository,
this change is only to the variable within the process. It is not made to the structured
data type name in the repository. It retains its original name.
5. Select a data type in the Type field.
Valid values are string, integer, float, date, or Boolean.
You can also select a structured data type from the Structured Data Types by
selecting More Values and navigating through the tree of structured data types
in the Choose Type dialog box.
6. Depending on the data type you defined, type a default Value, if necessary.
7. To associate this variable with an ACL, click Browse and select an ACL from the list.
Note: An ACL assigned to an individual process variable overrides the process-level
ACL, if one is assigned to the process on the Advanced tab.
Setting Access Control List (ACL) options, page 75 provides more information on
Access Control Lists.
8. Click Apply to save the definition of the new variable.
9. To add another variable to the flow, repeat steps 3 through 11.
10. Click OK to save your updates and close the dialog box.
11. Configure each activity to specify which variables it handles, starting with the
initiate activity and moving forward through the business process.
Changing process data in an activity, page 141 provides more information on
configuring process data within an activity.
Managing process parameters

Process parameters enable application administrators to modify constant values that are
used throughout a process. Parameters that are defined within a process are available
to all activities contained in the process.
An administrator can change the values of the parameter from the Administration tab in
TaskSpace and any new process instances, work items, and variables within a workflow
use the updated value.
Understanding process parameters, page 36 provides overview information on process
parameters.
To set process parameters for a business process:



3. To add a process parameters to the business process, select the Process Parameters
node in the tree view window and click the Add(+) button above the window.
The new parameter appears under the Process Parameters node in the tree and in the
Process Parameter list box along with the controls for defining the parameter.
4. Type the name of the parameter in the Name text box using 255 characters or less.
Choose a name that will enable you to identify the parameter when you configure
the activities in the business process or from the Administration tab in TaskSpace.
Spaces and special characters are not permitted in the parameter name.
5. Select a data type in the Type field.
Valid values are string, integer, float, date, or Boolean.
6. Enter a Description of the parameter.
7. Depending on the data type you have defined, type a constant Value. This value
can be changed by application administrators by using the Administration tab in
TaskSpace.
Overriding activity-level settings

Settings created in the Data tab of the Process Properties dialog box are global settings
that extend throughout the process. The configuration for many of the properties can be
edited at the activity level, creating a mixed state for that specific setting. For example,
a package can be configured to be reportable at the process level, but can have the
reportable option changed in a specific activity. When the activity has different settings
than the global setting specified in the process, you have the option to overwrite the
activity-level setting.
To override activity-level settings for a process:

1. In the Data tab of the Process Properties dialog box, select the link Change
activity-level settings.
2. In the Change activity-level settings dialog box, the system displays any activities
that have settings that differ from the global process properties.
3. To override the setting, select the activity name and click Yes.
The activity inherits the global settings assigned in the process.

Conguring advanced options

The Advanced tab of the of the Process Properties dialog box enables you to set
permissions on the entire process or individual variables associated with the process
flow. You can also create the correlation sets that match attributes from an inbound
message from a external source to the process data in the activity.
Setting Access Control List (ACL) options

A permission set (also known as an access control list or ACL), defines the object-level
permissions applied to objects to which the permission sets are assigned. Permission sets
specify what access each user has to a particular item in the repository, such as a file or
folder. Each item in the repository is assigned a permission set by the item’s owner. The
permission set defines the object-level permissions applied to the object.
When you create a new template, the new process as well as the activity objects rely
on either the user’s default ACL or the parent folder’s default ACL, depending on
the configuration of the repository. To ensure that each user has the correct access to
elements of the workflow, configure the ACL for the process and the activity from
within Process Builder.
If a task performer does not have at least Read permission for the process, they will
receive the task in their inbox and can open it, but they will be unable to complete the
task. If a task performer does not have at least Read permission on the process variables,
they will be unable to view them in TaskSpace or their inbox. If a task performer does
not have Write permission, they are unable to modify the process variables
The Documentum Content Server Administration Guide provides information about using
ACLs.
Table 3. Permission requirements for a process
User Minimum permission level

Process creator Write
Workflow creator Relate, Execute_procedure
Workflow supervisor Relate
Task performers Read

Table 4. Permission requirements for process variables
User Minimum permission level

Process creator Write
Workflow creator Write
Workflow supervisor Write
Task performers Write
To select ACLs:
2. Click the Advanced tab.
3. To accept the default BPM Process Variable ACL, click Default.
4. To change the ACL for all process variables, click Browse.
The ACL Chooser dialog box appears.
a. Select an ACL that is owned either by the System or by a User.
The list of ACLs will change based upon your selection. System ACLs are
available for use by any user in the repository and are managed by the repository
owner. Other ACLs can be managed by their owners or a user with sysadmin or
superuser privileges.
b. Highlight the ACL to use for all process variables.
As a default, the server defines the ACL for the variable. The associated
permissions and description of the ACL appear in the dialog box.
c. Click OK.
Note: An ACL assigned to an individual process variable on the Data tab of the
Process Template overrides the process-level ACL.
5. To enable the server to choose the correct ACL for the process, click Default.
6. To change the default ACL for the process, click Browse and select an ACL.
a. Select an ACL that is owned by the System or by a User.
The list of ACLs will change based upon your selection. System ACLs are
available for use by any user in the repository and are managed by the repository
owner. Other ACLs can be managed by their owners or a user with sysadmin or
superuser privileges.
b. Highlight the ACL to use for the process.
The associated permissions and description of the ACL appear in the dialog box.

c. Click OK.
Selecting a calendar for the process

Process designers may be required to implement business processes that are based on
different time periods or working hours than found in the standard system calendar. In
Documentum Webtop or TaskSpace, designers can create calendars based on regional
work schedules, country-specific holidays, or other unique time constraints. In this
way, timers and notifications for a process are calculated based on a specific calendar
rather than the system calendar.
Note: When a task first arrives in the user’s inbox, the due date for the task may be
calculated based on the system calendar. The next time the timer job runs, the job
updates the due date according to the business calendar.
To select a calendar for a process

3. Select a calendar from the list box.
The list of calendars reflects all calendars located in the System/Workflow/Calendars
folder.
Note: If different calendars are selected for both a process and an activity within that
process, then the system uses the activity’s calendar.
Assigning a Process Parameter form

A Process Parameter form creates a page for an administrator to modify constant
values that are used throughout the process. Administrators make these changes in a
Documentum Form that they access from the Administration tab in TaskSpace. Any new
process instances, work items, and variables within a workflow use the updated value.
To enable this option, you assign or create a process parameter form to enable
administration of the parameters and assign it to the process.
To assign a process administration form:

1. From the Form drop-down list, select the Process Parameter form to use for
displaying process parameters to the TaskSpace administrator.

2. Click the Refresh button to retrieve all available forms from the repository.
This action queries the repository for all saved administration forms.
3. To create a new Process Parameter form, follow these steps:
a. Click the button to launch Forms Builder.
b. Use Forms Builder to create a form for the activity.
See Documentum Forms Builder User Guide for information on creating forms.
The Documentum TaskSpace Configuration Guide provides more information on
administering processes in TaskSpace.
Creating correlation sets

Process Builder must be able to match an inbound message to a unique instance of a
workflow in order to process the incoming data. Correlation sets are collections of process
variables that you define for an activity that enable the system to match a message to
a process instance.
You create correlation sets at the process level based on the type of information you will
be receiving from inbound message activity templates. This includes using structured
data types that have been defined with the repository. You can create multiple correlation
sets for a process, although an activity can only be associated with one correlation set.
Understanding message correlation, page 157 gives more details on using correlation
sets to match messages from external sources to process data.
To create a new correlation set:

3. In the Correlation Set group box, select the Correlation Sets root node and click the
add (+) button to create a new correlation set in the tree.
4. To create a name for the correlation set, right-click the new node and select Edit
set name.
The Edit Label dialog box appears.
5. Type the new name of the correlation set and click OK.
Correlation set names are limited to 128 characters.
6. To add an attribute to the correlation set, highlight the correlation set name, and
click .
The new, undefined property is added to the tree.

7. Right-click the attribute, and select Edit correlation model

The Correlation dialog box appears showing process variables that are associated
with the process.
8. Select a process variable from variables tree and click OK.
Note: Only saved process data appears in the tree. If you add a variable to the Data
tab, it will not appear in the tree until after it has been saved.
9. Repeat these steps adding different correlation sets and their related variables.
10. Click OK.
Enabling inbound web services

If an inbound web service activity is included in the process, you must enter the target
namespace URI for the WSDL location. If there are multiple web service activities within
the process, they use the same target namespace.
Note: If there are Web Service Inbound activities within the process, this field must be
completed or the system cannot validate the process.
To enable inbound web services:

1. Type the Target Namespace URI for the WSDL.
2. Click Apply.
Saving process templates

When you have completed a process 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, saving a new template, or saving a template with a new name.
To save changes to an existing template as the same version, you must have at least
Write permission on the template, and you must be working with a draft or validated
template. A template that is installed must first be uninstalled in order to save it as the
same version. If the Save options are unavailable on the File menu, it may mean that
the template has been installed.
The current state of the template appears in the Process Builder title bar. The title bar
also shows if the template is checked out and the username of the lock owner if the
template is checked out by another user.

Process Builder can be configured to enforce unique names or specific folder locations
for process templates. Appendix C, Process Builder Configuration File provides more
details on this subject. By default, however, process templates can be saved to any
location in the repository, and their names need to be unique only within their folder.
To save a new process template or save an existing template with a new

name:
1. From File menu, select Save As.
The Save Process Template As dialog box appears.
Note: If the current process template is new has not been saved previously, selecting
Save also displays the Save Process Template As dialog box.
2. Type a name for the process template.
Note: Process template names must be less than 80 characters in length. Longer
names are not allowed in Business Activity Monitor and will interfere with process
monitoring.
3. To create a folder in which to store the template and its associated objects, make sure
the Create new folder for associated items checkbox is selected.
The checkbox is selected by default. Process Builder saves the template and its
activities in a folder with the same name as the template, located under the folder
you select in the next step.
If the checkbox is not selected, navigate to the folder where you want to save the
template by double-clicking on cabinets and directories in the Save in dialog box
until you have highlighted the folder name.
The complete path to the folder appears in the text box at the bottom of the dialog
box.
4. Click OK.
If you have sufficient permissions on the selected folder, Process Builder saves the
template and its activities.
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 Preferences dialog box. Setting process template properties, page
66 provides more information on this subject.)
5. Choose whether to validate the process template.
See Validating process templates, page 81 for more information about validating
templates. If you choose to validate the template, Process Builder 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.

6. Choose whether to install the process template.

See Installing process templates, page 82 for more information about installing
templates.
To save an updated process template that is checked out:

1. From File menu, select Save.
If the current process template has been previously saved and is checked out, Process
Builder updates the saved file.
Checking in, checking out, and versioning process templates, page 84 provides
more specifics on checking in a template.
2. If you have sufficient permissions on the selected folder, Process Builder saves the
template and its activities. If installation and validation prompts are set to display, a
dialog box appears asking whether you want to validate the template.
See Validating process templates, page 81 for more information on validating the
template.
To save an updated process template that is not checked out:

1. Select File > Save or click the Save button to save changes to the current version.
2. Click OK.
3. Choose whether to validate the process template.
See Validating process templates, page 81 for more information about validating
templates. If you choose to validate the template, Process Builder 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.
templates.
Validating process templates

Validating a template verifies that the process defined in the template meets system
requirements.

To validate a process templates:

1. From the Tools menu, select Process Template.
2. Select Validate.
Additionally, if installation and validation prompts are set to display, any time you save
a template 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. Setting process template properties, page 66 provides more information on this
subject.
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.
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
143 for information about this display setting.
You can validate only if your open template is in the draft state and you have Write
permission.
Validating a process template verifies that:
• Referenced activities have unique names within the template.
• There is at least one initiate activity and only one end activity.
• There is a path through the workflow from each activity to the end activity.
• All referenced objects exist as local objects.
• Automatic activities have a method selected.
Installing process templates

A process template must be installed before it is available for use in an active workflow.
You can install a template only if it is in the validated state and you have Write
permission. The current state of the open template appears in the title bar of the Process
Builder window. If it is not validated, select Process Template > Validate from the Tools
menu. See Validating process templates, page 81 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 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

• Abort the workflows

The options you choose depends on the changes you made to the workflow. Perhaps you
deleted an activity, or added an activity that you want to perform on all objects in the
workflow, or you modified transition conditions. In any of these instances, you abort
the workflows and then restart them. To delete a running workflow, you must abort the
workflow and choose the option to destroy the runtime objects in Webtop. The default
behavior is to resume all halted workflows that reference that template.
To install a process template:

1. From the Tools menu, select Process Template > Install.
If the Install option is unavailable, it means the template is currently installed or has
not been saved or has not been validated.
If there are any halted workflows based on this process template, you are given the
option to resume or halt them. Click one of the following:
• Click Yes to resume the halted workflows.
If you resume a halted workflow that is based on a process template to which
you have made significant changes, incompatibilities between the old process
template and the changed process template may result in the workflow being
placed in an undefined state.
• Click No to abort the halted workflows.
To uninstall a process template:

1. From the Tools menu, select Process Template > Uninstall.
You can uninstall only if the template is in the installed state and you have Write
permission.
If any users are running workflows based on this template, a warning message
appears indicating that there are active workflow instances.
2. If you see the warning message, click Yes to halt the workflows or No to cancel the
uninstall process.
3. Click Yes to uninstall this process template and all of its activities.
4. Click OK to clear the message box telling you that the process is complete.
Modifying process templates

You can change a process template by changing its process flow or activity definitions.
When you change a process 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 process 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 process 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 process 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 process templates, page 79.
Checking in, checking out, and versioning

process templates
To lock and edit an existing process template, check it out using Process Builder. As the
process opens for editing, the system locks the file so that no one else can make changes
to it. When you complete your edits and check in a changed process template, modify
the version label and keep a running history of all changes to the process template.
Checking in also unlocks the template so that other users can modify it.
When a process template is checked out, the icon in the Open Process Template dialog
box reflects that it is locked by another user. To view the username for the lock owner,
place the cursor over the icon.
Table 5. Process template states and related icons
State Icon
Checked out by you
(locked)
Checked in (unlocked)
A template always receives version number 1.0 when it is first created. When you check a
template in after having modified it, you can decide whether to check the file in as a new
version or the same version. When checking a template into the repository, the system
prompts you to select whether to increase the version number by a whole number or
by a decimal point (by a tenth). Increasing the version number by a whole number is
considered a major revision. Increasing by a decimal point is a minor revision. The

system marks the most recently checked-in file as CURRENT. If you decide to check the
file back in without increasing the version number, the template keeps the same version
number as the original template and the system overwrites the original template with the
changes that you have just made and labels it as CURRENT. When checking a template
out, you can choose to view only the current version or all versions.
Checking processes in and out of the repository using Process Builder is very similar to
checking documents in and out in other Documentum applications. One very important
difference is that a process template can be installed and in use when you check it out.
To modify an existing template and save it as the same version (CURRENT), you must
first uninstall the template (which stops all instances of the template in the runtime
environment). This prevents you from making changes to a template when it is in use in
the runtime environment. After uninstalling the process, you are free to make changes to
it, check it in as the same version, and then validate and install the template.
Note: During the time that the template is uninstalled, the system stops all running
instances of the workflow and prevents any new instances from starting. Once the
template is installed again, you can either cancel or resume the halted instances,
depending on the complexity of changes made to the template. Modifications to existing
templates should be limited to minor changes of activity properties that are not currently
used by the instance or changes related to future activities of the instance.
To delete a running workflow, you must abort the workflow and choose the option to
destroy the runtime objects in Webtop.
If you check out an installed template without first uninstalling it, any running instances
of the process continue to run using the existing version of the template (labeled
CURRENT). The version of the template that you are editing is opened as a draft and
you are only allowed to save and check in the template as a new minor or major version.
After it has been checked in, validated, and installed the new version of the template can
be used in the runtime environment. All process instances created using the previous
version will continue to run until they have completed. Documentum Administrator User
Guide gives more specific information on using versions.
Canceling a check-out unlocks the process template and discards all changes that have
been made to the process template during the time it was checked out. The repository
retains the last version of the template as the current version.
To check out a process template:

1. From the File menu, select Open to display the Open Process Template dialog box
Note: To check out a process that is already open in the editor pane, click or
select File > Check out from the menu.
2. In the View box do one of the following:
• Select the option to Show ALL Versions to display all existing versions.

• Select Show Current Version to show only those versions of the template that
are labeled as CURRENT.
3. In the Select a Process Template box, navigate to and select a template.
If the template is checked out by another user, a lock icon appears next to the
template name. You can only View a read-only version of the template until it is
checked in by the lock owner.
4. To check out the template as it opens, select Check out process on Open.
Note: If the template is installed, the system displays a message giving you the
option to uninstall the template first or continue with the check-out without
uninstalling the template. An installed template only opens as a draft template and
can be saved only as a new major or minor version. To make changes to an existing
version of a template, you must uninstall it before checking it out.
5. Click Open to open a locked version of the template in the editor pane.
The status of the template in the Process Builder title bar changes to Checked-out.
To check in a process template:

1. Click the icon or select File > Checkin to display the Check-in Process Template
dialog box.
2. Select the option to save the new process as the Same Version, a Minor Version, or
a Major Version.
Checking in the template as the same version makes changes to the CURRENT
version.
Note: If you have made changes to an installed template, you can save only the
template as a minor version or a major version. The option to check in as the
same version is not available as overwriting the current version will affect running
instances of the process.
3. Type an optional descriptive label for the new version.
4. Click OK.
To cancel a check-out in a process template:

Use this procedure when you want to check the template back into the repository without
keeping any changes that were made to it. The existing version that is labeled CURRENT
in the repository will not be changed.
1. Click the icon or select File > Cancel Check out to display the Cancel Check
out dialog box.
The system displays a message warning that all changes to the template will be lost.
Note: Superusers can cancel the check out of templates that are locked by other users.

2. Click Yes to cancel the check-out.
Deleting process templates

The option to delete a process template is only available if the process template is open
in Process Builder.
To delete a process template:

1. From the Tools menu, select Process Template > Delete Process.
If a template is currently in an installed state, the system prompts you to uninstall it
before deleting it. Additionally, if any users are running workflows based on this
template, a warning message appears telling you there are active workflow instances.
2. Click Yes to uninstall and delete the process template and related activities.
Importing process templates

The import process takes an exported XPDL file and makes it available for you to work
with in either Process Builder or Process Analyzer. Automatic and manual activity
types are preserved during the import, although definitions such as methods and timers
must be added by the developer in Process Builder. Packages are not included in the
import process.
Additionally, if you import (or re-import) a process from Process Analyzer that has
multiple end activities, Process Builder adds an extra empty activity to which all the end
activities connect. Process Builder supports only a single end activity, whereas processes
exported from Process Analyzer may contain multiple end activities.
Note: If there are semantic errors in the imported XPDL, the system will save the new
process template in an invalid state. Use the information from each validation error
message to correct the error and validate and install the process template.
To import a process template into Process Builder:

1. From the File menu, select Import > XPDL.
The Import Process dialog box appears.
2. Navigate to the file that you want to import by double-clicking on the directories
listed in the Import Process dialog box until you have highlighted the filename.
3. Click Open.

Process Builder creates a new draft process template based on the Process Analyzer
process.
If activity location information is available, it is applied to the imported process
template. Otherwise, the system will use default layout and graphical display
settings. Since user interface information such as graphics or images is not exported
with the process, you must recreate them in Process Builder.
Next, you must define execution information for the process using the Activity
Inspector.
See Chapter 7, Working with Activities for more information on defining execution
details for activities.
Keeping shared processes in sync

Business processes can be shared and modified in either Process Builder or Process
Analyzer. To keep the process synchronized between the two applications, you must
re-import the changed process into its native application.
A Process Analyzer process can be exported and then imported into Process Builder
and modified. For example, use Process Builder to define execution details, add a new
activity, or change the order of activities. As a result of these changes, the business
analyst checks the process again in Process Analyzer or runs a simulation of the changed
business process. Re-importing the process that was changed in Process Builder updates
the original process in Process Analyzer, keeping the process in sync between both
applications.
An existing Process Builder process can be exported out of its native application,
imported into Process Analyzer, and modified. For example, the business analyst
can change the order of activities, add an activity, or delete an activity. To keep the
executable model of the process in sync with the newly changed process, it must be
re-imported back into Process Builder. During the re-import operation, the system
leverages versioning to give you the option to save the process as the same version, a
minor version, or a major version.
To re-import a changed business process into Process Builder:

1. Export the process from Process Analyzer.
2. Select the exported process and import it into Process Builder.
See Importing process templates, page 87 for the procedure to import a process
into Process Builder.
3. From the File menu, select Save.
The Checkin Process Template dialog box appears, indicating that the system has
detected an existing version of the process in the repository.

4. Select the option to save the new process as the Same Version, a Minor Version, or
a Major Version.
The new process becomes the current version of the process and the system retains
the older versions for historical purposes. All process instances created using the
previous version will continue to run using the previous version’s process template.
Additionally, once a process is checked in as a major or minor version, Process
Builder will not allow saving an older version of the process if a newer version
exists in the repository. For example, the system will prevent saving an imported
of version 1.0 of a process if version 1.1 already exists in the repository. The older
version can be renamed and saved as a different process.
A business process can only be saved as the same version if that version of the
process has not yet been installed. If an existing version of the business process
has been installed, the system will not allow you to save it as the same version.
You must save it as a changed version.
5. Click OK.
See Validating process templates, page 81 for more information on validating the
template.
templates.
Exporting process templates

The export process from either Process Builder or Process Analyzer creates an XPDL
(XML Process Definition Language) file that is saved to a location you specify in a file
system. This file is then available to import into either Process Analyzer or Process
Builder. Templates exported from Process Builder contain the type definitions that
Process Analyzer uses to create the corresponding business objects. The exported XPDL
also contains information on which activities have been identified for BAM reporting.
To export a process out of Process Builder:

1. From the File menu, select Export > XPDL.
The Export Process dialog box appears.
2. Navigate to the folder that will receive the exported file by double-clicking on the
directories listed in Export Process dialog box until you have highlighted the folder.

3. Click Save.
Printing process templates

You can print a copy of the process template at any time.
To print a process template:

1. Open the process template you want to print.
2. Verify that the page setup options are as you want them.
See Setting page setup options, page 90 and Previewing printed processes, page
91 for information about these options.
3. Click the Print Template Layout icon in the toolbar, or select Print from the File menu.
The Print dialog box appears.
4. From the Name list, choose the name of the printer to which you want to print.
5. To change the properties of your printer, click Properties and update the settings.
Refer to the documentation for your printer for information about the printer
properties.
6. To print your process template to a file rather than to the printer, select the Print
to file checkbox.
7. To print more than one copy of the process template, type the number of copies you
want from the Number of copies box.
Note: The controls in the Print range box are unavailable except for the All radio
button. You cannot print portions of the template, only the complete template.
8. Click OK.
If you elected to print to a file, the Print to File dialog box appears. Otherwise, the
process template is sent to the printer you selected.
9. In the Print to File dialog box, type the name of the file to create, including the
full path.
Setting page setup options

The page setup options determine how the process template is printed.

To change page setup options:

1. From the File menu, choose Page Setup.
The Page Setup dialog box appears.
2. Choose the paper size for printed versions of the process template.
The Paper Format box offers six standard sizes. The dimensions for each format
display either in inches or in centimeters, depending on the unit of measurement
selected in the Margins field. The paper format options are:
• US Letter (8.5 x 11 inches)
• US Legal (8.5 x 14 inches)
• US Executive (7.25 x 10.5 inches)
• A3 (29.69 x 42.01 centimeters)
• A4 (21 x 29.7 centimeters)
• A5 (14.8 x 21 centimeters)
3. Specify whether to print pages in landscape or portrait orientation.
4. Enter the margins for the printed pages.
You can type the measurement in inches or centimeters with up to two decimal
places, such as 1.25 inches or 4.44 centimeters.
5. 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.
Previewing printed processes

The Print Preview option gives a graphical representation of the image that will be
printed.
To view the printing format:

1. From the File menu, choose Print Preview.
The Print Preview dialog box appears. The box on the right displays a preview
image of the process template as it will appear on the printed page(s). The layout is
based on the page setup options and on the Printout Size option.
2. Set the size of the process template printout.
The Printout Size options are:
• Actual size — The printout will be the same size as the process template display
in Process Builder.
• Same as paper size — The size of the process template will be adjusted so that it
fits on a single page of the size and orientation you specified in steps 2 and 3.

• Fit to — The size of the process template will be adjusted so that it fits on a
specified number of pages across and down. If you select this option, you must
type a number in each of the two adjacent text boxes.
3. Click OK to save the Printout Size option and exit from this dialog box, or click
Print to print the current template with these settings.

Chapter 4
Connecting Activities
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 Process templates and associated workflow
objects, page 16 for a description of flows.
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 process template editor pane, or by selecting
one or more flows and choosing Flow Inspector from the Tools menu.
The Flow Inspector enables you to control how the flow appears in the visual display of the process
template. Changing flow display settings, page 94 provides more information on this subject.
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 checkboxes
labeled Apply to all selected. When this checkbox is selected, Process Builder applies the associated
settings — that is, those settings that appear to the right of the checkbox — to all selected flows, not
just the one whose name appears in the text box at the top. Any settings for which the checkbox
is not selected apply only to the current flow.
Creating ows
You connect activities using one of four Create Flow icons in the Process Builder 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.
• To connect an automatic activity to a fault handler activity, click the Assign Fault
Handlers icon . Fault handlers enable you to assign a secondary error handling
activity to an automatic activity in the event that the automatic activity fails. A fault
handler activity has a dashed line representing the flow between the automatic
activity and its related fault handler.
See Process templates and associated workflow objects, page 16 for a description of
the types of flows.
Changing ow display settings

The options on the Display tab control how the flow appears in the visual display of the
process template.
Note: The options on the Display tab do not control whether the flow line begins with a
BPMN-style diamond. Flows have a diamond when the originating activity selects the
next activity using conditional logic. Setting activity transition rules, page 133 provides
more information on this subject.
To change the display settings for a ow:

1. In the Flow Inspector, select the Display tab.
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 flow labels or 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 or if you type in custom labels for that flow segment.
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. Specify how to label the flow in the process template editor display.

a. Select the Show Label checkbox to display a label for the flow, or clear it to
display the flow without a label. The two radio buttons below the checkbox are
unavailable when the checkbox is not selected.
b. Select Show visible packages at destination activity to label the flow with the
names of the packages that the following activity handles. or select Custom
label and type the label text in the adjacent text 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.


Chapter 5
Creating Sub-Processes
Sub-processes improve your ability to communicate the business meaning of a process template. A
large or complicated process can become difficult to organize visually when there are many activities
required to complete an entire workflow. To simplify the layout of a process, you may want to group
related activities into sub-processes that collectively represent a business process.
In Process Builder, sub-processes can be expanded to view the individual activities or collapsed to
create a more simplified overview of a process. The process contains activities that are related in some
way and are grouped into a container for ease of administration. This can be particularly useful when
grouping a set of activities that collectively represent a business function or a logical step in a process.
Activities that share the same process data can also be grouped into a sub-process.
There are no restrictions on the number of input or output flows that are related to a sub-process.
Flows do not connect to the sub-process container, but to the individual activities within the container.
Sub-processes are included in BAM reporting data. Entry and exit data are sent to the BAM reporting
database when the audit trail has been enabled for the process. Activity templates contained in the
sub-process also publish reporting data when they have been selected for reporting.
The following sections describe how to create sub-processes within a process template:
• Creating a sub-process using top-down modeling, page 97
• Creating a sub-process using bottom-up modeling, page 98
• Setting sub-process properties, page 99
• Managing sub-processes, page 100
Creating a sub-process using top-down

modeling
Top-down modeling refers to the practice of creating an empty sub-process first and then
adding individual activities to it as they are defined. This approach is especially useful

when you plan to design the initial high-level concepts of the process first and want to
fill in the details at a later stage in development.
To create a sub-process by selecting existing activities:

1. Select the Create Sub-Process icon and then click in the process template editor pane
where you want the sub-process to appear.
The new empty sub-process appears as a colored rectangle that is labeled
Sub-Process.
2. Click the sub-process and drag it to the intended position in the process editor
window.
3. Right-click the sub-process and select Sub-Process Inspector to set the properties
that are shared for all activities within the sub-process.
Setting sub-process properties, page 99 provides detailed instructions for setting
these properties.
4. Expand the sub-process boundary by clicking the plus sign +.
If necessary, select and drag the edge of the sub-process to enlarge the sub-process
boundary.
5. Drag each activity that you want to include in the group into the sub-process
container.
The system displays a message confirming the action. If you move the sub-process to
another position in the window, the included activities move with it, as well.
6. Create the individual flow lines and connect all of the activities in the process flow.
Note: Flow lines do not connect to sub-processes container but to the individual
activities within the sub-process. A sub-process is not limited in the number of input
or output flows that enter or exit its boundaries.
Creating a sub-process using bottom-up

modeling
Bottom-up modeling is the practice of creating the business process with all of its activities
first, and then bundling the related activities into sub-processes. This method enables
you to create all of the required activities first, group them into sub-processes, and
collapse them in order to see a more compact, simplified flow.
To create a sub-process by selecting existing activities:

1. Select the activities to include in the sub-process.

You can select multiple activities by using the mouse to drag a rectangle around the
activities you want to include in the sub-process or by holding down the Shift key
and clicking the activities individually.
The selected activities are surrounded with a green dashed line.
2. Select Tools > Sub-Process > Add to Sub-Process.
The selected activities appear in a colored rectangle that is labeled Sub-Process
3. Right-click the sub-process and select Sub-Process Inspector to set the properties
that are shared for all activities within the sub-process.
Setting sub-process properties, page 99 provides detailed instructions for setting
these properties.
4. You can click the new sub-process and drag it to the intended position in the window.
Setting sub-process properties

Right-click the sub-process and select Sub-Process Inspector to set the properties that are
shared for all activities within the sub-process. Sub-process properties are independent
of activity properties.
Using the Timers tab

Process Builder supports two kinds of warning timers for sub-processes:
• A pre-timer takes action if an activity has not been triggered within a designated
amount of time after the workflow starts.
The activity is considered triggered once it is created by the workflow, but not
necessarily acquired by a user. Pre-timers are not activated on the first activity of a
workflow as they are automatically triggered during the workflow’s start.
For more information about workflow timers, see Setting timers, page 38.
When a sub-process has one or more timer actions set for it, a small clock icon appears in
the lower right corner of the sub-process.

Using the Display tab

The options on the Display tab control how the activity appears in the visual display
of the process template.
Note: When an activity has one or more timer actions set for it, a small clock icon
appears in the lower right corner of the sub-process container.
1. In the Sub-Process Inspector, click the Display tab.

2. Set the font and style used to label the activity in the template.
a. Select a font from the Label font list.
3. Select the background color for the sub-process form the Background Color field.
4. Click Apply to save your updates without closing the Sub-Process Inspector, or click
OK to save your updates and close the Sub-Process Inspector.
Managing sub-processes
This section describes the following functions available to manage sub-processes:
• Expanding and collapsing a sub-process, page 100
• Removing activities from a sub-process, page 101
• Adding notes to a sub-process, page 101
• Deleting a sub-process and its contents, page 101
Expanding and collapsing a sub-process

You can expand and collapse a sub-process to display or hide its contents. To expand
an individual sub-process, click the plus sign and the boundary expands, revealing
the contents of the sub-process and enabling you to view the individual activities. To
expand all sub-processes in the template, select Tools > Sub-Process > Expand all and
all sub-processes display their contents.
To collapse an individual sub-process, click the minus sign and the sub-process
minimizes, hiding its contents. To collapse all sub-processes in the template, select Tools
> Sub-Process > Collapse all

When a sub-process is collapsed, the activities that are contained within it are hidden
from view. You can drag a collapsed sub-process to different locations in the Process
Template Editor and the flow lines automatically adjust their length to the new position.
You cannot drag an activity into a collapsed sub-process.
Removing activities from a sub-process

You can remove activities from a sub-process while leaving the sub-process intact. The
activity will not change position on the canvas, so you must drag it to a new location
outside of the sub-process.
To remove an activity from a sub-process:

1. Select the activity or set of activities that are in the sub-process.
2. Select Tools > Sub-Process > Remove from Sub-Process.
The system displays a message confirming that the activity will be permanently
removed from the sub-process.
3. Drag the activity to a new location on the canvas.
Adding notes to a sub-process

You can add text to the visual layout of the process template through the use of notes.
You can add notes to a sub-process by selecting an expanded sub-process, clicking the
Notes icon, and then clicking within the boundary of the sub-process. You can also create
a note within the Process Template Editor and drag the note into the sub-process. Notes
are hidden when the sub-process is collapsed and are displayed when the sub-process
is expanded. Adding notes , page 59 provides instructions on using notes in a process
template.
Deleting a sub-process and its contents

When you delete a sub-process, all objects within the sub-process are also deleted. This
includes the activity templates that are in the sub-process. To preserve the activity
templates contained in the sub-process, use the Remove from Sub-Process option
instead.

To delete a sub-process and its contents:

1. Select the sub-process.
2. Select Delete from the shortcut menu.
The sub-process and its contents, as well as the connected flow lines are deleted.

Chapter 6
Working with Activity Templates
An activity template represents a particular type of task that you can add to a business process. The
template identifies any underlying workflow method required to complete the task and determines
what configuration attributes must be set in order to accomplish the task. The template may also
set default values for some common attributes.
To add an activity to a business process template, you select the appropriate installed activity template
from one of the folders in the Activity Template window and drag it into the Process Template
Editor window. Process Builder includes templates for common integration activity types as well as
a sample activity template. See Appendix A, Delivered Activity Templates for a list of the activity
templates provided with Process Builder. The Documentum Process Builder Development Guide gives
more information on how to create custom activity templates.
There are three possible states for activity templates: draft, validated, and installed. An activity
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 to be used to create an activity in
the process flow. The current state of an activity template is indicated on the template icon in the
Activity Template window.
This chapter explains how to create activity templates, configure them, validate and install them.
The topics are:
• Creating activity templates, page 104
• Managing activity templates within folders, page 105
• Configuring activity templates, page 105
• Validating and installing activity templates, page 107

Creating activity templates

If your business process contains activities for which Process Builder does not include an
appropriate activity template, you can create a new template. You can either copy an
existing template and then modify it, or you can create a brand new template.
To create a new activity template:

1. Select the folder to which you will add the new template.
2. From the Tools menu, select Activity Template > New or right-click the folder and
select New from the menu.
A new activity template with the name Untitled appears in the currently active
folder of activity templates.
3. Double-click the new activity template to display the Activity Template Inspector.
4. Configure the activity template.
See Configuring activity templates, page 105 for information about configuring
activity templates.
To create a new activity template based on an existing template:

1. On an activity template node, select the activity template to copy.
2. From the Tools menu, select Activity Template > Save As.
ASave dialog box appears. The Save in box lists the folders under
System/Workflow/Activity Templates, which represent the available activity
templates.
3. In the Save in dialog box, select the activity template node to which you want to
add the new template.
4. Enter a name for the new activity template in the Name text box.
5. Click OK.
The activity template appears on the selected node. The new template has the same
characteristics as the template selected in step 1. However, the original template
and the new template are independent of each other. Future changes to one do
not affect the other.
6. Make any necessary changes to the new activity template.
See Configuring activity templates, page 105 for information about configuring
activity templates.

Managing activity templates within folders

There are many delivered activity templates that are organized by function under folders
(or nodes) in the Activity Template window. You can browse through the delivered
activity templates by opening and closing the folders to which they belong. Appendix A,
Delivered Activity Templates gives details on which node the activity template belongs
to and instructions on configuring each activity template. Managing activity template
folders, page 47 provides more details on creating, adding, or removing folders from
the Activity Templates window.
When you create a custom activity template, you specify which folder it appears in.
Since an activity template may be relevant in more than one type of situation or business
process, a single template can appear in more than one folder.
To add (copy) an activity template to another activity template folder:

1. Select the activity folder to which you want to add the activity template.
2. From the Tools menu, select Activity Template > Add or right-click in the Activity
Templates window and select Add.
The Open dialog box appears.
3. In the Select from box, navigate to the activity template you want to add and select it.
4. Click OK.
The selected activity template appears on the current activity template folder. The
template is now linked to this folder as well as its original folder. Any changes made
to the template will be reflected on both folders.
To remove an activity template from an activity template folder:

1. Select the activity template to remove.
2. From the Tools menu, select Activity Template > Remove or right-click in the
Activity Templates window and select Remove.
The activity template is removed from the current folder. If the template is linked to
another folder, it still appears in that folder.
Conguring activity templates

Configure an activity template by using the Activity Template Inspector. The Activity
Template Inspector shares several tabs with the Activity Inspector, which you use to
configure individual activities. For these shared tabs, the values you set for the activity
template become the default values for activities created from the template. The Activity
Template Inspector does not enable you to set information about priority, packages,

input and output flows, or transition options. These configuration attributes relate to
how an individual activity fits into a specific process flow, and so are not relevant for
activity templates.
The Activity Template Inspector also includes an additional tab, labeled Definition,
which defines custom attributes for activities created with the template. The attributes
are defined using XML. The XML defines the names, data types, and display
characteristics of the custom attributes, as well as assistance for users who enter values
for the attributes. When an activity is created from the template, the Activity Inspector
includes one or more extra tabs for the user to use when entering values for the custom
attributes. The names of the extra tabs are specified in the XML file.
In addition to defining extra tabs, the activity template definition file can suppress the
display of one or more of the standard Activity Inspector tabs. When an activity is
created from the template, the Activity Inspector does not display any of the suppressed
tabs, thereby preventing the user from changing any of the values on that tab. The values
set in the Activity Template Inspector remain unchanged.
The structure of an activity template XML file is defined by the schema file
activity.xsd, which is located on the local file system in the directory Program
Files\Documentum\bpm\classes. See the Documentum Process Builder Development Guide
for further details about the file structure. For a sample activity template XML file, see
the Sample Activity Template installed in the Sample activity template folder.
To set attributes for an activity template:

1. Double-click the activity template in the folder, or select it and choose Activity
Template Inspector from the Tools menu.
The Activity Template Inspector appears.
2. Set default values for any of the available configuration attributes on the other tabs.
The values set in the activity template become default values for any activities
created from the template. See Chapter 7, Working with Activities for details about
setting the attributes. Commonly, you will want to link the template to a custom
workflow method on the Performer tab.
3. Select the Definition tab.
A text box displays the XML elements that define the custom attributes for this
activity template. If this is a new activity template, or a template with no custom
attributes, the only elements are the top-level <xml> element and the <activity>
element that identifies the XML schema for activity templates.
4. Edit the XML to define custom attributes and the user interface for editing them.
The XML you enter must conform to the activity.xsd schema. See the Documentum
Process Builder Development Guide for further details about the file structure.
5. To suppress the display of one or more tabs in the Activity Inspector, enter a <tab>
element for each suppressed tab.

The <tab> element must be a sub-element of the <tabs> element, which also specifies
the custom tabs to display in the Activity Inspector. For each tab you want to
suppress, enter an element in this format:
<tab id="TAB_NAME" showInActInspector="false" />
The valid values for TAB_NAME are PROPERTIES, PERFORMER, TRIGGER,
NOTIFICATION, TRANSITION, PACKAGE, and DISPLAY. See Chapter 7, Working
with Activities for information about the options on each of these tabs. The
showInActInspector parameter is ignored for custom tabs.
6. Click OK to close the Activity Template Inspector.
Validating and installing activity templates

There are three possible states for activity templates: draft, validated, and installed. An
activity 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.
The following list details some of the validation checks that the system performs:
• Every activity is connected to the END activity by way of a path.
• Pre-timers and post-timers are configured correctly.
• User selection is valid for manual activities.
• Every step activity is directly or indirectly connected to an initiate activity. (A fault
handler activity is an exception, since it is only connected to an automatic activity
and cannot have outflows.)
A template in the installed state is ready to use for creating activities. The current state of
an activity template is indicated on the template icon in the Activity Templates window.
A valid template has a red checkmark on the template icon, and an installed template
has an arrow on the template icon.
Validating an activity template verifies that the template meets system requirements.
You can only validate if your open template is in the draft state and you have Write
permission.
An activity template must be installed before it is available for creating activities. You
can only install an activity template if it is in the validated state and you have Write
permission.
If you need to make changes to an installed activity template, you must uninstall it first.
After making the changes, validate and install the template again.
To validate an activity template:

1. Select the activity template to validate.

2. From the Tools menu, select Activity Template > Validate.

If the Validate option is unavailable, it means the template is currently validated or
installed or you do not have permission to validate.
If validation fails, a dialog box appears. Click the Details button to see the error that
prevented validation. If the validation is successful, a red check mark appears next
to the activity template icon in the Activity Templates window.
To install an activity template:

1. From the Tools menu, select Activity Template > Install.
If the Install option is unavailable, it means the template is currently installed or you
don’t have permission to install. If the installation is successful, the validation icon
appears next to the activity template in the Activity Templates window.
To uninstall an activity template:

1. From the Tools menu, select Activity Template > Uninstall.
You can only uninstall if the template is in the installed state and you have Write
permission. If the template is successfully uninstalled, the arrow next to the template
icon (representing installed state) is replaced with a red check mark (representing
validated state).

Chapter 7
Working with Activities
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 processes, page 22.
You configure activities using the Activity Inspector. You access the Activity Inspector by
double-clicking on an activity in the process template editor pane, or by selecting one or more
activities and choosing Activity Inspector from the Tools menu.
The Activity Inspector has several tabs, each corresponding to one aspect of activity configuration:
• The Properties tab sets the priority for automatic activities, lets you provide instructions for
manual performers, and enables you to provide a form for the activity. Setting activity properties,
page 110 provides more details.
• The Performer tab enables you to select who performs the activity and what actions the performers
have available to them. Selecting performers, page 112 provides more details on this subject.
• The Trigger tab settings determine when the activity starts. Setting activity triggers, page
126 provides more details on this subject.
• The Timers tab sets timers to take action if work bogs down. Setting warning timers, page
127 provides more details on this subject.
• The Transition tab settings determine which activities come next in the workflow. Setting activity
transition rules, page 133 provides more details on this subject.
• The Notification tab specifies whether to notify the workflow supervisor when certain system
events occur. Setting notifications, page 137 provides more details on this subject.
• The Data tab controls the process data the activity handles including packages and process
variables. Changing process data in an activity, page 141 provides more details on this subject.
• The Display tab controls how the activity appears in the visual display of the process template.
Changing display settings, page 143 provides more details on this subject.

• Many activities include one or more additional tabs containing properties specific to that type of
activity. The name of the tab and the properties contained on it are set in the activity template.
Configuring activity templates, page 105 provides more specifics on configuring custom activity
templates.
When typing values into the fields on a custom tab, you can include variables that are replaced at
runtime with values from the current environment, such as the name of the dm_workflow object.
To include a variable, type the XML element <dmp:param>supported_parameter</dmp:param>,
where supported_parameter is one of the variables Process Builder supports for variable
substitution. See Appendix B, Substitution Variables for Custom Activity Template Properties for
a list of the supported variables.
Note: Depending on the nature of the activity, some of the tabs may not appear in the Activity
Inspector. For example, an activity created from the Decision Split activity template displays only
the Timers, Display, and Definition tabs. The settings on these tabs are the only ones relevant for
Decision Split activities. The set of displayed tabs is defined by the activity template. Configuring
activity templates, page 105 provides more details on this subject.
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,
type 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
checkboxes labeled Apply to all selected. When this checkbox is selected, Process Builder applies the
associated settings — that is, those settings that appear to the right of the checkbox — 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
checkbox is not selected apply only to the current activity.
Setting activity properties

The Activity Inspector’s Properties tab enables you to set the priority of automatic
activities, provide instructions for the performers of manual activities, or associate a
form with an activity. When you create an activity that uses a form, at runtime the
performer of the task sees that form instead of the standard Task Manager interface
when they open the task.
To set activity properties:

1. In the Activity Inspector, select the Properties tab.
The system displays the repository object ID and the status of the activity in the
Activity ID field as a read-only value.

2. Select a priority level from the Priority drop-down list.

The priority value designates the execution priority of an automatic activity. The
value is ignored for manual activities. For more information, see Setting priority
values, page 30.
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 process template. You should
assign Dynamic priority only when your system includes custom code to set the
priority at runtime.
3. Enter a description of the activity in the Description text box.
4. Enter text for the message that appears in a manual performer’s inbox in the Task
Name box.
The default message appears in the box by default. In addition to normal text, the
message can include the values of workflow attributes that the system determines at
runtime. For example, the message can include the name of the workflow or of the
document being routed. You can type up to 255 characters. The message that the
user sees, with any variables evaluated, is truncated after 512 characters.
To include a runtime attribute in the task name, you add a variable to the message by
following these steps:
a. In the Task Name box, position the cursor at the location in the text where you
want to place the variable.
b. Click Insert. The Insert Task Name dialog box appears from which you can
select the runtime attribute you want to include.
c. From the Parameter type tree, select the attribute you want to include in the
subject message.
d. Click OK to close the dialog box.
See Defining task subjects, page 28 for information about the available variables. You
can include multiple variables in the task name.
5. Enter any instructions you want to include for the performer of this activity in the
Task Instructions box.
Note: Double quotation marks are not supported in the Task Instructions field and
will prevent the system from sending custom email notifications.
To include a runtime attribute in the task instructions, you add a parameter to the
message by following these steps:
a. In the Task Instructions box, put the cursor at the location in the text where you
want to place the parameter.
b. Click Insert. The Insert Task Instruction dialog box appears from which you can
select the runtime attribute you want to include.

c. From the Parameter type tree, select the attribute you want to include in the
task instructions.
d. Click OK to close the dialog box.
6. From the Form drop-down list, select the form template (if any) to use for displaying
this task to the activity performer.
Note: Only Forms that are associated with the process appear in the list.
If the activity includes process parameters, you can create a Process Administration
form to enable administration of the parameters. From within the form,
administrators can change the value of the process parameters.
To create a new form for the activity, follow these steps:
a. Click the button to launch Forms Builder.
b. Use Forms Builder to create a form for the activity.
See Documentum Forms Builder User Guide for information on creating forms.
c. Click the Refresh button to retrieve all available forms from the repository.
7. Click Apply to save your updates without closing the Activity Inspector, or click OK
to save your updates and close the Activity Inspector.
Selecting performers
When defining an activity, you need to specify who performs the activity. Activities can
be performed manually by an individual, group, work queue, 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.
To select performers for an activity:

1. In the Activity Inspector, select the Performer tab.
2. In the box labeled The activity’s work is performed, select the performers.
• To choose a manual performer, select By one or more manual performers.
• To choose an automatic performer, select Automatically on behalf of a
performer.
3. Click the Select Performer button to display the wizard for selecting the performer
for this activity.
• To choose one or more manual performers, see Choosing manual performers,
page 114.

• To choose the user whose permissions are used for an automatic activity, see
Choosing automatic performers, page 125.
4. If you selected one or more manual performers, choose what actions the performer
can or must perform.
• To enable the performer to pass the task to another user or group, select Delegate
the activity’s work to someone else. 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 if auto-delegation fails.
• To enable the performer to choose another user or group to also perform this
task, select Have someone else repeat the activity’s work.
• To require that the performer sign off when the activity is complete, select
Performer’s sign-off required when finished.
For details about the delegation and extension options, see Enabling delegation
and extension, page 28.
5. If you selected an automatic activity, set the execution parameters.
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
Documentum Process Builder Development Guide for details about developing
custom workflow methods.
b. To save an execution log when the automatic method runs, select Yes for Save
Execution Results.
c. Specify how long the process engine tries to run this method before quitting.
Enter a number of seconds in the Method times out in box.
6. Configure options for the system to use in the event that the method fails.
a. If you want the system to retry the method when it fails, select Retry and type
a Retry Interval to specify a time interval between retries. Use the Maximum
tries field to enter maximum number of times the system should retry before
performing one of the actions you specify in step 6c.
b. If you have assigned a fault handler to this activity, the system displays the name
of the fault handler activity in the Proceed to the fault handler field. The fault
handler runs each time the method fails.
c. 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.
Terminate Execution stops the workflow without the option of restarting it.
Associating a work queue priority module with an

activity
You can associate a priority module with an activity from the Performer tab of the
Activity Inspector. Setting dynamic priority and aging logic for tasks, page 32 provides
more details on setting dynamic priority and aging logic for a process.
To associate a work queue priority module with an activity:

1. Open the Activity Inspector and select the Performer tab.
2. Select Work queue as the performer.
3. From the Select Task Priority module list box, select the priority module.
Setting initial priority and aging of tasks, page 30 provides more details on priority
modules.
Note: If two different modules were selected for a workflow (one from the activity
definition and one from the work queue policy), the system uses the module that was
selected from within the activity to calibrate aging and priorities.
Choosing manual performers

The steps required to choose manual performers for an activity depends on two key
factors:
• Whether there is a single performer for the activity or multiple performers
• Whether you identify the actual users now, as part of the template, or use aliases
For details about the options for choosing manual performers, see Choosing performers,
page 24.

To choose one or more manual performers for an activity:

1. On the Activity Inspector’s Performer tab, select By one or more manual performers
and click the Select Performer button.
The Select Performer dialog box appears.
2. From the drop-down list, choose the user or group that will perform this activity.
You can choose a specific user or group, or you can choose an option that determines
the specific user when the workflow runs. The options are:
• Work queue — The activity will be performed by a member of the selected
work queue.
For more information on mapping work queue skill sets to tasks in a queue, see
Mapping process data to a work queue skill set, page 124.
• Workflow supervisor — The activity will be performed by the workflow
supervisor, which by default is the user who starts the workflow.
• Repository owner — The activity will be performed by the user who owns the
repository.
• Previous activity’s performer — The activity will be performed by the same user
or users who completed the previous activity in the workflow. This option can
include multiple users. You select the activity name that has the performer or
group of performers that you want to complete this activity. You can then select
one of two options for selecting a performer:
Assign to the last performer of previous activity means that the person who
triggered the completion of the previous activity is the assigned performer.
Assign to all performers of previous activity means that all performers of
the identified activity are the assigned performers.
• Specific user — The activity will be performed by a user specifically chosen.
• All users in group — The activity will be performed by all of the members of
a specific group.
• Single user from group — The activity will be performed by a single member of
a specific group.
• Some users from a group — The activity will be performed by some members of
a specific group, but not all.
• Multiple sequential performers — The activity will be performed by multiple
users one after the other.
The rest of the procedure differs depending on the option you choose. If you select
Workflow Supervisor or Repository owner, the specific user will be determined
when the workflow runs. Click Finish and ignore the rest of this procedure.
If you chose any options other than the first two, a box labeled Define Performer(s)
appears on the screen. You select an option in this box to specify how the specific
performers of this activity will be selected.

3. If you chose Previous activity’s performer, select the activity name that has the
performer or group of performers that you want to complete this activity. You can
then select one of two options for selecting a performer:
• Assign to the last performer of previous activity means that the person who
triggered the completion of the previous activity is the assigned performer.
• Assign to all performers of previous activity means that all performers of the
identified activity are the assigned performers.
4. If you chose Multiple sequential performers, specify whether each performer of this
activity has the right to reject the package they receive and return it to the performer
who preceded them in the sequence.
Sequential performers do not have this option by default. To grant them the option,
click the checkbox immediately below the Select Performer(s) box.
5. Specify whether you will choose the performers for this activity now or have them
determined dynamically when the workflow is underway.
Choose an option from the Define Performer(s) box:
• Assign performer(s) now — You will select the specific user or group as part of
the process template.
• Have performer(s) of activity <activity name> determine the performer for this
activity <activity name> — The performer(s) of the preceding activity will select
the performer(s) of this activity when the workflow is run. If this activity has
multiple preceding activities, select from the drop-down list which activity’s
performer selects the performer for this activity.
• Define performer alias (performer(s) will be assigned when workflow is
underway) — The performer of this activity will be determined by an alias
set. You will specify which alias set is used in the next steps. This option is
not available if you selected Some users from a group or Multiple sequential
performers.
• Select performer based on conditions — The performer of the activity will
be determined by conditional logic that you define, including package data
and process variables.
• Select performer based on process data — The performer of the activity is
determined by process data that you define including package data, process
variables, and execution data.
6. If you chose Single user from group, specify which user in the selected group will
perform the activity.
You will select the group in the next step. To specify which single user from that
group will perform the activity, choose one of the options from the Select User
From Group By box:

• First to acquire the work item — When the preceding activity completes, a
work item is added to the inbox of every user in the group. The first user who
acquires the work item from their inbox is the performer. The work items are
removed from the other user’s inboxes.
• Least amount of unfinished work items — When the preceding activity
completes, a work item is added to the inbox of the user who has the smallest
number of unfinished tasks in his or her inbox.
7. Click Next to continue.
The steps required to complete this procedure depend on the option you chose.
• Assign performer(s) now, page 117
• Have performer(s) of <activity> determine performer(s) of this activity, page 118
• Define performer alias (performer(s) will be assigned when workflow is
underway), page 119
• Select performer based on conditions , page 121
Assign performer(s) now
The following options are available for the option to assign performers now:
• If you selected Work queue, highlight the name of the work queue, then click Next
to display the data mapping screen where you can assign process data to skill sets
that have been defined for the queue.
For more information on mapping process data to skill sets, see Mapping process
data to a work queue skill set, page 124.
• If you selected Specific 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 118 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 118.

Have performer(s) of <activity> determine performer(s) of this

activity
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 a future 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 27.
To select users and groups:

1. Select one or more of the options for selecting users.
If you select more than one option, the following options appear in sequential order:
• Specific users and/or groups — Select the user and group names now.
• Performer alias(es) which will be resolved by the workflow initiator — Select
alias sets and aliases for which the workflow initiator will provide specific user
and group names when starting the workflow.
• Performer alias(es) which will be resolved at run-time from the alias set —
Select the alias sets and aliases that the server will use at runtime to determine
the actual users and groups.
2. Click Next.
3. If you chose Specific users and/or groups, select the names of the groups or users
who can perform this activity.
a. Highlight the user or group name in the list on the left and click Add to add
it to the Selection List on the right.
b. Repeat step 3a for each user or group you want to add.
c. When the Selection List includes all the users and groups you want, click Next
or Finish (depending on whether you chose other options at step 1).
4. If you chose Performer alias(es) which will be resolved by the workflow initiator
and 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 type a name and
description for the alias set. The server will create a new alias set using the
information you type 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 type 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 username assigned to it in the alias set.
b. To create a new performer alias, type 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 6a and 6b for each alias you want to include. You can also change
the position of the alias sets in the list by using the up and down arrows after
you select the alias you want to move.
7. Click Finish.
Dene performer alias (performer(s) will be assigned when

workow is underway)
When you select this option, you need to specify which alias set and alias the process
engine 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 27.

To identify the alias set and alias for the performer:

1. Select which alias set to use to resolve the alias.
The options are:
• 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 type a name and
description for the alias set. The server will create a new alias set using the
information you type 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 runtime, 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. Ensure 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.
Select performer based on conditions
You can resolve the performer of a task dynamically based on conditional logic that you
have set up in the activity. The performer is resolved based on process data and on
logic that you define in the decision table.
The left side of the expression defines the conditions based on data from the process
attributes. The right side of the expression enables you to specify the work queue name,
username, or group name that performs the task once the logic has been resolved.
At runtime, the process engine evaluates the rules as they have been set up and assigns a
performer for the activity.
To assign a performer based on conditional logic:

1. Select a performer type that meets the criteria for setting conditional logic.
Valid values are:
• Work queue
• Specific user
• All users in a group
• Single user from a group
• Some users from a group
• Multiple sequential performers
2. In the Select Performer(s) group box, select Select performer based on conditions.
3. Click Next to display a dialog box that you use to define the query.
4. Highlight the row in the Query table that begins with the word IF.
5. From the Query on drop-down list, choose the object to which you want this
condition to apply:
• The running workflow — The condition will check attributes of the
dm_workflow object.
• Process data — The condition will check attributes of the process package or
process variable that you select from the drop-down list.

6. If you are querying on process data , use the Process Data list box to select either a
package or a process variable associated with the process.
7. Based on the selections made in step 5, 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 5.
8. If the attribute you choose has one or more repeating values, 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.
9. Choose a logical comparison operator from the Condition drop-down list and type a
comparison value in the Value text box.
10. Click the row in the Query table that begins with the word SELECT.
11. In the Conditional Performer Selection box, either select a performer from a list,
type a query using DQL (Documentum Query Language), or use process data or
process parameters to assign the performer.
• If you choose to Select from a list of performers, select the performer from
the list.
If you are able to select multiple performers, select a performer name and click
Add to move the performer to the selection list.
• If you choose to Type a DQL Query, type the query into the text box and click
Validate Query to ensure that the query is valid.
• If you choose to Select from Process Data, you can select process data or a
process parameter to assign a performer. Select performer based on process data
and process parameters, page 123 provides more details on using process data
to assign a performer.
You may find that you need to add attributes or elements to some of the data
to complete the performer selection.
— Understanding the data mapping tool, page 145 provides procedures for
using the data mapping tool.
— Using repeating attributes, page 151 provides details on adding and
mapping repeating-valued attributes.
— Mapping package attributes, page 147 provides instructions for exposing
other source attributes of a package that do not currently appear in the tree
Note: The option to select the performer using process data is only valid for the
following performer types: specific user, work queue, single user from a group,
and multiple sequential users.
12. Click OK.
13. To add an additional clause to this condition, click the AND or OR button and
repeat the preceding steps.

When a condition includes multiple clauses, the server uses the rules of natural
precedence to evaluate the expression. That is, clauses connected by AND are
evaluated before clauses connected by OR. For example, suppose the condition has
this form, where the letters represent conditional clauses:
IF A AND B AND C OR D AND E OR F SELECT Performer Name
The server evaluates this condition as follows:
IF (A AND B AND C) OR (D AND E ) OR F SELECT Performer Name
14. When all of the specific conditions are defined, select the performer to which the task
is assigned if none of the conditions are met.
When you have defined all of the conditions, highlight the row in the Query table
that begins with the word ELSE and select the performer to be used if none of the
other conditions apply.
Select performer based on process data and process parameters
You can resolve the performer of an activity dynamically based on process data or process
parameters found in the activity. The performer can be the name of a user, group, or
work queue. In general, only STRING-based attributes can be used to select a performer.
To assign a performer based on process data

1. Select a performer type that meets the criteria for assigning the performer based on
process data.
Valid values are:
• Work queue
• Specific user
• Single user from group
• All users in a group
2. In the Select Perfomer(s) group box, select Select performer based on process data.
3. Click Next to display the process data tree.
4. Expand the nodes of the process data tree and select the package, process variable, or
process parameter used to assign the performer to the task.
You may find that you need to add attributes or elements to some of the data to
complete the performer selection.
• Understanding the data mapping tool, page 145 provides procedures for using
the data mapping tool.
• Using repeating attributes, page 151 provides details on adding and mapping
repeating-valued attributes.

• Mapping package attributes, page 147 provides instructions for exposing other
source attributes of a package that do not currently appear in the tree
Note: Only one attribute can be selected from the process data tree.
5. Click Finish.
The attribute appears in the Expression text box. Placeholders are surrounded by a
dollar sign $ (for example, Work queue: $Var0.name$).
Mapping process data to a work queue skill set

When you create an activity that is performed by a specific work queue, you select the
work queue name and set the required skills for the activity on the Performer tab in the
Activity Inspector. You can use process data mapper to relate process data from packages
or variables to the skills you defined in the work queue. When you map process data to a
skill, the system uses this information to qualify a processor for the task at runtime.
Mapping process data to work queue skills is an optional step. If the skill is not mapped,
the task will not show this skill as required and the skill will not be used in qualifying a
processor.
Note: Before you can set skills for a particular activity, the work queue must be defined
along with the set of skills that are associated with the queue. Additionally, the Java
Method Server must be running in order for the system to use these mappings to assign
a processor at runtime.
To map process data to a work queue skill set:

1. On the Performer tab, select One or more manual performers.
2. Click Select performer.
3. In the Select Performer dialog box, select Work queue from the drop-down list.
4. Select Assign performer(s) now.
5. Click Next.
6. Highlight the name of the work queue that will work on the task.
7. Click Next to display the mapping tool with the list of process data in the left column
and the work queue and related skills in the right column.
8. Use the data mapping tool to associate attributes from the package data to the
predefined work queue skills in the work queue.
See Understanding the data mapping tool, page 145 for details about using the data
mapping tool.
9. Click Finish.

10. Click OK or Apply to save the configuration settings.
Choosing automatic performers

The performer for automatic activities must resolve to a single user. This requirement
limits your choices for automatic activities to the following user categories:
• Workflow supervisor (the workflow initiator by default)
• Repository owner
• Performer of the previous activity
• Particular user
If a particular user is not selected, the server determines the actual user at runtime.
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 Select Performer.
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 are the permissions of 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 or users 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 Choose 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 username appears in the
Selection text box.
d. Click OK.
The selected username appears in the User text box.
4. Click Finish.
The selected username appears in the text box next to the Select Performer button.

Setting activity triggers

A trigger is a signal that the activity can begin. Use the Trigger tab to describe the
conditions that trigger the activity and send the package to the performer’s inbox.
If the activity has more than one incoming flow, you can specify how many of the
previous activities must complete before this activity starts. The trigger condition is the
minimum number of input flows that must have accepted packages for this activity to
begin. For example, if an activity has three input flows, you may decide that the activity
can start when two of the three have accepted packages.
Tip: When an activity has more than one incoming flow, it represents a join activity in
the overall business process. That is, packages following different paths through the
process come together. To display the join action clearly in the business process template,
insert an explicit Join activity template into the flow. The Join activity sets the trigger
conditions for the next activity, which has only one incoming flow — the one from the
Join activity. See Join, page 182.
For more information about activity triggers, see Setting trigger conditions, page 37.
To set when an activity is triggered:

1. In the Activity Inspector, select the Trigger tab.
2. Specify how many of the activities input flows must have been completed before
this activity starts.
• To start this activity only when all immediately preceding activities are complete,
select All input flows are selected.
• To start this activity when some number of its preceding activities are complete,
select This number of input flows selected and type 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 checkbox and type 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 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, select the This
activity can run more than once in a workflow checkbox.

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 24 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.
• Click Apply to save your updates without closing the Activity Inspector.
• Click OK to save your updates and close the Activity Inspector.
Setting warning timers

Process Builder supports two kinds of warning timers for activities:
• A pre-timer takes action if an activity has not been triggered within a designated
amount of time after the workflow starts.
The activity is considered triggered once it is created by the workflow, but not
necessarily acquired by a user. Pre-timers are not activated on the first activity of a
workflow as they are automatically triggered during the workflow’s start.
For more information about workflow timers, see Setting timers, page 38.
When an activity has one or more timer actions set for it, a small clock icon appears in
the lower right corner of the activity’s icon in the process template editor pane.
To set timer actions:

1. In the Activity Inspector, select the Timers tab.
2. To select a calendar for the timer actions, choose a calendar from the Select Calendar
list box.
The list contains all calendars found in the System/Workflow/Calendar folder.
• Select a business calendar to use a custom calendar for timer calculations.
• Select Use Process Calendar to continue using the calendar that has been
specified for the entire process.
• Select No Calendar to use the system calendar for the activity.
Note: If different calendars are selected for both a process and an activity within that
process, the system uses the activity’s calendar for the activity’s timers.
Selecting a calendar for the process, page 77 provides more information on calendars.

Note: When a task first arrives in the user’s inbox, the due date for the task may be
calculated based on the system calendar. The next time the timer job runs, the job
updates the due date according to the business calendar.
3. Click the add + button above the list box to add a new timer, or highlight an existing
timer from the list box.
4. From the Event drop-down list, select which type of timer action to create, either
Pre-Timer expiration or Post-Timer expiration.
5. Specify when the timer should expire by typing the number of elapsed hours and
minutes in the Expire in text boxes.
If this action is the first timer of a given type (pre-timer or post-timer), the timer
expires when the specified number of hours and minutes have elapsed since the
start of the workflow or activity, respectively. Subsequent timers expire when the
specified number of hours and minutes have elapsed since the previous timer expired.
Note: When a workflow task is stopped, the associated post-timer is not stopped.
The post-timer continues to take into account the time designated for the task as
though the task is in progress.
6. To send an email message to a third-party email program when a timer expires
(rather than using their Webtop or Task Space inbox), select the Use email template
checkbox, then click Select and choose the custom email template to use for
notification.
After you select it, the name of the template appears next to the Use email template
checkbox. The server uses the selected email template for all notifications of the
same event type (pre-timer or post-timer). If you do not select the Use email
template checkbox, the server notifies users by sending a default notification to
their Documentum inbox.
An email template is a document in the Documentum repository that defines the
structure of the notification message. See the Documentum Process Builder Development
Guide for information about the structure of a document that serves as an email
template.
a. To open an existing template, navigate to the template it in the file structure
and select it.
b. To Create a new Email template, select the option and click OK.
c. The Notification Template Wizard appears, enabling you to create a new
email template dynamically. Using the Notification Template Wizard, page
138 provides instructions on using the wizard to create an email template.
7. To have the server continue to repeat the final pre-timer or post-timer action until the
activity is completed, select the Repeat last action checkbox.

You set the value of the Repeat last action option separately for pre-timer and
post-timer actions. When it is selected, the server will perform the last timer action at
the specified time interval until the activity is completed.
8. From the Action drop-down list, select the type of action to take when the timer
expires.
The available options depend on whether you are defining a pre-timer or post-timer
and on the nature of the current activity:
• Notification — Enables Sending a notification, page 129 message to one or more
people.
• Start Process — EnablesStarting a process, page 130 using the current activity’s
packages.
• Run JAVA Method — Enables Running a Java method, page 131 (available for
users with superuser privileges only).
• Delegate Task — Enables Delegating a task, page 131 to another performer
(available for manual activity post-timers only). A task can also be delegated
to a performer based on process data.
• Complete Task — Enables Completing a task, page 132 and forwarding it to the
next activity in the workflow (available for manual post-timers only).
9. Repeat steps 2 to 7 for each timer you want to add to this activity.
10. To change the order of a timer in the list box, highlight the timer action and click
the up or down arrow buttons at the top of the list box.
The order is important because the expiration time for a timer is expressed as a
certain interval after the preceding timer expires.
Sending a notication
Use this option to send an email notification to a person when the timer expires
To send a notication:
1. Click the Select button that appears next to the Send notification to text box to
identify the people to notify when the timer expires.
You can send notifications based on Groups & Users, an Alias, or Process Data.
2. To send the notification to Groups & Users, select the radio button.
a. Highlight the user or group name in the left half of the dialog box.

The Users in Group box shows the members of the group selected in the Groups
box, enabling you to select individual members of the group.
b. Click Add >> to move you selections to the selection list.
c. Click OK.
3. To send the notification to users who fill a particular Alias, select the radio button.
a. Select the alias set in the left half of the dialog box.
The Performer Alias box displays the aliases associated with the alias set. When
you select any of these aliases, the system displays the name the alias set is
assigned to as well as the description for the performer alias.
b. Click Add >> to move the selection to the list box on the right.
c. Click OK.
4. To send a notification based on Process Data, click the radio button.
The system displays the process data tree.
a. Expand the nodes of the process data tree and select the attributes you want
to select for the notification.
• Understanding the data mapping tool, page 145 provides procedures for
• Using repeating attributes, page 151 provides details on adding and
• Mapping package attributes, page 147 provides instructions for exposing
c. Click OK.
Starting a process
Use this option to start a workflow when the timer expires.
To start a process:
1. Click the Select button that appears next to the Start Process text box.
2. Select the process template for the process to start.
The selected template must accept the same number and type of packages as the
current activity.

3. Select the users to be notified.

Sending a notification, page 129 provides more details on selecting users for
notifications.
4. Click OK.
Running a Java method

Use this option to run a Java method when the timer expires.
To start a Java method:

1. Click the Select button that appears next to the Method text box.
2. Select the workflow method for the expired timer to run and click OK.
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 Documentum Process
Builder Development Guide for details about developing custom workflow methods.
3. Select the Yes, save the execution results checkbox to save an execution log when
the method runs.
notifications.
Delegating a task
Use this option to delegate a task when the timer expires.
To delegate a task:
1. Click the Select button that appears next to the To Performers text box.
The Select Performer dialog box appears. You can assign performers based on
Groups & Users, an Alias, or Process Data.
2. To select a performer based on Groups & Users, select the radio button.
a. Highlight the user or group name in the left half of the dialog box.
The Users in Group box shows the members of the group selected in the Groups
box, which enables you to select individual members of the group.
b. Click Add >> to move you selections to the selection list.

c. Click OK.
3. To select a performer from a particular Alias, select the radio button.
a. Select the alias set in the left half of the dialog box.
The Performer Alias dialog box displays the aliases associated with the alias set.
When you select any of these aliases, the system displays the name the alias set is
assigned to as well as the description for the performer alias.
c. Click OK.
4. To select a performer based on Process Data, click the radio button.
The system displays the process data tree.
a. Expand the nodes of the process data tree and select the performer attribute.
• Understanding the data mapping tool, page 145 provides procedures for
• Using repeating attributes, page 151 provides details on adding and
• Mapping package attributes, page 147 provides instructions for exposing
c. Click OK.
Completing a task
Use this option to complete a task when the timer expires.
When completing a task automatically, you may want to set an attribute to a particular
value, so that an activity transition condition can route it differently based on that
attribute value.
To complete a task:
1. To have the timer set an attribute value when completing the task, select the Change
process data attributes checkbox. If you do not select this checkbox, skip to step 3.
2. From the Process Data drop-down list, select the process variable or package whose
attribute the timer will set a value for.
3. From the Attribute drop-down list, select the attribute whose value the timer will set.

4. If the attribute you chose can have more than one value, indicate which index values
to use in this condition by selecting one of the four options in Index list box or by
typing a valid index value.
5. In the Value text box, type the value to which the timer will set the selected attribute.
notifications.
Setting activity transition rules

Transition rules determine which activities are next in the workflow. The flow is changed
based on the transition logic that is defined using process data. When an activity has
multiple outgoing flows, you may want packages sent to all of the following activities,
or you may want packages sent to only some of the following activities depending on
the outcome of the activity. For example, you might give a performer who reviews the
design of a new form the choice of forwarding the design to the next reviewer or to send
it back to the designer for revision. You set up this branching logic by creating flows
from this activity to the two possible following activities, then allowing the performer
to choose which path to follow.
Tip: When an activity has multiple outgoing flows with branching logic, it represents a
decision point in the overall business process. To display the decision point clearly in
the business process template, insert an explicit Decision Split activity template into the
flow. Instead of setting the branching logic in the current activity, connect the current
activity to a single Decision Split activity and set the branching logic in the Decision
Split activity. See Decision Split, page 181.
If an activity has only one outgoing flow, there is no need to set a transition condition.
The Transition tab is unavailable with the Select all connected activities option selected.
For automatic activities, you generally should not choose the Let the activity’s performer
choose option, unless the automatic workflow method for the activity uses the setoutput
method to choose the next activities. Documentum Process Builder Development Guide
provides more details on this subject.
Defining activity transitions, page 40 provides more details on transitions
To dene the transition action:

1. In the Activity Inspector, select the Transition tab.
2. Determine how the activity chooses which following activities to send packages to:
• To send the task to all following activities connected to this one (including any
reject flows), choose Select all connected activities.

• To let the performer decide which activities are selected when the current activity
completes, choose Let the performer select the next activities.
• To route packages to different activities based on a set of conditions, choose
Select next activities based on these conditions.
If you select to route packages based on a set of conditions, skip to step 6.
3. If the activity is performed by multiple performers — that is, if on the Performer tab
you selected All users in group or Some users from a group — specify how many
performers must complete the task:
• To require that all performers complete the task, select the All performers
complete the task radio button.
• To complete the activity when a certain number of performers complete the task,
select the [ ] performers complete the task radio button and type the required
number of performers in the text box. If the number you type 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.
If you chose Select all connected activities at step 2, skip to step 7.
4. If you let the performer select the next activities, specify the maximum number of
activities the performer can select using the Select up to [ ] activities drop-down
list box.
The list box displays the total number of available next activities by default. You can
select any number between 1 and this maximum. At runtime, the server will not
allow the performer to select more than the specified number of activities.
5. If you let a group of performers select the next activities — that is, if the performer
category is All users in group or Some users from a group and the transition option
is Let performer select the next activity — specify when to forward packages to the
selected next activities.
• To start selected reject activities immediately, select the Any performer rejects
radio button. If any performer selects reject activities, the activities are started
without waiting for other responses. All other performers’ selections are ignored.
• To start selected forward activities immediately, select the Any performer
forwards radio button. If any performer selects forward activities, the activities
are started without waiting for other responses. All other performers’ selections
are ignored.

• To start the selected next activities only after the number of performers identified
in step 3 have completed the task, select 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, select 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 135 for information about creating transition
conditions.
• Click Apply to save your updates without closing the Activity Inspector
Creating transition conditions

When you choose the Select next activities based on these conditions option, a table
appears showing the defined transition conditions. When you first define an activity,
the table is blank. Follow this procedure to add transition conditions for automatically
choosing the next activities in the workflow. For more information about transition
conditions, see Defining activity transitions, page 40.
Note: When an activity uses transition conditions, the flows that lead to the next
activities have a diamond at the start of the flow line. This format follows the Business
Process Modeling Notation (BPMN) standard.
To create a transition condition:

1. Highlight the row in the Query table that begins with the word IF.
2. From the Query on drop-down list, 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.
• Process Data — The condition will check attributes of the process package or
process variable that you select from the drop-down list.
3. If you are querying on Process Data, use the list box to select either a package or a
process variable associated with the process.
4. If you select an input package that is an XML document and you want this condition
to check a value of an internal XML element, select the XPath Expr checkbox and
identify the XML element whose value you want to use in the condition.
a. In the Schema text box, type the fully qualified name of the XML schema to
which the document in the package conforms. You can type the name into the
text box, click Local to choose the schema from the local file system, or click
Repository to choose the schema from the Documentum repository.
This step is optional. If the schema is not available, leave the text box blank.
b. In the XPath expression text box, create the XPath expression to the element you
want to use in the condition. If you selected a schema at step a, you can click
the Select button to choose from a list of valid XPath expressions. If you did not
select a schema at step a, click the Write-in Expression link and type the full
XPath expression in the dialog box that appears. After typing the expression,
select the XML data type of the identified element and click OK.
5. If you did not select the XPath Expr checkbox, choose the Documentum repository
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 2.
If you have chosen a simple data type as a process variable (string, Boolean, integer,
double, or date), the list will be unavailable. Structured data types do appear in the
box for selection.
If a drop-down list labeled Repeating attribute, choose or type an index appears, it
means that the attribute you chose can have more than one value. Indicate which
index values to use in this condition by selecting one of the four options in the list,
or by typing a valid index value. 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.
6. Specify the test to perform on the selected attribute.
Choose a logical comparison operator from the Condition drop-down list and type a
comparison value in the Value text box. The data type for the selected attribute is
shown below the box.
7. Select the activities to perform next when this condition is true by highlighting the
activity names in the list box at the bottom of the page.

The list displays the names of the activities connected to this activity by flows. To
select more than one activity, hold down the Ctrl or Shift key when clicking the
activity names.
Note: You must select an activity now even if you plan to add additional clauses to
the condition.
8. To add an additional clause to this transition condition, click the AND or OR button
next to the Add another clause label and repeat steps 2 through 6.
When a condition includes multiple clauses, the server uses the rules of natural
precedence to evaluate the expression. That is, clauses connected by AND are
evaluated before clauses connected by OR. For example, suppose the condition has
this form, where the letters represent conditional clauses:
IF A AND B AND C OR D AND E OR F SELECT Activity 1
The server evaluates this condition as follows:
IF (A AND B AND C) OR (D AND E )OR F SELECT Activity 1
9. To add another transition condition, click the + button above the query box (which
adds a row starting ELSE IF), then repeat steps 2 to 7.
10. When all of the specific transition conditions are defined, select the activities to
which packages are routed if none of the conditions are met.
When you have defined all of the transition conditions, highlight the row in the
Query table that begins with the word ELSE and select the activities to perform
if none of the other conditions apply.
Setting notications
On the Notification tab, you can set the messages that the server sends in response
to workflow-related events such as activity state changes, a method failure during an
automatic event, and so on. Users registered to receive notification of the event will
receive a message constructed using the email template associated with the event.
Setting up notifications, page 39 provides more details on this subject. You can also send
notifications in response to workflow timers. Setting warning timers, page 127 provides
more details on this subject.
Note: The server does not send a notification At the start of a work item for automatic
activities.
To specify the email messages used for notications:

1. In the Activity Inspector, select the Notification tab.
The tab displays the names of the events for which notifications are sent. The name
of the email template used for the notification appears below the event name.

2. To use a custom email template in place of the default notification message for an
event, select the Change email template check box next to the event name.
The Select button becomes active when the check box is selected.
a. Select the option to Create a new Email template or you can Open an existing
template from within the repository to use for that event.
Using the Notification Template Wizard, page 138 provides instructions on how
to create a new email template.
b. The name of the email template appears below the event name.
3. Repeat step 2 for each of the events for which the system sends an email notification,
as necessary.
Using the Notication Template Wizard

Use the Notification Template Wizard to create email templates dynamically from within
an activity. The email notification templates can be based on process data, enabling you
to Templates are saved to /System/Workflow/EmailTemplates folder. Templates can be
shared among processes, although it is not recommended since templates are based on
mappings and process data specific to a process.
Note: Editing the mappings in the notification template changes the template throughout
the system. All activities using the template will be immediately updated to reflect
any changes you make.
The list of default notification senders and recipients is based upon the type of event. The
system sends the notification to the default recipient in addition to any recipients that are
specified by the mappings. If the email From field is mapped to a value, the mapped
value overrides the default sender and the system uses only the mapped sender value.
Table 6. Default sender and recipient based on event
Event name Description Default sender Default

recipient
dm_startedworkitem New task is User whose action Task
created has triggered performer
the new task
generation such
as the performer of
previous activity

Event name Description Default sender Default

recipient
dm_delegatedworkitem Task is delegated User who delegated Target user
or reassigned the task
dm_changedactivityin- Automatic task Task performer Workflow
stancestate has failed supervisor
Pre-timer expires Pre-timer Repository install Users/groups
expires owner selected to be
notified in the
pre-timer list
Post-timer expires Post-timer Repository install Users/groups
expires owner selected to be
notified in the
post timer list
To create a new email template

1. Select the option to Create a new Email template and click OK.
2. Type the template name using alphanumeric characters only.
Spaces, underscores, or special characters are not permitted.
3. Type the subject for the notification.
You can use static text or placeholders that are mapped to process data to represent
dynamic text.
• Placeholders are prefixed with a dollar sign $ (for example, $orderno for an
order number).
• Use two dollar signs $$ to create multivalued placeholders.
• To use a literal dollar sign in the notification, use \$ (for example, five hundred
dollars would be expressed as \$500.00).
Note: Placeholder values must be alphanumeric characters without spaces. The
placeholder starts after the dollar sign $ and ends with first non-alphanumeric
character.
For example, to send a message indicating that a purchase order was processed
successfully, you would use the following template text: Purchase Order $orderno
successfully processed. The placeholder orderno appears in the data mapping screen
and can be mapped to a package or process variable. The notification sent have the
following subject: Purchase Order 0896523 successfully processed, where 0896523 is the
substituted value from the response data mapping.
Note: All placeholder values must be mapped to process data.
4. Type the email template text in the Body Template text box.

You can include static text, HTML copied in from a third-party HTML editor, and
placeholder parameters that can be mapped to process data.
If you are including HTML markup in the email body, you must map the constant
value text/html to the Content-Type in the Body node of the email message. If
Content-Type is not mapped to a value, the content-type is by default text/plain.
• Placeholders are prefixed with a dollar sign $ (for example, $orderno).
• Use two dollar signs $$ to create multi-valued placeholders.
• To use a literal dollar sign in the email body, use \$ (for example, five hundred
Note: Placeholder values must be alphanumeric characters without spaces.
The placeholder token starts after the dollar sign $ and ends with first
non-alphanumeric character. Additionally, all placeholder values must be
mapped to process data.
5. Click Next to create the input message mapping associating process data to the
email message.
The email message structure appears in the right-hand pane and the process data on
the left side. You can set values for email message attributes by mapping them from
attributes of the process data model. If you have multiple email attachments, you
can click Add on the Attachment node to add more attachments.
Note: The system invokes the email template once for each user that is defined in the
Notification field. When a recipient is also mapped in the email template, one email
is sent to that recipient for each user defined in the Timer tab. If there are three users
selected to be notified and a recipient is mapped to the To: field in the template, the
system sends a notification to each of the three users and also sends three copies of
the notifications to the user specified in the To: mapping.
complete the mappings.
Understanding the data mapping tool, page 145 provides procedures for using the
data mapping tool.
Using repeating attributes, page 151 provides details on adding and mapping
Mapping package attributes, page 147 provides instructions for exposing other
Note: All placeholder nodes under the Subject and Body nodes must be mapped at
this point. Recipient fields are not required to be mapped.
6. Click Next to map the output message.
For example, if you added a process variable MsgId, you can map the notification
message ID attribute from the source message to that process variable.

data mapping tool.
7. Click OK.
The template becomes the default template for specific notification for which you
have created it.
Changing process data in an activity

When you configure an activity, you need to specify what process data is worked
on during the activity and define how the activity deals with each package, process
parameter, or process variable that is part of the process template. Process data is
defined on the Data tab of the Process Properties component. Managing packages, page
69 provides more information on adding process data to the process template.
The Data tab of the Activity Inspector displays a tree view of the process data organized
into the categories associated with either the packages, process parameters, or process
variables used in the process. The list box displays the available information about the
process data such as the type, version, and other attributes specific to the process data.
To view information about the individual packages, process parameters, or process
variables, highlight the specific node for Packages, Process Parameters, or Process
Variables. For packages, the name, type, and version fields are read-only and can only
be changed from the Process Properties page. Process variable and process parameter
information can be changed from the node view.
You can change how the activity handles the process data by selecting or clearing the
checkboxes that are available on the Data tab.
To edit existing package process data:

1. In the Activity Inspector, select the Data tab.
2. Expand the Packages node and select one of the packages in the tree.
The list of packages comes from the process template definition.
3. From the Form drop-down list, select the form template (if any) to use for displaying
this package to the activity performer.

The form template assigned to the package in the Process Properties dialog box
appears by default. Only form templates that use the same data model as the default
form template are displayed in the drop-down list. See Associating form templates
with packages, page 37 for details about using forms in a workflow.
If no form template is assigned to the package, the Task Manager uses the default
options for displaying the contents of the package, which usually enables the user
to open it in the application associated with the document type, such as Microsoft
Word for Word documents.
4. To use the form you selected in step 3 to display the properties of the package, select
the Use Form for Properties checkbox.
When the Use Form for Properties checkbox is not selected, the form from step 3
appears when the performer of an activity selects the package from his or her inbox.
The form is used to save the content of the package. When the checkbox is selected,
the form appears when the performer views the package properties. The form is
used to set the package’s properties in the repository, not the content of the package.
5. To make this package available to the performer of this activity, select the Visible at
this activity checkbox.
If the Visible at this activity checkbox is not selected, the activity performer does not
see this package. The package is still available for transition conditions, however.
6. To require that the package have a content object associated with it, select This is
a mandatory package.
If the checkbox is not selected, the activity performer can assign content to this
package, but need not do so.
7. To enable Process Builder to publish reporting data to the BAM database for the
package, select This package can be used to generate reports.
8. Repeat steps 2 through 6 for each package in the process.
• Click Apply to save your updates without closing the Activity Inspector
To launch a package automatically from a manual activity:

1. Highlight the Packages node.
The page display changes to show only the packages associated with the process
flow.
2. Click Auto-Launch Package to have a package or associated Form display
automatically when the activity starts.
This option enables this package to display right away. By default, when a performer
starts an activity from the inbox, Task Manager appears and displays each package as

a link. The performer clicks a link to display the package (through the form assigned
to the package or application associated with the document type).
3. Select the package name to be launched from the drop-down list.
To change existing process variables:

1. Highlight the Process Variables node.
The page display changes to show only the process variables associated with the
process template.
2. To make variables available to the performer of this activity, select the This variable
is visible at this activity checkbox.
If this checkbox is not selected, the activity performer does not see this variable.
3. To expose this variable and use it to generate reports, select the This variable can
be used to generate reports checkbox.
To edit existing process parameters:

1. Highlight the Process Parameters node.
The page display changes to show the process parameters associated with the
process template.
2. To expose this variable and use it to generate reports, select the This variable can
be used to generate reports checkbox.
Changing display settings

The options on the Display tab control how the activity appears in the visual display
of the process template.
Note: When an activity has one or more timer actions set for it, a small clock icon appears
in the lower right corner of the activity’s icon in the process template editor pane.
To change the display settings for an activity:

1. In the Activity Inspector, select the Display tab.
2. To change the graphic that represents the activity in the template, click one of the
Browse buttons that appear to the right of the Image file box, navigate to the file
containing the graphic, and click Open.
The two Browse buttons enable you to search for images in the Documentum
repository (Browse Repository) or in the local file system (Browse Local). If you
select an image from outside of the standard location for activity images (which is
the repository folder System/Workflow/Images), Process Builder automatically saves

a copy of the image in the folder when you save the activity. If you use Browse
Local to select an image outside of the standard image directory C:\Program
Files\Documentum\BPM\classes\images, Process Builder imports the image file
into the System/Workflow/Images repository folder.
The selected file appears in the Image file box.
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. Specify whether to display a label for the activity by selecting or clearing the Show
Label checkbox.
If you clear Show Label, skip steps 5 and 6.
5. Choose whether to display a label for the activity with its activity Name or the
Performer.
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. Set the font and style used to label the activity in the template.
a. Select a font from the Label font list.
• Click Apply to save your updates without closing the Activity Inspector.

Chapter 8
Mapping Process Data Elements
This chapter describes how to use the data mapping feature of Process Builder from within an activity
template and includes the following topics:
• Understanding the data mapping tool, page 145
• Adding or editing process data in the mapper, page 147
• Mapping package attributes, page 147
• Adding message properties, page 148
• Adding an XML schema to activity content , page 149
• Adding a node based on a condition, page 149
• Mapping the data, page 150
• Understanding message correlation, page 157
Understanding the data mapping tool

The data mapping tool provides a graphical data mapping tool that simplifies the
process of passing workflow data. The tool enables you to map data between process
data, process parameters, or workflow attributes on the left side of the window to server
or workflow attributes on the right side of the window. This can include data sources
such as workflow method arguments, web service parameters, database query return
values, and attributes specific to services such as JMS, HTTP, FTP, and so on.
Additionally, when defining performers, you can use the data mapper to relate process
data from packages or variables in the flow to the skills that you defined in the work
queue.
Many automated activities require mapping information from one data source to
another. For example, suppose a loan-origination process includes an activity that calls a
web service to look up a customer’s credit score. The activity needs to pass the social
security number from the loan application package to the web service, and it needs
to copy the returned credit score into another package attribute so that it is available

to subsequent activities. The graphical mapping tool enables you to map data from
package attributes to the web service input parameters and from the web service output
message to package attributes.
Figure 6. Mapping an HTTP Inbound message to process data
The data mapping tool has three columns:

• The left column displays the available data sources in a collapsible tree control.
• The right column displays the available data destinations in a collapsible tree control.

• The center column is the mapping area, which contains boxes that represent data
mapping functions and lines that connect the boxes to their input sources and output
destinations.
The contents of the left and right columns depend on the type of activity you are
configuring. For activities for which you need to provide input values, the left column
typically shows the attributes for all business process packages, process variables, and
the runtime execution variables, such as the name of the supervisor, that are available at
runtime.
The center column displays the functions used to transfer data from one or more data
sources on the left to a data destination on the right. The mapping tool enables you to
copy values directly from one data source to another, perform data type conversions,
concatenate strings, perform mathematical operations on numbers, and include constant
values. See Using data mapping functions, page 153 for a list of the available functions.
You can map data to or from the lowest level items in the tree controls, the "leaves" of the
tree, using the + or — icon to expand or collapse the tree. Data types exposed in the tree
include packages, process variables, execution data, and process parameters.
Adding or editing process data in the mapper

You can add or edit many of the individual elements of the data tree by selecting the Edit
link and launching the Process Data Edit Dialog. Using the data editor, you can create,
update, and delete elements from the data tree of the mapper and change the process
model as needed during the design of the process without having to exit the designer
and launch the Process Properties dialog box.
Whenever you see a green plus sign icon on a node, package, or data attribute, it
signifies that you can add or edit the data associated with that location in the process data.
Mapping package attributes

For packages on both sides of the mapper, the tree displays only selected attributes by
default. It displays all custom attributes for the package’s object type plus a selection of
commonly used standard attributes. The package node also displays the following three
additional attributes that enables you to map content to other sources:
• content-type: MIME type string representation of the content in the package
• format: name of the format object (dm_format) that is associated with the content
• data: actual content of the package

In addition, a package will contain the r_object_id attribute. The r_object_id

attribute contains the object ID of the package.
By default, only basic package attributes appear in the mapper. To complete a mapping,
you may have to expose other attributes of a package that do not currently appear in
the tree.
To show additional package attributes:

1. Right-click the package name and select Show More Attributes.
When you select a package in the mapper, a dialog box appears with the complete
list of attributes for the package’s object type.
2. Highlight the attributes you want to make available for mapping.
Hold the Shift or Ctrl keys to select multiple attributes.
3. Click OK to close the dialog box.
The selected attributes are added to the list in the tree control, in alphabetical order.
The newly added attributes are labeled <New>. They are now available for mapping.
Note: If you do not map the added attributes to a function, they will not reappear
when you save the activity and reopen the Activity Inspector.
Adding message properties

There may be times when you need to add a service-specific property to a message in
order to complete a mapping. In this case, you can add the property to the message, but
you must ensure that it is added to the correct node and that it is named correctly. There
is no validation for added message properties.
To add properties to a message:

1. Right-click the message property node in the tree.
2. From the menu, select Add.
The Data Mapper Parameter dialog box appears.
3. To add a property to the mapper, click .
The new, undefined property is added to the tree.
4. Type in the Display Name and the Full Name of the property.
5. Select the Type of property that you are adding.
6. Click OK to add this property to the message.

Note: If you do not map the added properties to a function, they will not be saved
when you reopen the Activity Inspector.
Adding an XML schema to activity content

You can associate an XML schema with attachment or package content or with the
content received from external sources (such as HTTP or JMS services) and use the
mapper to map elements from the schema. Before attaching the schema to a node in the
data mapper tree, modify the schema to change all schema import statements containing
relative URLs to use absolute URLs.
The data node expands once a XML schema is associated with the content data. If a
package is associated with a form that uses an XML schema, the content data node
automatically displays the XML schema associated with the form.
Note: If the value that you are mapping is based on an enumeration set, you can view
the list of available values by right-clicking the value and selecting Show Enumeration.
To add an XML schema:

1. In the tree of attributes, navigate to the Data element.
2. Right-click Data and select Add Element to display the Schema Dialog.
3. Click Browse to select a schema from the repository.
4. Select an Element of the schema to use in the mapping.
5. Select a Translator to use when transforming the message body to a required format,
if necessary.
Adding a node based on a condition

Use the Conditional Node Builder to add a node to the data tree that uses an expression
built using the child attributes the node. This option is available for some repeating
nodes that have more than one attribute and for the Workitem node located within
the Execution Data parent node.
To add a condition to a node:

1. Right-click the node and select Show Condition Builder.
2. Expand the data tree and select element upon which you are creating the expression.
3. Select the element, the operator, and type the value to use in creating the expression.

4. Click the Insert Expression button to create the expression.

The expression appears in the text box.
5. Click OK.
The new node appears in the data tree along with the text of the expression. If the
text of the expression is not visible in its entirety, right click the node and open the
Conditional Node Builder to view the complete text of the expression.
Mapping the data

The center column contains boxes representing data mapping functions and lines
connecting the function boxes to their input arguments and output destinations. At
runtime, the activity passes the values of the input arguments to the function, and saves
the result as the value of the destination attribute.
You create one mapping function at a time. The data mapping tool requires you to
complete one mapping (by selecting its input parameters and output destination) before
starting on the next mapping. Whenever process data is mapped, the corresponding
format or content type needs to be mapped, as well. This is validated for any service.
All of the data mapping functions work on single-valued attributes and repeating-valued
attributes. When the input argument is a repeating-valued attribute, or a query with
multiple result rows, the data mapper function uses any or all of the repeating values.
When it writes its result into the destination attribute, the new result overwrites any
existing value or adds a new attribute value. See Using repeating attributes, page 151 for
details on mapping repeating-valued attributes.
To map data:
1. Select a function from the list box above the mapping area in the center column.
See Using data mapping functions, page 153 for information about the available
functions.
An icon representing the function appears in the mapping area. A red X in the lower
right corner indicates that the function does not yet have its required arguments.
When you have provided it with all of its required arguments (at step 4 or 5 below),
the X no longer appears.
The function list box remains unavailable as long as the current function is invalid.
You can only define one function at a time.
2. Drag the function box to the location where you want it to appear.
The position of the function box is purely a visual consideration. Its position does
not affect the order of execution.

3. From the left column, select the attributes whose values will be the input data for
the function.
You select an attribute by clicking its name. A line appears in the mapping area,
connecting the selected attribute to the current function box. If the data type of
the selected attribute does not match the data type the function expects, the line is
dashed. The system will attempt to convert the value to the required data type at
runtime. Clicking the attribute name a second time clears it and removes the line.
If the current function accepts multiple input values, you can select multiple
attributes from the left column. By default, the attributes are added to the function’s
list of input arguments in the order you select them. See step 5 for information
about modifying the order of arguments.
If the attribute you want is already linked to another function, you can link it to
the current function by clicking the Line drawing mode button (to the right of
the function list at the top of the center column) and drawing a line from the black
diamond at the left end of the previous selection line to the box representing the
function.
In some cases, you may want to define a function that does not use any attributes as
input data. That is, all of the input values are constants. In these cases, skip this step
and type the relevant constant values at step 5.
4. From the right column, select the attribute into which the activity will write the
result of applying the function.
You can select only one attribute from the right column for each mapping function.
5. Modify the function’s input arguments if necessary.
Double-click the function box to display the Function Editor dialog box. The dialog
box displays the name of the function, its syntax, and a list of the input values. The
names of the attributes you selected at step 3 appear in XPath format. Using this
dialog box, you can change the order of the attributes or add constants as additional
input values. Using data mapping functions, page 153 provides more details on
this subject.
Click OK to close the dialog box.
6. Repeat steps 1 through 5 for each data-mapping function you want to create.
Using repeating attributes

The Input Message Mapping and Output Message Mapping screen of all activity
templates provides support for multivalued attributes.
A multivalued attribute has an Add link next to its name. Use the Add link to create a
node that represents a specific index of multivalued attributes. When you click Add,
the system creates a new node with a default index value. To change the index value,

double-click the index value to launch the Repeating Index dialog box where you can
select FIRST/LAST or type a numeric value.
To copy a single-valued attribute to a specic index of multivalued

attributes:
1. In the target tree, create a node representing the specific index of the multivalued
attribute.
2. Select the single-valued attribute node in the source tree by clicking the
single-attribute node.
3. Select the node that represents the specific index of the multivalued attribute in
the target tree.
To copy the specic index of a multivalued attribute to a single-valued

attribute:
1. In the source tree, create a node that represents the specific index of the multivalued
attribute.
2. Select the node that represents the specific index of the multivalued attribute in
the source tree.
3. Select the node that represents the single-attribute node in the source tree.
To copy all values of a multivalued attribute to a specic index of

multivalued indexes:
1. In the target tree, create node representing specific index of the multivalued attribute.
2. Select the node representing all values (the index value for this node will be ALL)
in the source tree.
3. Select the node representing the single-attribute node in the source tree.
4. Launch the function dialog box by double-clicking on the functoid.
5. In the function dialog box, select FOR-EACH as the value for Input Context, and
select Over-Write, Insert Before, or Insert After as the value of Output Context.
When using Insert After or Insert Before options, the values are inserted after
or before the index. When using the Overwrite option, the existing values are
overwritten
Input context
Depending on the Input Context option selected for a mapping rule, all values of a
multivalued attribute are either passed to the mapping function as arguments (ALL

option) or the mapping rule function is executed once for each value (FOR-EACH). The
Input Context option can be viewed or updated from the function dialog box.
Using data mapping functions

A list of the available functions appears in a list box above the mapping area. When you
select a function from the list, an icon representing it appears in the mapping area. After
linking the function to its input arguments and output destination (as detailed in the
section Mapping the data, page 150), you may need to use the Function Editor dialog
box to complete the function definition. The Function Editor enables you to modify a
function’s order of input arguments, and also to add constant input arguments whose
values do not come from process data.
Double-click the function box to display the Function Editor dialog box. The dialog box
displays the name of the function, its syntax, and a list of the expected input values. The
names of the input attributes linked to the function appear in XPath format. If the value
that you are mapping is based on an enumeration set, you can view a list that shows the
enumerations values of the destination node of the function.
• To change the order of the input arguments, highlight one of the arguments and click
the up or down arrow button to move it to its new location in the list.
• To add a constant to the list of input arguments, highlight the argument that will
precede the constant and click the + button. A new line appears below the line you
highlighted. Type the constant value on the new line.
Note: You cannot add a new package attribute to the function using this dialog
box. To add a new package attribute, return to the mapping screen and select it
from the left column.
• To remove a constant from the list of input arguments, highlight it and click the
— button.
Note: You cannot remove a package attribute from the list using this dialog box. To
remove a package attribute, return to the mapping screen and clear it from the left
column.
The following table lists available functions.
Table 7. Data Mapping Functions
Function Input Arguments Result

Add Two or more numbers. Sum of the input
arguments.


Add Business Day An integer date value, a Adds a business day to the
string for the calendar, noOfDays value. The value
and an integer for the for a business day is based
noOfDays. on the selected business
calendar.
Add Days An integer date value Returns a date after adding
and an integer for the the specified number of
noOfDays. days to the date.
Byte To String Two strings, the first Data as a string.
representing the binary
data, and the second
specifying its encoding
value, such as UTF-8,
UNICODE, and so on.
Default encoding value is
UTF-8.
Concat Two or more strings. Concatenated string
consisting of the input
arguments in order.
Copy One argument of any type. Unchanged input
argument.
Count Object param[]): Returns the number of
values in the multi-value
input. For single value
inputs, the return in 1.
Date to String A date and a string Date value as a string with
representing a valid date the specified pattern.
pattern.
The date pattern must
conform to the standard
Java SimpleDateFormat.
For details, refer to the
Java API and developer
reference documentation
located on the Sun
developer website.


Divide Two or more numbers. Result of dividing the
first input argument by
the second argument.
When there are more
than two arguments, each
subsequent number is used
to divide the previous
result.
Get Day Integer. Returns an integer that

represents the day segment
of the date.
GetEmailAddress String. Queries dm_user to return
an email address for a user.
Get Month Integer. Returns an integer that
represents the month
segment of the date.
Get Value String parameter that Returns a value from a
specifies the object and the specified position in the
index position number. index.
Get Year Integer. Returns an integer that
represents the year
segment of the date.
Join Two or more string arrays. Creates a join of the
selected inputs.
Multiply Two or more numbers. Product of the input
arguments.
Split String that can include an Returns a repeating
optional index position string or a position in
value. the repeating value if the
optional index position is
used.


String To Byte Two strings, the first Binary data.
representing the data, and
the second specifying its
encoding value, such as
UTF-8, UNICODE, and so
on. Default encoding value
is UTF-8.
String to Date Two strings, the first giving Value of Date data type.
a date and the second
specifying its pattern.
The date pattern must
conform to the standard
Java SimpleDateFormat.
For details, refer to the
Java API and developer
reference documentation
located on the Sun
developer website.
Substring A string, a number String consisting of
representing how many characters from the first
of the initial characters to input argument, starting
remove from the string, from the specified start
and optionally a number position and ending at the
representing the position of specified end position.
the last character to include
in the substring. For example, if the input
arguments are "unhappy"
and 2, the result is the
string "happy". If the input
arguments are "unhappy",
2, and 5, the result is "hap".
Subtract Two or more numbers. Result of subtracting the

second number from
the first number. When
there are more than two
numbers, each subsequent
number is subtracted from
the previous result.


ToLower String. Converts the string to
lower case letters.
ToUpper String. Converts the string to

upper case letters.
Understanding message correlation

Process Builder must be able to match an inbound message to a unique instance of
a workflow in order to process the incoming data. Process Builder uses correlation sets
and correlation identifiers that are made up of unique data to match the response to the
original request.
For example, in one activity of a purchasing process, a JMS message is sent to the
supplier requesting information on whether an item from a purchase order has shipped.
The message specifies both the vendor ID number and the item purchase order number.
The system uses these numbers to match the message to the process instance. Later,
the vendor’s system replies with a shipping status message for purchase order which
includes both the vendor ID and the purchase order number. When these identifiers
are mapped to the appropriate process data, the system can match the request to the
response and continue the workflow.
Using correlation identiers

When a process instance starts, the Process Engine creates a unique correlation_identifier
attribute in dm_workflow to identify the process. When an inbound step activity
receives this identifier in a message, it can match the message to the process instance
based on this value without having to use the correlation set.
In order to use this message property, the receiver of the message must have the same
identifier in its response. In other words, the correlation_identifier must have been
sent out at some point earlier in the process for the system to be able to receive it in
the incoming message. For example, when the message is sent to a vendor requesting
information on a purchase order, the system-generated correlation identifier is sent in
the outgoing message. When the inbound message also contains the same correlation
identifier, the system uses it to match the message to the process instance.
The fields that contains the correlation identifiers are configured in each inbound step
activity template on the configuration page where you define the connection, protocol,
and processing instructions. This identifier is specific to the protocol of the message. For

many inbound messages, unique properties of the message such as data in the message
header or a unique filename can contain the correlation identifier to match the message
to a process instance. If there is no match between these values, the system will use the
specified correlation set to match the message to a process instance.
Table 8. Fields used to congure correlation ID
Activity template Field name Example

JMS Inbound - Step N/A Use the JMS header CorrelationId
HTTP Inbound - Step Correlation MessageID
Property
Email Inbound - Step Correlation Subject
Header
FTP Inbound - Step Correlation po_$id$.txt
Pattern
Web Service Inbound - Step N/A Use the WS-Addressing header
MessageID
Using correlation sets

If a correlation ID has not been configured for an activity or if the correlation ID is
missing from an incoming message, the system looks for a correlation set mapping to
match the message to a workflow. A correlation set is a collection of process variables
that you define for an activity. In most business processes, there are unique attributes
of process data that can be identified and used to match incoming data to a process
instance. These mappings are created using the data mapping tool within the activity
template, where you can match incoming message data to existing process data.
Correlation sets are defined at the process level on the Advanced tab of the Process
Properties component. From the list of process variables that are associated with the
workflow, you name the correlation set and add the attributes to it that you will use for
the correlation mapping. For example, you can use a unique purchase order number
and a name to match messages to a process instance. If the purchase order and name are
passed in all messages that are sent to and from the instance of the process, then those
values can be used to match response and request messages. You can create a correlation
set named Purchase Order and within it, select the process variables for purchase order
number and address. In the data mapping tool, you would then link the attributes for
the purchase order number and address from the incoming message attributes.
A correlation set can have more than one correlation identifier and a process can
use multiple correlation sets, if necessary. You can only select one correlation set for

mapping within an activity. For example in a process flow that manages product orders
from vendors, you can create Correlation Set 1 (purchase order number and vendor ID)
and Correlation Set 2 (address and ZIP code) and use them when mapping messages
within inbound activities.
The data that a correlation set uses must exist or be set in the process before the workflow
reaches the activity that uses the correlation set. The data can be set in the activity using
an initiate activity or another step activity earlier in the process.
Note: Process variables that will be used in correlation sets should not have default
values. Process variables that have default values do not possess the unique attribute
characteristics required to match an incoming message to a single instance of a process.
If the system cannot find a unique match, the runtime process halts with an error.
Creating correlation sets, page 78 gives more details on defining correlation sets for
a process.


Chapter 9
Debugging a Process Template
This chapter introduces the basic concepts of debugging a Process Builder process template. The
following topics are included:
• Understanding the process debugger, page 161
• Preparing to debug the process, page 164
• Testing a process in the debugger, page 167
Understanding the process debugger

Process Builder’s debugger enables you to test the design of a process template
interactively by setting breakpoints, running through the process, examining and
modifying process data, testing integrations, and acquiring and acting upon tasks
within the process.
Debugging a process before deploying it to a production environment helps to ensure
that the process flow you have designed satisfies the original business requirements
upon which you have based your design. Using the debugger to troubleshoot a process
enables you to test a process from within the process design environment without
having to save, validate, or install the process. You can also test activities as you are
developing them to ensure that you have configured a complex process flow correctly.
Executing a particular path within a flow can also give you important feedback during
the development process.
Debugging takes place in the local environment. When the process runs in debug mode,
the server does not create actual work items or queue items. Any changes that you
make to process variables are only kept on the local system for the life of the debugging
session. They are not saved after the session has ended. However, the server does save
changes made to the objects in the package or attachments during the debug session
and overwrites the existing attribute data. The system also creates any objects that are
needed for automatic activities within the process such as renditions or attachments
created through mapping rules.

When the system executes a manual activity, the system automatically acquires and
completes the activity enabling you to run through the entire process without stopping
at that particular activity. To manually complete an activity or to perform another
manual function on the activity, you can set a breakpoint on the activity. This enables
you to execute the functions that a performer might take such as select the next activity
in a transition or modify process data.
When you set a breakpoint on an automatic activity and choose to step into the activity,
you can view the input and output messages, rerun a failed task, and alter process data
that is associated with the activity.
As the debugger runs through the different activities of the process flow, it marks
progress through the flow with a bold line. This is especially useful when following the
progress through a flow that has transitions with different potential paths. When the
debugger is ready to execute an activity, a green arrow appears above it indicating that
the work item has been created and the performer has acquired it.

Figure 7. Manual activity in debugger
After the system runs through the process, it displays a message that the workflow is
complete in both the Task Manager and the Console tabs. At this point you still have
access to the process in debug mode and can view the messages from the Process Engine
using the Console tab.
Using the process debug environment

The Process Debugger window is divided into two panes:
• The top pane contains the graphical representation of the process template and
displays the progress of the debugging process, and any breakpoints that have been
added to the process.

• The bottom pane is comprised of the following tabs:

— Task Manager tab that manages the execution options for manual and automatic
tasks,
— Process Data tab that enables you to view, add packages, and edit process data.
— Console tab that displays messages from the Process Engine.
— Manage Workflow tab that enables you to send an event to the workflow.
You can control the size of the two panes by positioning the cursor over the border
between them and dragging the border to a new position.
The following table lists the icons used in the buttons and other elements of the interface.
Table 9. Process debugger graphical elements and their purpose
Graphical element Purpose

Launches the process in debug mode
or reruns the process in debug mode.
Adds or removes a breakpoint.
Identifies all current activities in

the workflow. The workitem has
been created and acquired by the
performer. The arrow only appears
for activities that require manual
intervention or have breakpoints.
Identifies an activity that has already
been executed in the debugger.
Identifies an activity where a

breakpoint has been set.
Preparing to debug the process

You can debug processes that are saved to the Documentum repository or you can debug
a process while you are designing it. Process do not need to be saved to be tested in the
process debugger.

Adding breakpoints
Breakpoints enable you to stop the process flow at a specific activity in order to change
process data, add packages, and view the execution information for the task. You can
add breakpoints for any number of manual or automatic activities.
When running through a process in debug mode, the system stops before each activity
that has a breakpoint, enabling you to open the activity and add content to packages and
to view or modify process data before executing the activity. If the activity is manual,
you can finish, reject, or otherwise complete the activity before the flow continues. With
an automatic activity, you can open the activity, execute the task and see the input and
output of the activity as well as any error messages.
To add a breakpoint:
1. Select the activity within the process.
To select multiple activities, hold down the Shift key as you click each of the activities.
2. Click the Toggle Breakpoint button to set the breakpoint on the activity.
To remove a breakpoint:
1. Select an activity within the process that has a breakpoint.
2. Click the Toggle Breakpoint button to remove the breakpoint from the activity.
Starting a workow in the debugger

You can debug a saved process template from the repository or you can debug a process
as you are designing it before you have saved it. Once the process is open in the process
editor, start the debugger, you select an initiate activity to begin the process. You can add
packages or attachments to the process and edit package data and process variables in
order to test different combinations of data in the process flow.
Note: You can only debug one process at a time. If the debugger is open in a tab, the
debugger icon appears in the tab next to the process name. The system will not launch a
new instance of the debugger until you have exited the current debugging session.
To start a debug session using a manual initiate activity:

1. Open a process template in the process template editor.
2. Click the Debug Process icon or select Debug > Start Process Debug to launch
the Debug Process dialog box.
3. Type a name for the workflow in the Workflow Name text box.

4. Select Start a workflow using manual Initiate activity.

5. On the Packages node, click Attach and select the content for each package you
want to test.
You must add content to each mandatory package.
6. If necessary, you can edit attributes by expanding the node, clicking any that is
available for editing and typing the new value in the text box.
Some attributes such as r_object_id cannot be edited and appear as grayed out.
Note: Changes made to the package attributes in the debugger are saved to the
repository and overwrite the existing package attribute data.
7. Expand the Variables node to edit the values by right-clicking any editable field
and selecting Edit Value.
Changes made to process variables are only kept on the local system for the life of
the debug process. They will not be saved after the process debugger session ends.
8. To assign an ad hoc attachment to the workflow, click Attach
9. Click Start Workflow to begin the debug process.
The Process Debug window appears enabling you to view and test the process.
Testing a process in the debugger, page 167 provides detailed instructions on testing
the process.
To start a debug session using an inbound initiate activity:

Note: Before debugging an HTTP Inbound or Web Service Inbound initiate activity, you
must specify the port number to be used for the listener in the Preferences dialog. Setting
the port number for debugging inbound activities, page 47 provides instructions for
setting the port number. Other inbound activities use the pollers that are specified in
the configuration of the activity.
1. Open a process template in the process template editor.
2. Click the Debug Process icon or select or select Debug > Start Process Debug to
launch the Debug Process dialog box.
3. If you will use an inbound initiate activity to debug the process, select Start
workflow using inbound initiate listeners.
The system starts the listener for the message type associated with the activity and
begins listening for the message start request specific to that protocol.
4. Click Start Listeners to begin the debug process.
The Process Debug window appears enabling you to view the process flow. Once
the process receives the message, the workflow begins.
Testing a process in the debugger, page 167 provides detailed instructions on testing
the process.

Testing a process in the debugger

You can choose to run a process straight through without having any breakpoints or you
can stop at the activities for which you’ve defined breakpoints and test the activity
interactively using the process debug window. You can perform manual tasks and run
automatic tasks, set different values for process variables and packages, and send events
to the workflow. Using the Console tab, you can view the message from the Process
Engine that assist you in troubleshooting the process.
In addition, there are several toolbar buttons that enable different functions in the
process debug window.
Table 10. Process debugger buttons
Button Purpose
Step Over to Next Activity advances the
debugger to the next activity even if there
is no breakpoint set.
Step Into the execution of the current activity
enables you to view the details of the
automatic activity. The activity executes but
does not continue on to the next activity.
You must step into an automatic activity to
view the service messages associated with
the execution of the activity. You can make
changes to the activity’s mappings and
configuration, rerun the activity if it has
failed, and perform other troubleshooting
functions.
Rerun Debug reruns the process from the
beginning of the flow and without having
to reload process data.
• For packages or attachments, the process
runs with the same data that it ended the
workflow with. If there were changes
made to a package or attachment during
the workflow, those changes are saved to
the repository and the process starts over
using the changed attributes.
• For process variables, the process runs
with the attributes that were originally
front-loaded into the debugger. If there
were changes made to process variables,

Button Purpose
those changes are not saved, so the
process runs with the original values.
This option is only available after the
process has been completed. You cannot
rerun a partially completed process.
Continue to Next Breakpoint enables you to
move to the next breakpoint in the process.
Stop Debug terminates the debug process
and deletes the workflow and workitems
that were created for the debug session.
Exit Debug Session exits the debugger and
returns to the process template editor.
The system deletes the workflow and all
workitems that were created for the debug
session.
Using the Task Manager tab

The Task Manager tab enables you to perform different tasks for both manual and
automatic activities. The tab displays the state of the workitem in the activity (for
example, acquired) .
Managing a manual task
By default, manual tasks are acquired and completed by the system enabling the process
to run through the debug process without intervention. When you place a breakpoint on
a manual activity, you can select the content for a package, modify process variables, and
perform the task-related functions based on the activity. Some of these functions include:
• Reject a task.
• Acquire a task and complete it.
• Select the next activity when there is a transition condition that is determined by
performers
• View the details of a workitem’s skill names and skill values.
• View the workitem ID and the performer name for tasks with multiple performers
and multiple workitems.
• Force the completion of a task.

• Finish all workitems for a task with multiple workitems.

The Documentum Webtop User Guide , the Documentum TaskSpace User Guide, and the
Documentum TaskSpace Configuration Guide provide details on the different actions
available for managing manual tasks.
Managing an automatic task
When you step into an automatic activity, the debugger executes the current activity and
displays the protocol-specific input and output messages, as well as any exceptions.
These messages enable you to view the communication between systems that the process
integrates with such as external web services databases and helps to troubleshoot any
problems.
In addition, you can open the Activity Inspector and edit any of the properties of the
activity with exceptions. After editing an activity with exceptions, you can rerun the
activity to ensure that the activity completes without errors.
To complete an activity that has errors that you cannot correct, click Force Complete
Task and the system will complete the activity and move on in the process.
When you set a breakpoint on an automatic activity, you can perform the following
functions:
• Step into the execution of the activity.
• Add or update packages or attachments before the activity executes.
Note: If you select the Step Into the execution of the current activity, the activity
executes immediately and you cannot changes packages or attachments.
• Execute the task and then view input and output messages as well as exception
messages from the Process Engine.
• Rerun a failed task.
• Force the completion of a task even if the activity has failed.
• Continue to the next breakpoint.
When you place a breakpoint on an automatic activity, you can step into the activity
and trigger the execution of the activity. This enables you to view any input or output
messages, as well as any errors or exceptions. For example, if you invoke a web service,
you can view the request and response information.
Similarly, you can view the input messages for each specific protocol. For example, the
text of a SOAP request appears in the message window enabling you to copy it and
paste it into a text editor. You can also view the text of the response message (the SOAP
response) and any subsequent updates to the process data.

Debugging automatic workow methods
Several of the activity templates delivered with Process Builder execute automatic
methods that extend from WorkflowMethod. These activity templates are:
• Create Folder
• Link to Folder
• XSLT Transformation
The code for these automatic methods are located in the bpsintegration.jar file. During
the installation process, the Process Builder installer places these files in the C:/Program
Files/Documentum/BPM/classes/custom directory so that they are available to the
process debugger.
If a process contains custom Java methods, the methods must extend from
WorkflowMethod. If the Java methods do not extend from WorkflowMethod (instead,
they implement IDfMethod), they cannot be executed from the debugger and will result
in an error. Use the Force Complete Task button to complete the task and continue
debugging the process.
To execute a custom Java method:

1. Write a custom Java method that extends from WorkflowMethod.
2. Create a dm_method object in the repository.
This enables the automatic method to appear in the drop-down list box for selection
in the Activity Inspector.
3. Create a .jar file (or the classes with the full package structure) for the
custom Java code and place the .jar file (or classes) in the C:/Program
Files/Documentum/bpm/classes/custom directory.
This enables the debugger to load the .jar file or classes for the execution of the
custom method.
4. Launch the process debugger and execute the process.
Note: Debug messages written to the PrintWriter appear in the Console tab.
Using the Process Data tab

Use the Process Data tab to view the attributes of the data associated with the activity
and to perform in-line editing of process data. You can add or update packages or change
variables for the current instance in the process. Click the Refresh Process Data button
to fetch data in the event that another parallel activity has had a change in process data.

To edit process data:

1. Click the package attribute or process variable and type in a new value.
2. Press Enter on your keyboard or select Save.
3. To view content of an attachment or a package, navigate to the content node and
click the link to View Content. The debugger will display the content in the
appropriate editor or application in another window.
Note: Changes made to the package attributes in the debugger are saved to the
repository and overwrite the existing package attribute data. Changes made to process
variables are only kept on the local system for the life of the debug process. They will not
be saved after the process debugger session has ended.
Using the Console tab

The Console tab displays messages from the Process Engine about the status of the
process. These messages include when the workflow was started, which workitems were
created, acquired, completed, if an email notification was sent, and so on. The Console
tab also displays debug message from services used in the process.
Protocol messages show the message exchanged between the service and the process:
• For outbound messages, the Input Messages text box displays the message sent
from the process to the external service and the Output Messages text box displays
the message from the service.
• For inbound messages, the Input Messages text box represents the message received
by the process from the external service and the Output Messages text box is the
message sent from the process to the service.
For HTTP and web service protocols, the message is a close approximation of the
message that is transmitted over the network. For other services, the message uses XML
format representing the tree structure of the data mapping.
In the case of binary data, the message displays the location of the file in the file system
where the content is stored. Once the workflow has completed in the debugger, the
file is deleted.
For example:
<Attachment>
<Name>test2<Name>
<Content-Type>text/plain<Content-Type>
<Data>C:\Documents and Settings\meenar\
message_files\7bafbf6f-baae-4a16-b240-8335fb7f2d65.dat<Data>
</Attachment>

Note: Messaging errors do not appear in the tab, but are available in the Exception text
box of the Task Manager tab for any automatic activities that use messaging.
Using the Manage Workow tab

The Manage Workflow tab enables you to send an event to the workflow in order to
complete a task or continue debugging the process.
The name must match the name of the event that the workflow is waiting for (specified
on the Trigger tab of the waiting activity in the workflow).
To send an event to the workow:

1. Type the event name in the Send Event to workflow field.
2. Click Send.

Appendix A
Delivered Activity Templates
Process Builder comes with a set of predefined activity templates for common business process tasks.
The templates are available in the Activity Templates window of the Resource Navigator and are
organized in a tree structure that reflects the type of task each one represents. For example, the
Content Services node has activity templates related to basic content management functions, and the
Integration node has templates for activities that send workflow process data to external participants
using the messaging features of Documentum Process Integrator.
You can create custom activity templates to supplement the delivered templates. See Creating activity
templates, page 104. Process Builder includes a Sample Activity Template that illustrates the format
of the activity template XML file to help you create custom activity templates. It appears on the
Sample activity node.
This appendix describes each of these activity templates and the special parameters they require you
to type when creating an activity from them. The standard activity templates are:
Content Services, page 175
• Create Folder, page 175
• Lifecycle, page 176
• Lifecycle Apply, page 176
• Link To Folder, page 178
• ECIS (Enterprise Content Integration Services), page 179
Flow , page 181
• Decision Split, page 181
• Join, page 182
• Post Event to Parent Process, page 182
• XSL Transformation, page 183
Integration , page 183
• BOF Module, page 184
• Database Inbound — Initiate and Step, page 186
• Database Read, page 188

• Database Stored Procedure, page 190

• Database Write, page 193
• DQL Inbound — Initiate and Step, page 195
• DQL Read, page 197
• DQL Write, page 197
• Dynamic Web Service, page 198
• Email Inbound — Initiate and Step, page 206
• Fax Outbound, page 208
• FTP, page 236
• FTP Inbound — Initiate and Step, page 211
• FTP Outbound, page 214
• HTTP Inbound — Initiate and Step, page 215
• HTTP Outbound, page 218
• JMS Inbound — Initiate and Step, page 220
• JMS Outbound, page 222
• Process Data Mapping, page 223
• SMTP , page 224
• Invoke Process, page 226
• Web Service, page 227
• Web Service Inbound - Initiate and Step, page 229
Note: Inbound activity templates require the BPS.war file to be deployed on the application server.
Sample, page 231
• Set Queue Task Skill, page 232
• Queue Task Rework Decision, page 232
Deprecated activity templates, page 233
• HTTP Post, page 237
• Lifecycle Demote, page 239
• Lifecycle Promote, page 240
• Observation Point, page 241
• Publish to JMS Topic, page 236
• Send to JMS Queue, page 237
• Send to MQ JMS, page 238
• SMTP, page 234
• Start Sub-Process, page 234

Content Services
The activity templates in the Content Services window enable you to include basic
content management tasks in your business processes.
Activities based on these templates display only three tabs in the Activity Inspector: the
Performer tab (which identifies the workflow method to run), the Definition tab, and a
custom tab. The other standard Activity Inspector tabs are not relevant for content
services activities.
The activities in the Content Services window are:
• Create Folder, page 175
• Lifecycle Apply, page 176
• Lifecycle Demote, page 239
• Link To Folder, page 178
• ECIS (Enterprise Content Integration Services), page 179
Create Folder
Activities based on this template create a new folder in the repository based on a given
folder name or on a folder template. To configure the activity, you provide a name for
the new folder and specify the path to the location in the folder hierarchy where you
want to create it.
• New Folder Name — Type name of the new folder. The name can include
substitution variables. Click the ... button to display a dialog box from which you
can select from the available variables.
• Create From Folder Template (optional) — Select a predefined folder template
from the repository. The folder template enables you to create a copy of the folder
including nested folders, with the root name of the folder template used as the new
folder name.
• Destination Folder — Click the ... button to navigate to the parent folder in which the
new folder will be created. When you freclick OK in the dialog box, the name of the
parent folder appears in the data field.
• Or Type In Path To Folder — Enter the full path to an existing parent folder in
which the new folder will be created, starting with a backslash and the name of the
top-level cabinet (for example, /System/Workflow). When you type the folder path
rather than selecting it, you can include one or more substitution variables in the
path specification. Click the ... button to display a dialog box from which you can
select from the available variables, including package variables.

• Link Folder to Package — Link the entire folder to the package that you select from
the drop-down list.
Lifecycle Apply
Note: This activity template is only supported for Documentum Process Builder version
6.5. If an earlier version of Process Builder is used against a Documentum 6.5 repository,
this template will not open.
Activities based on this template apply a document lifecycle to a package in the business
process. A lifecycle defines an ordered series of states that correspond to the stages of
a document’s life.
To configure a Lifecycle Apply activity, you choose the lifecycle to apply and which
lifecycle will be applied to the process data. You also specify the initial state of the
lifecycle and the scope to use when resolving any aliases associated with the lifecycle.
See the Documentum Composer User Guide for details about creating and using lifecycles
1. From the list box, select the lifecycle to apply to the package.
2. Select the Select the Scope to use for resolving any aliases associated with the
selected lifecycle.
This is the key to the dm_alias_set type for retrieving the alias value mapping
defined there. The values in the drop-down appear based upon the lifecycle.
The Initial State to which the package will be set appears in a the text box.
3. Click Next to use the data mapper to map the attributes that apply a lifecycle to
the object.
Required mapping — The following parameters must be mapped to process data:
1. r_object_id identifies the object to which the lifecycle is applied.
Lifecycle
Activities based on this template move the object’s lifecycle to another state. Four
lifecycle operations can be performed on the object:
• Promote, which advances the object to the state specified in the input mapper.
• Demote, which demotes the object from its current normal state to the previous
normal state or to the base state if the demote_to_base_state parameter is set to true.

• Suspend, which temporarily stops an object’s progression through assigned lifecycle

states.
• Resume, which resumes the object that has been in a paused lifecycle state.
To change a lifecycle operation:

1. Select the lifecycle operation to which you want to move the object.
2. Click Next to use the data mapper to map the attributes that change the lifecycle
state of the object.
Hints for the required and optional mappings for each lifecycle appear on the
configuration page for you to reference.
data mapping tool.
Table 11. Lifecycle template mappings
Operation Requirement Description

Promote Required r_object_id identifies the object to be promoted.
Optional state identifies the desired target state. The
default is the next state.
Optional override_entry_checks set to true will ignore
the configured lifecycle state entry checks.
(Each lifecycle state has a set of entry criteria
that a document normally must meet in order
to be promoted to that state.) The default is
false.
Demote Required r_object_id identifies the object to be demoted.
Optional state identifies the desired target state. The
default is the previous state.

Operation Requirement Description

Optional demote_to_base_state set to true to force
demotion to base state. The default is false.
Supersedes state.
If both the state and the demote_to_base_state

are mapped, then demote_to_base_state
supersedes the state mapping.
Suspend Required r_object_id identifies the object to be
suspended.
Optional state identifies the desired target state (default
is the suspended state associated with the
current state).
Optional override_entry_checks set to true to ignore
configured lifecycle state entry checks (default
is false).
Resume Required r_object_id identifies the object to be resumed.
Optional state identifies the desired target state (default
is the resumed state associated with the current
state).
Optional override_entry_checks set to true to ignore
configured lifecycle state entry checks (default
is false).
Optional resume_from_base_state set to true to force
moving object to base state (default is false).
Supersedes state.
Optional If both state and resume_from_base_state
are mapped, then resume_from_base_state
supersedes the state mapping.
Link To Folder
Activities based on this template add the objects from one or more packages into a
specified folder in the repository. To configure the activity, you specify the name and
location of the folder. The activity can copy the specified packages into the folder
(retaining their links to other folders where they may reside) or move the packages into
the folder (unlinking them from other folders). If the specified folder does not exist,
the activity can create it.

• Or Type In Path To Folder — Enter the full path to an existing parent folder in
which the new folder will be created, starting with a backslash and the name of the
top-level cabinet (for example, /System/Workflow). When you type the folder path
rather than selecting it, you can include one or more substitution variables in the
path specification. Click the ... button to display a dialog box from which you can
select from the available variables, including package variables.
• Link Folder to Package — Link the entire folder to the package that you select from
the drop-down list.
• Package(s) — Click the ... button to display a dialog box from which you can select
the process packages whose contents you want to link into the repository folder.
Highlight the package name in the list on the left and click the Add button to move it
to the list of selected packages on the right. When you click OK in the dialog box, the
names of the selected packages appear in the data field.
• New Folder Name — Type name of the new folder. The name can include
substitution variables. Click the ... button to display a dialog box from which you
can select from the available variables.
• Create New Folder If Not Exists — Select Yes to have the system create a folder with
the specified name if it does not already exist.
• Create From Folder Template (optional) — Select a predefined folder template
from the repository. The folder template enables you to create a copy of the folder
including nested folders, with the root name of the folder template used as the new
folder name.
• Destination Folder — Click the ... button to navigate to the parent folder in which
the new folder will be linked. When you click OK in the dialog box, the name of the
parent folder appears in the data field.
• Or Type In Path To Destination Folder — Enter the full path to the parent of the
folder into which the contents will be linked, starting with a backslash and the name
of the top-level cabinet. When you type the folder path rather than selecting it, you
can include one or more substitution variables in the path specification. Click the ...
button to display a dialog box from which you can select from the available variables.
• Unlink From Original Folder(s) — Select Yes to have the activity move the packages
into the specified folder, unlinking them from other folders or select No to copy the
packages into the folder, retaining any links to other folders. The default is No.
• Link Folder To Package — To attach the folder object to the business process, select
the package to attach it to from the list box.
ECIS (Enterprise Content Integration Services)

This activity template enables an ECIS search based on pre-configured search criteria.
The search results can include HTML pages, Word documents, PDF files, images, and

so on, and are saved in the ECIS Search Results folder and are displayed in the order
specified in the Save ECIS Results with rank up to(0-1) field.
The ECIS activity template can be used to search across multiple targets such as FileNet
and Open Text servers, external websites, and other Documentum repositories that
ECIS adapters are able to access.
A pre-configured ECIS search is executed based on the Name keyword automatically in
the following websites:
• http://www.google.com
• http://www.cnn.com
• http://www.interpol.int/
• http://www.fbi.gov/
• http://www.dhs.gov/dhspublic/
• http://europa.eu/pol/cfsp/index_en.htm
• http://news.bbc.co.uk/
• Factiva
• Current repository
• Open directory
Note: These search targets are configured in the ECIS Admin Center. The Documentum
ECI Services Administration Guide gives more details on how to configure search targets.
Configure the following fields to enable the activity template to search for content.
• Search String — Type the search string that defines the information on which you are
searching or click the ellipsis (...) button next to the field to select a pre-configured
search string from a dialog box.
• Temp ECIS Results File Path — Type the full path of the temporary results file path.
The temporary file is used to save content from an external source. After saving it to
a local file, it is imported into the repository.
• Save ECIS Results under Cabinet — Type the cabinet name that will store your results.
• Save ECIS Results in Folder — Type the folder name of the results file in the
repository.
• Save ECIS Results with rank up to(0-1) — Type the value to be used in evaluating
which results are saved. The number you type here is the lowest relevance ranking
percentage that the system saves. For example, to save results that match 50% to
100% of the search criteria, type .5. To save search criteria that meets at least 20% of
the search criteria, type .2

Flow
You use the activity templates on the Flow node to control the flow of work through the
business process. The activities on the node are:
• Decision Split, page 181
• Join, page 182
• Post Event to Parent Process, page 182
• Start Sub-Process, page 234
• XSL Transformation, page 183
Decision Split
The Decision Split activity template enables you to display decision points explicitly in a
business process template. Rather than specifying the branching logic on the Transition
tab of an activity that performs some other action, you add an activity whose only action
is to evaluate the branching logic and forward packages as appropriate. Separating the
decision from other actions can make the process flow clearer.
Figure 8. Approval process without and with decision split activity
When you add a Decision Split activity, link the preceding activity to just the Decision
Split activity and set its transition to Select all connected activities. Set the branching
logic on the Transition tab of the Decision Split activity.
The Decision Split activity template does not include any custom tabs or fields. When
you view an activity created with the Decision Split template in the Activity Inspector,
only the Timers, Transition, Data, and Display tabs appear. These tabs contain all of the
settings relevant to a decision point activity.

Join
The Join activity template enables you to include activities to evaluate trigger conditions
when multiple flows converge in a business process. Rather than specifying the trigger
conditions on the Trigger tab of an activity that performs some other action, you add an
activity whose only action is to evaluate the trigger conditions and forward packages as
appropriate. The Join activity waits for a certain number of its preceding activities to
complete, then forwards its packages to the next activity. The next activity does not need
to evaluate trigger conditions, because the Join activity has already done so.
Figure 9. Review process without and with join activity
The Join activity template does not include any custom tabs or fields. When you view
an activity created with the Join template in the Activity Inspector, only the Trigger,
Timers, Data, and Display tabs appear. These tabs contain all of the settings relevant to
a join activity.
Post Event to Parent Process

Activities based on the Post Event to Parent Process template work in conjunction with
Invoke Process activities to enable synchronous sub-processes. A parent workflow
launches a new sub-process using a Invoke Process activity, then waits for a particular
event to be posted to it before continuing. The child sub-process uses a Post Event to
Parent Process activity to post the event, allowing the parent process to continue.
• Event Name — The name of the event to post to the parent workflow. The name
must match the name of the event that the parent workflow is waiting for (specified
on the Trigger tab of the waiting activity in the parent workflow).
• Supervisor Name — Select the user on whose behalf the event is posted.

XSL Transformation
The XSL Transformation activity template creates activities that perform a transformation
on an XML file. An activity based on this template retrieves XML content from a
workflow package, applies an XSL file to it, then attaches the transformed file as another
workflow package.
• Transform content in package — The name of the workflow package that contains
the XML content.
• Transform using this XSL file — Click the button next to the field to select the XSL
file to use for transforming the XML content. The XSL file must be stored in the
repository.
• Attach result as content in package — The name of the workflow package into which
the transformed content is written. You must specify a valid package defined for the
process.
• Transformed output format — Specifies whether to save the transformed output in
XML or HTML format.
Integration
The activity templates in the Integration window provide means of exchanging data
between the business process and external systems or external performers. Several of
the templates provide a wizard-like interface for defining how data is passed from one
data source to another.
Note: Inbound activity templates require the BPS.war file to be deployed on the
application server.
The activities on the Integration node are:
• BOF Module, page 184
• Database Inbound — Initiate and Step, page 186
• Database Read, page 188
• Database Stored Procedure, page 190
• Database Write, page 193
• DQL Inbound — Initiate and Step, page 195
• DQL Read, page 197
• DQL Write, page 197
• Dynamic Web Service, page 198
• Email Inbound — Initiate and Step, page 206
• Fax Outbound, page 208

• FTP, page 236

• FTP Inbound — Initiate and Step, page 211
• FTP Outbound, page 214
• HTTP Inbound — Initiate and Step, page 215
• HTTP Outbound, page 218
• HTTP Post, page 237
• JMS Inbound — Initiate and Step, page 220
• JMS Outbound, page 222
• Process Data Mapping, page 223
• SMTP , page 224
• Invoke Process, page 226
• Web Service, page 227
BOF Module
Activities based on this template run a Java method that has been packaged as a module
using Documentum’s Business Object Framework (BOF). You use the data mapping tool
to provide values for the method’s input parameters and to map any return values into
package attributes so that they are available to subsequent activities.
Note: The data type of the parameters and the return value must be a Java primitive
type, Byte[] (and/or byte[]), a DataSource object, or a JavaBean object. BLOB (Binary
Large Object) and binary data are represented as Byte Array. Char data type is not
currently supported.
For information about packaging a Java method as a BOF module, see the Documentum
Foundation Classes Development Guide.
To congure a BOF Module activity:

1. In the Activity Inspector, click the BOF Module Configuration tab.
2. Select the BOF module to run.
a. Click Select. A selection dialog box appears, showing the contents of the
\System\Modules folder.
b. Navigate to the module you want to run and highlight it.
c. Click OK. The dialog box closes and the name of the module appears in the
BOF Module box. Process Builder populates the Interface and Method list
boxes based on the selected module.
3. Select the interface and method to run from the list boxes.

4. Click Next.
The Next button is unavailable until you have typed values for all required fields on
the current page.
5. If the selected method has input parameters, provide values for the parameters
On the Input Message Mapping screen, the right column of the data mapping
tool shows the input parameters for the method. The left column shows package
attributes and the workflow substitution variables. You can map the value of the
data attribute of a package as an input argument for a method as Byte[] (and/or
byte[]). You can also map the entire content, that is, data and content-type, of a
package to a DataSource. See Understanding the data mapping tool, page 145 for
details about using the data mapping tool.
If the selected method does not have input parameters, the Input Message Mapping
screen does not appear. Skip to step 7.
6. Click Next.
If the selected method does not have output values, the Next button is unavailable.
Skip the next step.
7. Use the data mapping tool to save the output values as package attribute values.
On the Output Message Mapping screen, the left column of the data mapping
tool shows the output values from the method. The right column shows package
attributes.
In Output Message Mapping, a method can return a value to a package as Byte[]
(and/or byte[]). However, you must manually set the format of the package content
to a string value. You can also write the content of a DataSource to a package by
mapping the data attribute value of the DataSource to the data attribute of the
package.
mapping tool.
At runtime, if the destination package exists, the data attribute value of the package
is replaced by the data from the DataSource or Byte[] (and/or byte[]). In case of
DataSource, the format attribute value of the destination package is replaced by the
format value of the DataSource. If the destination package does not exist, a new
package is created. The data and format of the source package is copied to the new
package. However, if the source package does not have a format mapping, then the
value for the format attribute in the destination package is set to "crtext".

Database Inbound — Initiate and Step

Use the Database Inbound activity template to retrieve rows from a database table or
view and create workflows or complete an activity. The system creates a listener at
runtime that executes the specified select statement to retrieve rows for processing.
After the row is processed, a user-defined SQL statement updates or deletes the row to
ensure that it not processed multiple times.
For example, a company has a database application that queries an inventory table to find
items that need restocking. The Database Inbound activity can query the table of items
that need restocking and in order to start a purchase order process for the required items.
The Database Inbound activity template fetches records from one table or one view only.
Each row starts a new process instance or completes a step activity. Each record must
have columns that can be used to uniquely identify the record. In addition, one row in
the database must correspond to only one event. For example, if an expense report has
several line items associated with it, they must be stored in a separate table.
To congure the Database Inbound activity template:

1. Open the Database Inbound activity template.
2. Select the JDBC driver to use from the JDBC Driver list box.
3. In the Connection String box, type the JDBC connection string to use for connecting
to the database.
The expected syntax of the connection string appears below the box when you select
the JDBC driver.
4. Enter the username and password to use for connecting to the database.
5. Click Test Connection to have Process Builder connect to the database.
If Process Builder is able to connect to the database using the information you
provided in steps 2 through 4, a message appears in green below the Connection
String box. If the connection is unsuccessful, a red message appears below the box.
Modify the values and try again.
6. Type the Select statement in the Query to Run box.
The statement must start with the SQL keyword select.
7. Click the Validate Query button.
Process Builder checks the validity of the query and displays a message immediately
below the text box containing the query.
If the query is not valid, the message is the error message from the database. Revise
the query to make it valid.
8. For step activities only, select a column name as the Correlation ID for the system to
use to match the retrieved data to the workflow.

The column contains the appropriate correlation ID related to the specific workflow
instance.
A correlation ID is a unique string associated with each process instance and can be
used to identify a workflow and match the message to it. The correlation ID must
be set in a preceding activity such as a Database Write activity. Using correlation
identifiers, page 157 provides instructions on using correlation in messages.
9. Type a SQL delete or update statement as the Statement to Postprocess that will
mark the records as processed.
To create a query using parameters with values that come from package attributes or
runtime workflow variables, type a question mark (?) where you want the value to
be substituted. The question mark represents a parameter whose value the activity
will insert at runtime.
For example, a query that updates a customer record based on Social Security
Number (after processing the record) includes a question mark in place of a specific
SSN value:
UPDATE from CUSTOMER WHERE ssn=?
The Update statement can include any number of parameters, each represented
by a question mark. Each parameter must be mapped to process data on the data
mapping page. Do not include quotes around the question mark.
Note: Ensure that row can be uniquely identified during post-processing so that
the system only processes a single row.
10. For queries that include substitution parameters, identify the alias name/column
name for each parameter.
If the query does not include any parameters, skip this step.
a. Click the Set Parameters Type button. A dialog box appears with a list of
parameters corresponding to the number of question marks in the query. The
parameter names are param1, param2, and so on.
b. Highlight the row for one of the parameters.
c. Click the value in the Column Name/Alias column and select the column name
or column alias for the parameter from the list box. The column name or column
alias of the parameter must match the corresponding database column to which
the parameters maps in the post processing query.
d. Repeat steps b and c for each parameter.
e. Click OK to close the dialog box.
11. Type the Fetch Size to specify the number of rows to be fetched by the JDBC driver
when more rows are needed for processing during each polling cycle.
12. Type the number of seconds used as the Polling Frequency after which the system
checks the table for new records.

13. Type the Number of Processors to set the number of threads processing the records
concurrently.
14. Click Next to map the data from the result set to the process data model.
source attributes of a package that do not currently appear in the tree.
Database Read
Activities based on this template connect to an external database and return the results of
a SQL Select statement. The database read activity also supports exchange of content
from BLOB data type in Oracle, and Bytes data type in Microsoft SQL Server, to a
package.
Note: The supported data types for database parameters are: CHAR, VARCHAR,
NVARCHAR_TYPE, BIGINT, INTEGER, SMALLINT, TINYINT, BIT, DOUBLE, FLOAT,
NUMERIC, DECIMAL, REAL, DATE, TIME, TIMESTAMP, BOOLEAN, BINARY, BLOB,
LONGVARBINARY, VARBINARY.
To define the activity, you identify the JDBC driver to use to connect to the database and
specify the Select statement to run. You use the data mapping tool to provide values for
any substitution variables in the Select statement and to copy the query results into
package attributes.
To congure a Database Read activity:

1. In the Activity Inspector, click the Database Configuration tab.
to the database.
the JDBC driver.

6. Type the Select statement in the Query to Run box.
The statement must start with the SQL keyword Select. To create a query using
parameters whose values come from package attributes or runtime workflow
variables, type a question mark (?) where you want the value to be substituted. The
question mark represents a parameter whose value the activity will insert at runtime.
For example, a query that looks up a customer record based on a Social Security
number includes a question mark in place of a specific SSN value:
Select * from CUSTOMER where ssn=?
The Select statement can include any number of parameters, each represented by a
question mark. Do not include quotes around the question mark.
7. For queries that include substitution parameters, identify the data type for each
parameter.
If the query does not include any parameters, skip this step.
a. Click the Set Parameters Type button. A dialog box appears with a list of
parameters corresponding to the number of question marks in the query. The
parameter names are param1, param2, and so on.
c. Click the value in the Data Type column and select the data type for the
parameter from the list box. The data type of the parameter must match the
data type of the corresponding database column. For an Oracle database, select
BLOB as the data type. For Microsoft SQL, select Binary as the data type of
the parameter.
8. Click the Validate Query button.
Process Builder checks the validity of the query and displays a message immediately
below the text box containing the query.
If the query is not valid, the message is the error message from the database. Revise
the query to make it valid.
9. Click Next.
The Next button is unavailable until you have typed values for all required fields on
the current page.
10. If the query has substitution parameters, provide values for the parameters using

On the Input Message Mapping screen, the right column of the data mapping tool
shows the substitution parameters in the query. The left column shows package
attributes and the workflow substitution variables. See Understanding the data
mapping tool, page 145 for details about using the data mapping tool.
If the query does not include any substitution parameters, the Input Message
Mapping screen does not appear. Skip to step 12.
11. Click Next.
12. Use the data mapping tool to save the query results as package attribute values.
On the Output Message Mapping screen, the left column of the data mapping tool
shows the values returned by the query. The right column shows package attributes.
If you use BLOB data type, you must map the BLOB content as a data attribute of
the package. See Understanding the data mapping tool, page 145 for details about
If the query returns more than one row of data, the activity maps the values from the
first returned row into the associated package attributes.
Database Stored Procedure

Activities based on this template connect to an external database, and run a stored
procedure or function. To define the activity, you identify the JDBC driver to use to
connect to the database, and specify the stored procedure or function to run. You use the
data mapping tool to provide values for any IN and IN/OUT parameters of the stored
procedure. The activity returns the values for OUT and IN/OUT parameters or the result
set of the stored procedure, or the return value of a function.
Note: The supported data types for IN, OUT, and IN/OUT parameters are: CHAR,
VARCHAR, NVARCHAR_TYPE, BIGINT, INTEGER, SMALLINT, TINYINT, BIT,
DOUBLE, FLOAT, NUMERIC, DECIMAL, REAL, DATE, TIME, TIMESTAMP,
BOOLEAN, BINARY, BLOB, LONGVARBINARY, VARBINARY.
To congure a Database Stored Procedure activity:

to the database.
the JDBC driver.


6. In the box provided for entering the stored procedure or function name, type
the name of the stored procedure or function. You may optionally type the fully
qualified stored procedure name using one of the following format:
<catalog-name>.<schema-name>.<procedure-name>
or <schema-name>.<procedure-name>
or <procedure-name>
Note: Catalog, schema, and procedure or function names are case sensitive.
Skip to step 8.
7. If you do not know the name of the stored procedure or function, you can search for
the stored procedure or function using the following steps:
a. Click Search to search for a procedure or function. The Search window appears.
b. In the Enter search pattern box, type the name of the stored procedure or
function. The stored procedure or function name is case-sensitive, and can be
a fully qualified name. You may also use the % wildcard to search a stored
procedure or function. For more information on using the % wildcard, click
What’s this?.
c. Click Find.
Process Builder will search for the stored procedure or function across all
schemas and packages in the database, and retrieve the fully qualified procedure
or function name. For example, if you type the procedure name CALCULATE_TAX
in the search box, Process Builder retrieves the name of the catalog and schema
along with the stored procedure name, such as STANDARD.SYS.CALCULATE_TAX.
Refer to Example Search Patterns, page 192 for information on using different
search patterns.
d. Select the stored procedure or function from the list box.
When you select a stored procedure or function from the list box, additional
information, such as the input parameters and return value, of the selected
stored procedure or function is displayed below the list box.
e. Click OK to return to the Database Configuration tab.
The selected stored procedure or function is displayed in the box provided.
8. Click Next.
9. If the stored procedure or function accepts input parameters, provide values for the
parameters using the data mapping tool.

On the Input Message Mapping screen, the left column displays the package
attributes, and the workflow substitution variables. The right column of the data
mapping tool displays all the IN and IN/OUT parameters of the stored procedure, or
the function arguments. If there is more than one input parameter, and you map
only one parameter, the other parameters are set to NULL or as defined in the stored
procedure or function. See Understanding the data mapping tool, page 145 for
details about using the data mapping tool.
If the stored procedure or function does not include input parameters or arguments,
the Input Message Mapping screen does not appear. Skip to step 11.
10. Click Next.
11. Use the data mapping tool to save the return value of the function or procedure as
package attributes.
shows the OUT and IN/OUT parameter values or result set returned by the stored
procedure, or the return value of the function. The right column shows the package
attributes. See Understanding the data mapping tool, page 145 for details about
Example Search Patterns
You can use the following search patterns in the Enter search pattern box.
Note: Search patterns are case sensitive.
• Stored Procedure or Function name — finds only occurrences of the stored
procedure or function you type using the following format:
<procedure-name>
For example, if you search for the stored procedure name ADD_EMPLOYEE, the
business service retrieves the ADD_EMPLOYEE stored procedure along with the catalog
and schema name, such as STANDARD.SYS.ADD_EMPLOYEE. If you search for ADD_,
the business service retrieves all stored procedures or functions beginning with
the name ADD_.

• Fully qualified name — finds only occurrences of the stored procedures or functions
that you typed as a fully qualified name using one of the following format:
<catalog-name>.<schema-name>.<procedure-name>
or <schema-name>.<procedure-name>
For example, if you search for the ORDSOURCE.ORDSYS.WRITE stored procedure, the
business process service retrieves the stored procedure WRITE in the schema ORDSYS
from the ORDSOURCE catalog. The WRITE stored procedure available in any other
catalog or schema will not be retrieved.
If you search for SCOTT.ADD_EMPLOYEE, the business service retrieves the
ADD_EMPLOYEE stored procedure from the SCOTT schema.
• % wildcard — searches stored procedures or functions across all catalogs and
schemas in the database using the following search patterns.
— % or blank — retrieves all stored procedures or functions in the database
— B% — retrieves all stored procedures whose name begins with "B"
— A.% — retrieves all stored procedures in the schema named "A"
— A.B% — retrieves all stored procedures whose name begins with "B" in the
schema named "A"
— C.A.B% — retrieves all stored procedures whose name begins with "B" in the
schema "A" from the catalog "C"
— A%.B% — retrieves all stored procedures whose name begins with "B" from any
schema whose name begins with "A"
Database Write
Activities based on this template connect to an external database and run a SQL Insert,
Update, or Delete statement. The database write activity also supports exchange of
content from a package to database parameters. That is, you can insert or update binary
or BLOB data from a package into the database.
Note: The supported data types for database parameters are: CHAR, VARCHAR,
NVARCHAR_TYPE, BIGINT, INTEGER, SMALLINT, TINYINT, BIT, DOUBLE, FLOAT,
NUMERIC, DECIMAL, REAL, DATE, TIME, TIMESTAMP, BOOLEAN, BINARY, BLOB,
LONGVARBINARY, VARBINARY.
To define the activity, you identify the JDBC driver to use to connect to the database
and specify the statement to run. You use the data mapping tool to provide values for
any substitution variables in the SQL statement. The activity returns the number of
rows created or updated.

To congure a Database Write activity:

to the database.
the JDBC driver.
6. Type the valid SQL Insert, Update, or Delete statement in the Query to Run box.
The statement must start with one of the SQL keywords Insert, Update, or Delete.
To create a SQL statement using parameters whose values come from package
attributes or runtime workflow variables, type a question mark (?) where you
want the value to be substituted. The question mark represents a parameter whose
value the activity will insert at runtime. For example, a statement that updates a
customer’s last name based on a Social Security number includes a question mark in
place of a specific SSN value:
Update CUSTOMER Set Lastname='Smith' where ssn=?
The SQL statement can include any number of parameters, each represented by a
question mark. Do not include quotes around the question mark.
7. For SQL statements that include substitution parameters, identify the data type
for each parameter.
If the statement does not include any parameters, skip this step.
a. Click Set Parameters Type. A dialog box appears with a list of parameters
corresponding to the number of question marks in the query. The parameter
names are param1, param2, and so on.
c. Click the value in the Data Type column and select the data type for the
parameter from the list box. The data type of the parameter must match the
data type of the corresponding database column. For an Oracle database, select
BLOB as the data type. For Microsoft SQL, select Binary as the data type of
the parameter.


8. Click Next.
The Next button is unavailable until you have entered values for all required fields
on the current page.
9. If the SQL statement has substitution parameters, provide values for the parameters
On the Input Message Mapping screen, the right column of the data mapping
tool shows the substitution parameters in the SQL statement. The left column
shows package attributes and the workflow substitution variables. If you use BLOB
data type, you must map the BLOB content as a data attribute of the package. See
Understanding the data mapping tool, page 145 for details about using the data
mapping tool.
If the SQL statement does not include any substitution parameters, the Input
Message Mapping screen does not appear. Skip to step 11.
10. Click Next.
11. Use the data mapping tool to save the number of returned rows as a package
attribute value.
shows the single values returned by the SQL statement: the number of rows inserted
or updated. The right column shows package attributes. See Understanding the data
DQL Inbound — Initiate and Step

Use this template to process objects located within a Documentum repository. When
the system fetches a new object, it creates a new process instance or uses the object to
complete a running activity or workitem.
In a DQL Inbound activity, a listener is configured to listen to an inbound process. When
the listener starts up, the system creates a poller thread that executes the DQL select query
that you specify in the DQL qualification. The poller queries the repository for any new
objects matching the query using the time interval you specify in the activity template.
For each object ID returned by the query, the system creates a new thread that delegates
the object to the post processor, which performs the specified option on the object.
1. In the Activity Inspector, click the DQL Configuration tab.

2. Select the option to Connect to different Repository if you are accessing information
from another repository.
3. Either type the Repository Name or select it from the drop-down list box.
The list contains all repositories that this instance of Process Builder is connected to
through the dfc.properties configuration file.
4. If you have chosen to connect to a different repository, type the User Name required
to connect to the repository.
5. If you have chosen to connect to a different repository, type the Password required to
connect to the repository.
6. Click the Test Connection button to verify that the connection parameters have
been entered correctly.
If the connection is unsuccessful, a red message appears below the text box. Modify
the values and try again.
7. Type the DQL Qualification to Fetch Objects in the text box.
Type a DQL qualification consisting of that portion of a SELECT statement that
begins with the keyword FROM. The DQL qualification uniquely identifies an object
in a repository.
8. Click Validate Query to ensure that the query is valid
9. For step activities only, select a Correlation ID from the list of attributes belonging
to the object type specified in the DQL qualification.
10. Select a Post Processing Options for managing the object after it has been retrieved.
Valid values enable you to delete the object that the query retrieves, move the object
to a folder that you specify, or update the attributes based on the query you type.
11. If you have selected to move the object to an archive folder, type the path of the
archive folder.
12. If you have selected to update attribute values, type the query to update the object
attributes in the text box.
13. Type the number of seconds used as the Polling Frequency .
This is the duration of time after which the processor queries the repository and
fetches any new entries that match the given DQL select statement.
14. Type the number of processors available.
This is the total number of concurrent processors that can monitor for data at this
end-point.
15. Click Next to map the objects to process data attributes.

DQL Read
Activities based on this template execute DQL queries on the specified repository. For
example, you can use the DQL Read activity template to select a loan document from
the repository that was submitted between a range of dates or based on a loan amount
or credit score.

7. Type the Query to Run in the text box.
To create a query that uses placeholder values, type a question mark (?) where you
value the activity will insert at runtime.
8. Click the Set Parameter Type button to select a data type for the parameter you
specify in the DQL query.
10. Click Next to use the data mapper to map process data to the parameters of the query.
DQL Write

Activities based on this template execute create, update, or delete object DQL queries on
the specified repository. For example, you can use the DQL Write activity template to set
a credit score in a loan document that is in the repository.

7. Type the Query to Run in the text box.
To create a query that uses placeholder values, type a question mark (?) where you
value the activity will insert at runtime.
8. Click the Set Parameter Type button to select a data type for the parameter you
specify in the DQL query.
10. Click Next to use the data mapper to map process data to the parameters of the query.
Dynamic Web Service

Activities based on this template run a web service operation. Unlike the Web Service
template, this activity template enables you to interactively map data between business
process attributes and the web services parameters. This activity template supports
both secure and non-secure web services.
The following sections describe how to configure secure and non-secure web services.
• Invoking non-secure Web Services, page 199
• Invoking secure Web Services, page 200

Invoking non-secure Web Services
This section describes how to configure a non-secure web service activity.
To invoke a non-secure Dynamic Web Service activity:

1. In the Activity Inspector, click the Web Service Configuration tab.
2. In the URL Path to the WSDL File box, type the fully qualified URL to the WSDL
file that contains the operation you want to run.
3. Click Read WSDL File.
Process Builder reads the specified WSDL file and populates the remaining fields
on the screen.
4. Select from among the available port types in the specified WSDL file.
The Port Type list box is empty until you click Read WSDL File.
5. Select from among the available operations in the specified WSDL file.
6. Click Next.
The Next button is unavailable until you have selected an operation from a valid
WSDL file. It is also unavailable if you have not yet specified any packages for the
business process, or if the selected web service operation has no input parameters
or return values.
7. If the selected web service operation has input parameters, provide values for the
shows the input parameters for the operation. The left column shows process data
and the workflow substitution variables. See Understanding the data mapping tool,
page 145 for details about using the data mapping tool.
If the selected web service operation does not have input parameters, the Input
8. Click Next.
If the selected web service operation does not have output values, the Next button is
unavailable. Skip the next step.
shows the output values from the operation. The right column shows package

Invoking secure Web Services
Activities based on this template support three kinds of security. They are:
• HTTP proxy support
• HTTP basic authentication
• SOAP header-based authentication
Before configuring a secure web service, you can configure the HTTP proxy server. Refer
to Configuring the HTTP proxy server, page 202 to configure a HTTP proxy server.
The following procedures describe how to configure web services protected by HTTP
basic authentication and SOAP header-based authentication.
To configure a secure web service activity, click the Web Service Configuration tab in the
Activity Inspector.
If the web service being invoked is protected by HTTP basic authentication:

on the screen.
5. Select Use HTTP Basic Authentication.
6. In the Username box, type the username.
7. In the Password box, type the password for the specified user.
8. Skip to Mapping Web Service parameters, page 201.
If the web service being invoked is protected by SOAP header-based

authentication:
For example, if you use Documentum Web Services Framework (WSF), you can use
the following URL for repository credentials service:
http://localhost:8080/ws/services/DocbaseCredentials?wsdl
where,
• localhost:8080 — host address of the application server

• ws/services — name of the directory on the application server where the Web
Services Framework (WSF) is installed
on the screen.
Note: Refer to the Documentum Web Services Framework Development Guide for more
information on the types and operations of credentials service.
5. For generic SOAP-secured web services, a security token will be generated.
6. Skip to Mapping Web Service parameters, page 201 to map SOAP-based
authentication information.
Mapping Web Service parameters
Perform the following steps to map the input and output values of the web service.
However, before performing the following steps, you must complete the initial steps
to configure the dynamic web service as described in Invoking secure Web Services,
page 200.
To map the Web Service parameters:

1. Click Next.
The Next button is unavailable until you have selected an operation from a valid
WSDL file. It is also unavailable if you have not yet specified any packages for the
business process, or if the selected web service operation has no input parameters
or return values.
2. If the selected web service operation has input parameters, provide values for the
shows the input parameters for the operation. The left column shows package
attributes and the workflow substitution variables. See Understanding the data
If the web service is protected by SOAP-header based authentication, you must
map the security token and SOAP-secured parameters. If you use Documentum
WSF-based credentials service, you must map the values for the parameters based
on the type and operations of the credentials service.

Note: For more information on the types and operations of credentials service, refer
to Documentum Web Services Framework Development Guide.
If the selected web service operation does not have input parameters, the Input
3. Click Next.
If the selected web service operation does not have output values, the Next button is
unavailable. Skip the next step.
shows the output values from the operation. The right column shows package
Conguring the HTTP proxy server
To access a web service that is located outside the firewall, through a HTTP proxy server,
you must configure the HTTP proxy parameters. To do this, you must modify the
Process Builder shortcut and the Content Server Java Method Server startup parameter.
The following sections describe how to configure the startup parameters on Windows
and UNIX-based systems.
• Configuring HTTP proxy parameters in Windows, page 202
• Configuring HTTP proxy parameters in UNIX-based systems, page 203
Conguring HTTP proxy parameters in Windows
This section describes how to configure HTTP proxy startup parameters on Windows
systems for the following:
• Process Builder shortcut
• Content Server Java Method Server
To congure the Process Builder shortcut:

1. Right-click the Process Builder shortcut in the desktop, and select Properties.
Note: If you do not have a Process Builder shortcut in the desktop, then select
Start > Programs > Documentum, and right-click Process Builder and then select
Properties.
2. In the Target box, modify the javaw.exe path to the following:

• HTTP basic authentication:

"C:\Program Files\Documentum\java\1.5.0_12\jre\bin\javaw.
exe -Dhttp.proxyHost=localhost -Dhttp.proxyPort=<port-
number> -Dhttp.nonProxyHosts"
where,
— http.proxyHost — host name of the proxy server
— http.proxyPort — port number, the default value being 80
— http.nonProxyHosts — list of hosts that should be reached directly,
bypassing the proxy server. This is a list of regular expressions separated
by ’|’. Any host matching one of these regular expressions will be reached
through a direct connection instead of through a proxy
• HTTP over SSL:
"C:\Program Files\Documentum\java\1.5.0_12\jre\bin\javaw.exe
-Dhttps.proxyHost=localhost -Dhttps.proxyPort=<port-
number> -Dhttps.nonProxyHosts"
where,
— https.proxyHost — host name of the proxy server
— https.proxyPort — port number, the default value being 443
— https.nonProxyHosts — list of hosts that should be reached directly,
bypassing the proxy server. This is a list of regular expressions separated
by ’|’. Any host matching one of these regular expressions will be reached
through a direct connection instead of through a proxy
3. Click OK.
To congure the Java Method Server startup parameters:

1. Open the file StartMethodServer.cmd from $DOCUMENTUM%.
2. Add the HTTP proxy parameters for basic authentication or HTTP over SSL to the
JAVA_OPTIONS.
For example, add the following lines to support HTTP basic authentication:
-Dhttp.proxyHost=<proxy_host>-Dhttp.proxyPort=<port_number>
where
proxy_host is the name of the proxy server
port_number is the port number. The default is 80.
Conguring HTTP proxy parameters in UNIX-based systems
This section describes how to configure the Content Server Java Method Server startup
parameter in UNIX-based systems.

To congure the Java Method Server startup parameters:

1. Open the file StartMethodServer.cmd from $DOCUMENTUM$.
2. Add the HTTP proxy parameters for basic authentication or HTTP over SSL to the
JAVA_OPTIONS.
For example, add the following lines to support HTTP basic authentication:
-Dhttp.proxyHost=<proxy_host>-Dhttp.proxyPort=<port_number>
where
proxy_host is the name of the proxy server
port_number is the port number. The default is 80.
Invoking DFS (Documentum Foundation Services) services from

Process Builder
DFS services can be invoked in one of two ways from Process Builder.
• As a single service, meaning that a process contains one Dynamic Web Service activity
template that performs a single invocation of a DFS web service.
• As a chained service, meaning that a process contains multiple Dynamic Web Service
activity templates that invoke DFS web services. The repository identity information
is registered to a token that each activity template uses.
Note: The Dynamic Web Services activity template supports only base64 for content
transfers.
To register the repository identity (for chained services):

1. Use the ContextRegistryService provided by DFS to register the repository.
For more information on the ContextRegistryService, see Documentum Foundation
Services Development Guide.
2. On the Web Service Configuration tab of the Dynamic Web Services activity
template, type the fully qualified URL path to the WSDL.
For example,
http://yourserver:port/services/core/runtime/ContextRegistryService?wsdl
Note: The WSDL can also exist as a local file.

3. Select ContextRegistryServicePort as the Port Type.
4. Select register as the Operation.
6. Click Next.

7. In the Input Message Mapping page, create the following mappings:

a. Map RepositoryName to
SOAPEnvelope/SOAPBody/params/register/arg0/
Identities[0}/@repositoryName
b. Map Username to
Identities[0]/@userName
c. Map Password to
Identities[0]/@password
d. Map Domain to
Identities[0]/@domain
Note: Identities is a repeating node. Multiple identities can be registered to a

single token.
8. Click Next.
9. In the Output Message Mapping page, the generated token is available in
SOAPEnvelope/SOAPBody/parameters/registerResponse/return
To unregister the repository identity (for chained services):

1. Use the ContextRegistryService provided by DFS to register the repository.
For more information on the ContextRegistryService, see Documentum Foundation
Services Development Guide.
2. On the Web Service Configuration tab of the Dynamic Web Services activity
template, type the fully qualified URL path to the WSDL.
For example,
http://yourserver:port/services/core/runtime/ContextRegistryService?wsdl
Note: The WSDL can also exist as a local file.

3. Select ContextRegistryServicePort as the Port Type.
4. Select unregister as the Operation.
6. Click Next.
7. In the Input Message Mapping page, add the token that needs to be unregistered into
SOAPEnvelope/SOAPBody/params/unregister/arg0

Invoking a typical DFS service (single or chained):

1. Open the Activity Inspector for the Dynamic Web Service activity template.
2. Select the Web Service Configuration tab.
3. Type the fully qualified URL for the WSDL for the specific DFS service.
4. Select the Port Type and Operation based on the values available in the WSDL file.
5. Click Next.
6. In the Input Message Mapping page, add the following data mappings for
authenticating any of the DFS services.
Use the concatenate function to construct the string for mapping.
Note: The following mappings are only to authenticate the DFS services. The
Documentum Foundation Services Development Guide provides more details on DFS
functionality.
For a chained service, map the following:
<wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/
oasis-200401-wss-wssecurity-secext-1.0.xsd"><wsse:BinarySecurityToken
QualificationValueType="http://schemas.emc.com/documentum
#ResourceAccessToken"xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/
oasis-200401-wss-wssecurity-utility-1.0.xsd"
wsu:Id="RAD">someToken<wsse:BinarySecurityToken></wsse:Security>
to the SOAPHeader
(SOAPEnvelope/SOAPHeader/SOAPHeaderElement[0])
For a single service, map the following:
<ServiceContext
xmlns="http://context.core.datamodel.fs.documentum.emc.com/"
xmlns:ns2="http://properties.core.datamodel.fs.documentum.emc.com/"
xmlns:ns3=http://profiles.core.datamodel.fs.documentum.emc.com/>
<Identities xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
repositoryName="docbaseName" password="docbasePassword"
userName="docbaseUsername"xsi:type="RepositoryIdentity"/>
</ServiceContext>
to the SOAPHeader
(SOAPEnvelope/SOAPHeader/SOAPHeaderElement[0])
Note: Use multiple <Identities/> when more than one repository is used for
authentication.
Email Inbound — Initiate and Step

Email activity templates poll email servers for incoming messages and then process them
according to the business logic you’ve specified. Within the Email Inbound activity

template, you define the connection to the email server, select options for processing the
message after it’s been read, and map data from the incoming message to the process
data that is used in the process.
For example, in a customer complaint business process, you can configure an inbound
email template as the initiate activity in the process. The activity polls the email server
and starts a new workflow when it receives a customer complaint email message. In the
following steps of the process, the system routes the email through a manual activity to a
person who reviews the complaint and resolves the issue.
1. In the Email Server Type field, select the protocol for connecting to the email server.
Valid values are IMAP or POP.
2. In the Host Name field, type the name or IP address of the email server.
3. Type the Port Number where the email server listens protocol (IMAP or POP)
requests.
The default values are provided based upon the protocol that you select.
4. Type the username and password for the email server.
6. Type the email Folder Name in which messages are processed (for example, Inbox).
You can also click Get Folder List... to view a list of email folders available on the
email server and select one.
7. For step activities, you can enter an email message header name that includes a
correlation ID in the Correlation Header Name.
A correlation ID is a unique string associated with each process instance and can be
used to identify a workflow and match the message to it.
Note: If the system cannot use the information in this field to match the message
to the workflow, it uses the mappings you create in Step 15 to match the response
to the request message.
8. Select an option for managing the message after it has been processed.
These options are dependent upon the email server type you’ve selected.
For POP3 email servers, the only valid post processing option is Delete Email
Message.
Valid options for IMAP servers are: Mark Email Message as Read, Delete Email
Message, or Move Email Message to Archive Folder.

9. If you have selected to move the message to an archive folder in the previous field,
type the name of the archive folder or click Get Folder List... to browse to the
archive folder.
10. Type in the number of seconds that passes before the listener checks for new
messages.
11. Type the number of email sessions available to process email messages.
12. Click Next to display the data mapping tool, where you can map the message data to
the process data.
13. Click Next to display the data mapping tool, where you can specify rules that match
correlation set attributes to message attributes.
14. Select the Correlation Set that you are mapping from the list at the top of the page.
sets to match messages from external sources to process data. Creating correlation
sets, page 78 gives more details on defining correlation sets for a process.
Fax Outbound
Note: Captaris RightFax is not included in the Process Suite bundle and must be
purchased and licensed through Captaris. Refer to the Captaris RightFax documentation
for instructions on installing and configuring the RightFax server.
Use the Fax Outbound activity template to send unidirectional messages to a Captaris
RightFax facsimile server. These messages can be fax requests sent from a process or
they can be queries that request the status of a single or multiple fax requests. Results of
the query appear in the inbox of the activity’s performer.
To submit a fax request with the Fax Outbound activity template:

1. Open the Fax Outbound activity template.
2. Type the URL for the RightFax server.
3. Type the username for the RightFax server.

4. From the drop-down list box, select the Submit operation to send a fax request
to the RightFax server.
Submit sends a fax request to the RightFax server. Query gets the status of a fax
request submitted to the RightFax server based on a unique identifier.
5. Click the Test Right Fax Server URL button to verify that the RightFax server is
accessible from the activity template.
6. Click Next to map process data attributes to the fax request attributes.
7. Map the following Recipient Details using process data in the data mapper screen:
a. Map ID to a unique ID for the request.
If you do not provide an ID for the request, the RightFax server generates one.
b. Map Name to the name of the recipient.
c. Map Company to the name of the recipient’s company.
d. Map Fax # to the destination facsimile phone number.
e. Map Cover Page Name to the name of the cover page template that is found
on the RightFax server.
The RighFax system supports two types of cover pages:
• Production cover sheets that use the file extension .cov. These cover pages
cannot be used when sending the fax to multiple recipients. In most
cases, the cover pages are located in the following location: C:\Program
Files\RightFax\Production\Covers.
• Enterprise cover sheets that use the following file extensions:
.pcl for print control language documents
.doc for Microsoft Word documents
.html for HTML documents
.mht for meta-HTML documents
These cover pages are stored in the following location: C:\Program
Files\RightFax\FCS.
Note: Facsimile cover pages must be created using specific criteria and must be
saved to a designated location on the RightFax server. Refer to the Captaris

RightFax documentation for instructions on creating and saving facsimile cover

pages.
8. Map the Cover Page Notes using process data in the data mapper screen:
a. Map Type to a plain text or HTML cover page format.
b. Map Text to the content of the message for the cover page.
Note: The system truncates text files that exceed the word-wrap length of the
RightFax server. Check the RightFax documentation for details on manually
setting the word-wrap length in the RightFax server registry.
9. Map the Attachments using process data in the data mapper screen:
a. Map Content-type to the type of content found in the attachment.
Refer to the RightFax documentation for supported content types.
b. Map Data to the actual content of the fax message.
Note: If you expect to send large attachments using the activity template, you may
need to adjust the value of the Method times out in field on the Performer tab.
10. Click Next to map the RightFax server’s response to the process data associated
with the submit request.
a. Map ID to the unique ID for the fax request that was submitted by the process.
b. Map Code to the status code of the request.
c. Map Message to the status message associated with the status code.
To submit a query request to the RightFax server using the Fax Outbound
activity template
1. Type the URL for the RightFax server.
2. Type the username for the RightFax server.
3. From the drop-down list box, select the Query operation to retrieve the status of a
fax request submitted to the RightFax server based on a unique identifier.
4. Click the Test Right Fax Server URL button to verify that the RightFax server is
accessible from the activity template.
5. Click Next to map process data attributes to the Fax request attributes.

6. Map the RightFax server’s response to the query using the following variables:
a. ID is the unique ID for the fax request that was submitted by the process.
b. Code is the status code of the request.
c. Message is the status message associated with the status code.
Some common messages are:
• Phone Line Problem
• Scheduled to be Sent
• Problem Converting Fax Body or Cover Sheet
For a complete list of messages, refer to the RightFax documentation.
FTP Inbound — Initiate and Step

FTP activity templates monitor for files and folders that are transferred to the designated
base folders. For example, in a workflow that processes incoming purchase orders, you
can use this activity template to monitor the base folder for incoming purchase orders
that are XML files. Based on the mapping, the system then initiates a process for every
matching file based upon the order type that you’ve configured in the XML schema.
From within the activity template, you configure the FTP server information, verify
connectivity, and designate post-processing options such as deleting or archiving the
processed files or folders. You can use the data mapping tool to further process the files
either as data or as XML documents, when you provide an XML schema.
To congure the FTP Inbound activity template:

1. Select a Protocol for the connection.
The supported standard protocols are FTP, SFTP (SSH FTP), FTPS (FTP over SSL),
and Local File.
Note: If you select Local File. skip to step 5.
2. Type the Host name or IP address of the FTP server.
3. Type the port number you are using for the connection.
The default port for FTP and FTPS is 21.
The default port for SFTP is 22.
4. Type the username and password for the FTP server to which you are connecting, if
the server requires authentication.

Note: The user must have sufficient privileges to perform the mandatory post
processing operation configured in step 11.
5. In the Base folders field, type the path to the folders on the FTP server that will
be monitored.
6. In the Message Type field, select the option for the file downloads.
Valid options are:
• Compressed File, which enables the system to monitor for multiple files within an
archive.
• Directory, which enables the system to monitor for multiple files within a folder.
• File, which enables the system to monitor for a file.
7. Click the Validate button to verify that the connection parameters and base folder
path have been entered correctly.
8. In the Included File/Directory Name Pattern field, type the variables for file types
and directory names that you want to include in monitoring.
For example, type *.xml to monitor for any XML file.
9. In the Excluded File/ Directory Name Pattern field, type the variables for the file
types and directory names you want to exclude from monitoring
For example, type sam* to exclude all files that begin with sam.
10. For step activities only, type the Correlation Patterns that provide the filename
format that determines the correlation ID from the filename.
For example, the file sam_956d77f734b6d7fb97771be.xml can be represented (using
dollar signs $ as placeholder values) as sam_$id$.xml. The placeholder value $id$
represents the correlation ID 956d77f734b6d7fb97771be.
Placeholder values must be alphanumeric characters without spaces. The placeholder
token starts after the dollar sign $ and ends with first non-alphanumeric character.
Note: If the system is unable to use the Correlation Patterns field to match request
and response messages, then the system uses the correlation ID and the mapping
that you define in Step 17.
11. Select one of the following Post Processing Options for managing the file after it
has been downloaded and processed.
You can Archive or Delete the file, folder, or archive.
12. If you have selected to move the message to an archive folder in step 12, type the
name of the Archive Folder.
13. Type the number of FTP Processors available.
This is the total number of concurrent processors that can monitor for data at this
end-point. It is based upon the number of supported concurrent connections for
the FTP server.

Note: The number of FTP Processors should be greater than or equal to 1. This
number assumes one poller in existence, so if you are configuring three processors,
enter 3 in this field. When you are setting up your FTP server, you will have four
total concurrent connections.
14. Type the number of minutes used as the Polling Interval after which the system
checks for incoming files.
For example, if the polling frequency is set to 45, the FTP server is polled every 45
minutes for files.
Note: If you expect large files, it is best to use a higher polling interval.
15. Click Next to map FTP source attributes to process data attributes.
• Adding an XML schema to activity content , page 149 provides instructions for
adding an XML schema to a message mapping.
16. Click Next to display the data mapping tool, where you can specify rules that match
correlation set attributes to the FTP message attributes.
Note: The message must contain structured data to be able to map the correlation
set attributes to the message attributes.
17. Select the Correlation Set that you are mapping from the list box at the top of the
page and configure the mappings for the activity.
Adding an XML schema to activity content , page 149 provides instructions for

FTP Outbound
Use the FTP Outbound activity template for activities that read messages from files.
These activity templates are particularly useful for processes that rely heavily on
file-based transactions such as financial auditing processes.
To congure the FTP Outbound activity template:

1. Select a Protocol for the message.
The supported standard protocols are FTP, SFTP (FTP over SSH), FTPS (FTP over
SSL), and Local File.
Note: If you select Local File. skip to step 5.
2. Type the Host name or IP address of the FTP server.
3. Type the Port number you are using for the connection.
The default port for FTP and FTPS is 21.
The default port for SFTP is 22.
4. Type the username and password for the FTP server to which you are connecting, if
the server requires authentication.
5. Type the path to the on the Base Folder machine to which the files are uploaded.
6. Select the Message Type.
Valid options include:
File, which enables the system to send a simple file.
Compressed File, which places files into a zip folder. This file is named at
runtime based on the archive name you configure in the data mapper, and then
placed in the destination directory.
Directory, which places the files into subfolders based on the destination
directory. The subfolder name is determined at runtime based on the directory
name that you configure in the data mapper.
7. Click the Validate button to verify that the connection parameters have been entered
correctly.
Note: The validate button is not available for the Local File option. You must
manually verify that the base folder exists on the machine where the Inbound
activity template is deployed.
8. To enable the system to overwrite an identical existing file (or subfolder if you have
selected Directory in step 6), select Overwrite if exists.
If left blank, the system gives the file a unique name by adding an incremental
number to the filename (or subfolder) and does not overwrite the existing file (or
subfolder).
9. Click Next to map process data attributes to the FTP attributes.

Based on the file types that you have chosen, you must complete the following
mappings:
• If you chose to have the files uploaded to a sub-folder, you must map process
data to the sub-folder on the right-hand side of the data mapping screen.
• If you chose to have the files uploaded to a compressed file, you must map
process to the Archive node.
• Additionally, at least one mapping from the process data to the Attachment
node must exist. Within this mapping, Content Name, Content Type, and Data
attributes must be configured, as well.
Note: The Content Type attribute mapping determines the mode in which data is
transmitted to the FTP server. If it is mapped to any string text, it is transmitted as
ASCII text. All other files are transferred in binary mode.
HTTP Inbound — Initiate and Step

Use the HTTP Inbound activity template to receive and process HTTP messages sent by
an external client. You configure the HTTP Listener to listen for a specific URL suffix
and then read and process incoming messages. The incoming message can be mapped
to process data using the data mapper.
The system then sends a synchronous response back to the client using the response type
that you specify in the activity template.
To congure the HTTP Inbound activity template:

1. Type the URL Suffix to which the URL request is sent.
For example, if the HTTP request URL sent from the client is http://eng076:8001/bps/
http/ReceivePO, then the suffix is ReceivePO.
2. If authentication is required by the inbound activity template, select Authentication
to require a username and a password.

3. Type a username and password required to access the inbound activity.

This is the value that the user enters in the browser’s authentication dialog box to
access the activity. The request is sent again with the username and password in
the HTTP request. If authentication is selected and the username and password
URL parameters are not sent, the inbound activity template will not allow access
to the activity.
4. Select a Request Type that specifies the type of request coming in.
Valid values are GET, POST, and PUT.
• Select GET messages if the requests will not have attachments.
• POST and PUT messages can have attachments. If some requests have
attachments and some do not, selecting POST as the request type will still enable
you to send a GET request.
Note: If you are using the GET method, the fields used to specify request information
are not available.
5. If the activity template is a step activity, type the Correlation Property Name.
This property name in the HTTP request is used to identify a workflow. This
attribute appears in the data mapper, located in the URL parameters node of the
Body node. This value must match one of the name values of the process data.
Note: The correlation property name is used by the system first to match the request
to response messages. If there are correlation set values that are mapped, the system
uses those values only if the mapping to the correlation property name fails.
6. To include attachments in the request message, select With Attachments.
Attachments are only available for POST and PUT request types.
7. Select Validate XML Documents to force validation of the XML.
8. To create a text template for the response message, select Template Response.
9. If you are using a Response Template, enter the body of the response in the text box.
You can include static text, HTML, and placeholder values that can be mapped to
process data.
• Placeholders are prefixed with a dollar sign $ (for example, ${tokenname}).
non-alphanumeric character.
For example, to send a message indicating that a purchase order was processed
successfully, you would use the following template text: Purchase Order $orderno
successfully processed. The placeholder orderno appears in the data mapping screen

and can be mapped to a package or process variable. The response sent will be
a HTML page of consisting of the following message: Purchase Order 0896523
successfully processed, where 0896523 is the substituted value from the response data
mapping.
Note: All placeholder values must be mapped to process data.
10. Click Next to map the input request message to the process data.
• Adding message properties, page 148 provides instructions for adding a
service-specific property to a message in order to complete a mapping.
Depending on the types of protocol you’ve selected, complete the following
mappings:
• Messages using GET methods have no attachments, so only attributes for the
URL parameters and headers appear in the mapper.
• Messages using POST methods show mapping attributes for headers, body
attributes, and attachments, if attachments have been enabled in the previous
screen.
• Messages using PUT methods show mapping attributes for the header and one
body attachment, if attachments have been enabled on the previous screen.
11. Click Next to map the process data to the response message.
Use the data mapper to associate process data to the status, header, and body
attributes. Any placeholder values appear in the data mapper enabling you to map
values to send in the response to the client.

12. Click Next to use the data mapper to associate the request message attributes to the
correlation set you choose in the next step.
HTTP Outbound
The HTTP Outbound activity template sends an HTTP request to a specified URL and
can receive a response back from the server. The fields in the activity template enable
you to specify data that can be mapped to the process data model.
To congure the HTTP Outbound activity template:

1. Type the complete URL of the site to which the activity posts content, starting with
the protocol prefix http://.
2. If authentication is required by the server, select Authentication to require a
username and a password.
Note: Only Basic authentication is supported in the HTTP Outbound activity
template.
3. Type a Username and Password if you are requiring authentication.
4. Select a Request Method that specifies the type of request to be sent to the server.
Valid values are GET, POST, and PUT.
Note: If you are using the GET method, the fields used to specify request information
are not available.

6. In the Connection Timeout (mins) field, type the number of minutes allowed before
the system terminates an idle connection.
7. If you want to include attachments in the request message, select Allow Attachments.
Attachments are only available for POST and PUT request types.
8. Click Next to map the process data to the request message.
Messages using GET methods have no attachments, so only attributes for URL
parameters and headers appear in the mapper.
Messages using POST methods show mapping attributes for headers, body
attributes, or attachments, if attachments have been enabled in the previous
screen.
Messages using PUT methods show mapping attributes for the header and one
body attachment, if attachments have been enabled on the previous screen.
9. Click Next to map the response message to the process data.

JMS Inbound — Initiate and Step

JMS Inbound activity templates are used to receive and process JMS messages sent to a
queue or a topic. For example, in a claims processing workflow, a JMS initiate activity
can be configured to listen to a claims queue. The activity starts the workflow when a
message reaches the queue. The system then routes that data from the message to the
intended destination.
You specify connection and processing options within the activity template and map the
message parameters such as JMS headers and other properties to the process data using
To congure the JMS Inbound activity template:

1. Configure the initial context for the messaging server.
a. Select the initial ContextFactory that the system uses for accessing the JNDI
(Java Naming and Directory Interface) context of the messaging server. The
context factories for WebSphere, TIBCO, and WebLogic are available with
Process Builder.
b. Type the Provider URL of the messaging server.
c. Type the username and password for the messaging server.
2. Configure the connection for the Queue/Topic.
a. Select the option to access either a Queue or a Topic.
b. Type the name of the Connection Factory used to access the queue or topic.
c. Type the name of the queue or topic you want to monitor for messages.
d. Type the username and password used to access the topic or the queue, if
necessary.
e. Type an optional Message Selector query to use in filtering messages read by
the inbound listener based on the value of a particular property sent in the JMS
message.
For example, you can set up a filter for a particular vendor ID used in the
message and only those messages with that vendor ID will be processed by
this activity template.
f. Select Message Type.
Valid values are Message, MapMessage, TextMessage, BytesMessage,
ObjectMessage, and StreamMessage.
g. Click the Test Connection button to verify that the connection parameters have

If the connection is unsuccessful, a red message appears below the text box.
3. Select Validate Schema to have the system check the validity of any XML schemas at
runtime.
4. Type the Number of Threads to be used to process the JMS messages.
Note: For topic connections, the default number of threads is always set to 1.
5. Click Next to display the data mapping tool, where you can map the message data to
the process data for the input message.
6. Click Next to display the data mapping tool, where you can map message data
to the correlation sets.
• Understanding message correlation, page 157 gives more details on using
correlation sets to match messages from external sources to process data.
Creating correlation sets, page 78 gives more details on defining correlation
sets for a process.

JMS Outbound
Use the JMS Outbound activity template to enable Process Builder to send messages to
an external application and then receive a response from that application. This template
can send XML messages, binary messages, and messages in other structured formats
such as .CSV files.
To congure the JMS Outbound activity template:

1. Configure the initial context for the messaging server.
a. Select the initial ContextFactory that the system uses for accessing the JNDI
(Java Naming and Directory Interface) context of the messaging server. The
context factories for WebSphere, TIBCO, and WebLogic are available with
Process Builder.
b. Type the Provider URL of the messaging server.
c. Type the username and password for the messaging server.
2. Configure the connection for the Queue/Topic.
a. Select the option to access either a Queue or a Topic.
b. Type the name of the Connection Factory used to access the queue or topic.
c. Type the name of the queue or topic you want to monitor for messages.
d. Type the username and password used to access the topic or the queue, if
necessary.
e. Select Message Type.
Valid values are Message, MapMessage, TextMessage, BytesMessage,
ObjectMessage, and StreamMessage.
f. Click the Test Connection button to verify that the connection parameters have
If the connection is unsuccessful, a red message appears below the text box.
3. Click Next to display the data mapping tool, where you can map the process data to
the message data for the input message.


4. Click Next to map the message response attributes to the process data for the output
message.
Process Data Mapping

Activities based on this template transfer data from one package in the business process
to another package, or from one package attribute to another. You can also copy the
contents of a package to another package.
To congure a Process Data Mapping activity:

1. In the Activity Inspector, click the Process Data Mapping tab.
The data mapping tool appears, with the list of process packages in both the left and
right columns. The left column also includes the workflow substitution variables.
2. Use the data mapping tool to transfer values from packages or execution data to
other packages or package attributes, or to copy the content from the package on the
left column to a package on the right column. You can also map repeating-valued
attributes.
Package objects that have content associated with them have the following attributes
displayed under the Content node:
• content-type: specifies the mime type of the content
• format: specifies the name of the format object (dm_format) that is associated
with the content
• data: specifies the actual content
To copy content to a package, users must create mapping rules to:
• Copy data from any source node to the data node of the package.

• Set values for either format or data node. This can be done by specifying a
constant value or by mapping values from any source node.
Users will see the following validation error if values are not specified for the
format or data nodes:
Content-type and/or Format not found in mapping rules for Package: <target-package>
You may use any of the available regular functions for copying package content. In
addition, you may use the String To Byte or Byte To String functions that supports
conversion of content to String data type. See Using data mapping functions, page
153 for more information on these functions.
mapping tool, and Using repeating attributes, page 151 for details about mapping
At runtime, if the destination package exists, the content and format of the package is
replaced by the content and format of the source package. If the destination package
does not exist, a new package is created. The content from the source package,
including the content-type, is copied to the new package. However, if the source
package does not have a format mapping or content-type, then the value for the
format attribute in the destination package is set to crtext and the content-type as
text/plain.
SMTP
Use the SMTP activity template to send email messages with attachments to lists of
users. For example, you can add an activity template that sends an email message as a
response to a customer complaint or send an expense report in the body of the email
message for approval.
To congure the SMTP activity template:

1. Type the name of the SMTP server host machine or its IP address.
2. Type the parameter that identifies the Port Number for the SMTP server.
If you do not provide a value, the activity uses the standard SMTP port 25.
3. Select Authentication Required if the server requires a username and a password
for authentication.
4. Type a username and password if the server requires authentication.

6. Type the email subject template in the Subject Template field.
The subject template should consist of static text as well as placeholder values that
can be mapped to process data.
7. Type the email template text in the Body Template text box.
You can include static text, HTML copied in from a third-party HTML editor, and
placeholder parameters that can be mapped to process data.
If you are including HTML markup in the email body, you must map the constant
value text/html to the Content-Type in the Body node of the email message. If
Content-Type is not mapped to a value, the content-type is by default text/plain.
email message.
The email message structure appears in the right-hand pane and the process data on
the left-hand side. You can set values for email message attributes by mapping them
from attributes of the process data model. If you have multiple email attachments,
you can click Add on the Attachment node to add more attachments.
data mapping tool.

Note: At least one of the recipient nodes (To, Bcc, or Cc) must be mapped from
process data or a constant value. Additionally, all placeholder nodes under the
Subject and Body nodes must be mapped at this point.
For example, if you added a process variable emailMsgId, you can map the email
message ID attribute from the source message to that process variable.
data mapping tool.
Adding message properties, page 148 provides instructions for adding a
Invoke Process
An Invoke Process activity launches a new workflow. The activity is complete when the
new workflow is started.
While the new workflow is logically a subprocess of the workflow that launches it,
there is no formal relationship between the workflow objects: they are independent. To
pause the current workflow until the process completes, define the next activity so that
it triggers in response to an event (on the Trigger tab) and include in the other process
an activity, based on the Post Event to Parent Process activity template, that posts the
event the parent process is waiting for.
Before configuring an Invoke Process activity, you must select the user to serve as the
workflow supervisor for the new workflow.
To congure an Invoke Process activity:

1. In the Activity Inspector, click the Invoke Process tab.

2. Select a child process from the Process Name list box. The required packages in the
selected template must match packages from the current workflow in both name and
type. The matching applies to all defined packages, not just visible packages.
3. Select an activity from the Start Activity list box, or select Start all activities.
This will start the selected activity of the new process, or start all Start Activities of
the process with the same workflow ID.
4. Click Next.
5. If the child process has packages, provide values for the packages using the data
mapping tool.
On the Input Message Mapping screen, the left column of the data mapping tool
shows the packages of the parent process. The right column shows the packages of
the child process. If there is more than one package in the process, you must map
the mandatory packages that are shown in bold. Failing to do so results in an error.
The right column also shows the Supervisor attribute. The value of this attribute
must be String data type. If you do not select the supervisor, then the supervisor
of the parent process is used. While mapping, the packages of the activity must be
of the same package type or a super type of the packages of the parent workflow.
mapping tool.
6. Click Next.
shows the workflow ID of the activity. Users can optionally copy this ID to the
package attribute for tracking, or audit purposes. The right column shows package
attributes of the parent process.
mapping tool.
Web Service
This activity template enables you to invoke document-literal style web services. Web
Services activities differ from the other integration activities in two key ways:
• The content that you send to the Web service must be a well-formed XML file that is
namespace self-sufficient.
• Web services respond to messages sent to them, so the activity needs to be able to
handle a response.

To invoke a Web service, you must have a Web Services Description Language (WSDL)
document that provides the necessary information for accessing the service. The custom
parameters for Web Service activities identify the WSDL document and the XML content
to send to the service. They also specify how to handle the response from the Web service.
• WSDL document — This required parameter points to a file containing the WSDL
content for the Web service. The file must be a well-formed WSDL document stored
in the repository. You can navigate to the file by clicking the button next to the
text box.
• Service name — In many cases the WSDL document includes the name of the Web
service for the activity to invoke. If it does not, or if the WSDL document includes
more than one service definition, you need to type the Web service name in this
otherwise optional parameter.
• Operation name — This required parameter specifies the name of the Web service
operation to invoke.
• Port name — You need to type the port name for the intended service if the WSDL
document does not provide it or if it includes multiple port names.
• Send content from activity package — This optional parameter identifies which
content the activity passes to the Web service. The content must be well-formed
XML that is namespace self-sufficient. The parameter value is the name of one of the
activity’s inbound packages. If you do not provide a value, the activity sends the
content of the first inbound package (the package at index 0).
• Save Web service response — If you set this option to Yes, the activity saves the
response from the Web service as an XML document. The next two parameters
specify the name of the document and where in the repository it is saved. If you set
this option to No, the remaining parameters are not relevant.
• Save response to folder — If you elected to save the response from the Web service,
this parameter specifies the repository folder into which the activity saves the XML
document. The default location is /Temp.
• Response document name — If you elected to save the response from the Web
service, this parameter specifies the name given to the XML document. If you do not
type a name, the activity creates a name using the name of the Web service followed
by the word "Response" and the date and time of the response.
• Attach response document to package — If you elected to save the response from
the Web service, this parameter specifies the output package to which the XML
document is added. Adding the document to an output package causes the activity
to forward it to the next activity in the workflow. If you do not type the name of a
valid output package, the XML document is not forwarded.

Web Service Inbound - Initiate and Step

Use Web Service Inbound to create a new web services end-point for an activity that
needs to provide an integration point and a WSDL to an external system.
For example, you could use the Web Service Inbound activity template in a loan
application process to start the process after it receives an incoming application. You can
set up the activity with WS-Security to require that the applicant provide a username and
password to secure the web service. If the loan application includes large documents,
you can enable MTOM support for the activity that will enable the activity to send and
receive optimized binary data as attachments.
As a step in a process, the Web Service Inbound - Step activity can be used to receive
information from an outside source. The activity can also be used to verify income or
get other related information from an outside source. You can enable security to ensure
that only authorized individuals can initiate the process.
You can enable correlation of the messages by using a correlation identifier that is a
unique ID generated for each workflow. This correlation ID should be added to the SOAP
header in a format defined by the WS-Addressing standard, as in the following example:
<SOAPENV:header>
<wsa:RelatesTo xmlns:wsa={WS-AddressingSchema}>{correlationid}
<wsa:/RelatesTo>
</SOAPENV:header>
There are two different ways to define the web service:

• In the Process First option, you define the port and operation and the system creates
a WSDL from the process definition. The system creates one WSDL for a process,
with a section for each Web Service Inbound activity contained within it.
Note: The generated WSDL can only contain the process variables associated with
the activity if they have been selected to be visible for that activity in the Activity
Inspector. Changing process data in an activity, page 141 provides instructions on
how to make a process variable visible to an activity.
• In the WSDL First option, you specify an existing WSDL for the system to use in the
process.
Note: Before adding a Web Service Inbound activity to a process, configure the target
namespace URI on the Advanced tab of the Process Properties dialog box. The system
cannot validate or save the process without the target namespace.
A structured data type created through importing an XML schema may not have the
target namespace defined. To use this structured data type in a Process First model,
perform one of the following:

• If the structured data type is in use, create a new structured data type with a different
name and define the target namespace in the schema used to create the structured
data type.
• If the structured data type is not in use, edit the schema to define a target namespace
and recreate the data type.
To congure Web Service Inbound

1. In the Activity Inspector, click the Web Service Inbound tab.
2. If you select the option to use Process First, a process is described in activity
template and after it has been loaded, and the system creates a WSDL from the
process definition.
a. Type the name of the of port type.
b. Type name of the operation to be exposed to the client.
c. Select Content Based Correlation to enable the system to correlate messages
based on the correlations set.
d. In the Correlation Set list, select a correlation set name.
Note: The Process First model does not require the data and correlation set to be
mapped since the mapping are done implicitly.
3. To use an existing WSDL to define the web service, select WSDL First.
a. Type the WSDL File URL/Path to the WSDL used for the activity.
b. Click Read to retrieve the WSDL from the location that you have specified.
c. Select a port type from the list.
d. Select the name of the operation to be exposed to the client.
4. To enable a WS Security UserName Token authentication, select the checkbox and
enter the username and password.
The WS-Security handler provides credential-based access to the activity or process
(when used in an initiate activity). Once enabled, all client requests to this activity
must contain the same credentials in the request header (in structure defined by
WS-Security schema for UserTokens) to be granted access to the activity or process.
5. Select MTOM to enable the system to optimize any attachments while sending
the response.
Note: MTOM is not available for the Process First option.
message.

The SOAP message structure appears in the left-hand pane and the process data on
the right-hand side. You can set values for attributes of the process data model by
mapping them from SOAP message attributes.
The following mappings are required for attachments:
• Document content
• File format
If you have multiple attachments, you can click Add on the Attachment node to
add more attachments.
data mapping tool.
Using correlation identifiers, page 157 gives more details on defining correlation
sets for a process.
data mapping tool.
Adding message properties, page 148 provides instructions for adding a
Sample
The Sample window contains a sample activity template that shows the various types of
user interface controls available for custom activity data-entry panels. In addition to the
sample activity template, the Sample window includes two activity templates related
to queue management:

• Sample Activity Template, page 232

• Set Queue Task Skill, page 232
• Queue Task Rework Decision, page 232
Refer to the Documentum Webtop User Guide for more information about queue
management.
Sample Activity Template

Process Builder also includes a Sample Activity Template that illustrates the format of
the activity template XML file to help you create custom activity templates and it appears
in the Sample activity template folder. Documentum Process Builder Development Guide
provides more details on using the Sample Activity Template.
Set Queue Task Skill

Activities created from the Set Queue Task Skill template set the performer skill level
required to process a given package. This skill level value overrides any previous skill
level requirement for the package.
In a typical scenario, the activity that precedes the Set Queue Task Skill activity has a
transition condition that checks the attributes of the package to determine whether it
requires special treatment. Packages requiring special treatment are routed to the Set
Queue Task Skill activity while all other packages skip this activity.
• Package Name — The name of the package for which the activity sets the required
performer skill level.
• Skill Level — The skill level to apply to the package. The valid values appear in a
list box.
Queue Task Rework Decision

Queue Task Rework Decision is a sample activity template for creating activities that
perform periodic quality checks on documents processed through a work queue. The
definition of a work queue includes a policy that specifies a percentage of documents
that should be routed to another processor for a quality assurance check.
Like the Decision Split activity template, the Queue Task Rework Decision template
creates activities whose only action is to evaluate branching logic and forward packages
as appropriate. An activity based on the Queue Task Rework Decision template routes

packages to either the Next Rework Activity or the Next No Rework Activity. It
determines which activity to route each package to based on two factors: (a) the Percent
Quality Check specified in the work queue policy associated with the Activity to Check,
and (b) the Required Skill Level parameter.
• Activity to Check — This required parameter specifies the activity that performs the
initial document processing. The performer type for this activity should be category
10 (Work Queue). Enter the activity name.
• Required Skill Level — The skill level of the performers whose work should be
checked. The range of valid values is from 0 (Trainee) to 10 (Advanced).
• Next Rework Activity Name — This required parameter specifies the activity that
performs the quality check. Enter the activity name.
• Next No Rework Activity Name — This required parameter specifies the activity to
which documents not requiring a quality check are routed next. Enter the activity
name.
The routing logic for each package is:
1. If the Percent Quality Check value from the Activity to Check is zero, route the
package to the Next No Rework Activity.
2. If the performer who handled this package in the Activity to Check has a skill level
less than the Required Skill Level parameter value, route the package to the Next
Rework Activity.
3. Route all remaining packages to the Next Rework and Next No Rework activities
in the percentage specified by the Percent Quality Check value. For example, if the
Percent Quality Check is 20 percent, route one out of every five documents to the
Next Rework activity.
Deprecated activity templates

The activity templates in the following section are no longer delivered with Process
Builder. They have been replaced with activity templates that have increased
functionality. The new activity templates provide a wizard-like interface for defining the
data transfer, including a graphical data mapping tool to specify how data is exchanged
between the data sources. These delivered activity templates enable seamless use of
Process Integrator messaging functionality from within Process Builder, and require
minimal configuration without custom development or processing.
This section exists for customers who are still using processes from older releases (5.3x or
earlier) that contain the older activity templates.

Note: These templates are installed as part of the BPM.dar file and requires you to install
Process Integrator. TheProcess Integrator Activity Template 6.5 Migration Guide provides
more details on backwards compatibility for deprecated activity templates.
Start Sub-Process
An Invoke Process activity launches a new workflow. All packages from the current
workflow whose names and types match packages in the process template for the new
workflow are passed to the new workflow. The activity is complete when the new
workflow is started.
While the new workflow is logically a subprocess of the workflow that launches it, there
is no formal relationship between the workflow objects — they are independent. To
pause the current workflow until the subprocess completes, define the next activity so
that it triggers in response to an event (on the Trigger tab) and include in the subprocess
an activity, based on the Post Event to Parent Process activity template, that posts the
event the parent process is waiting for.
• Start this workflow as a sub-process — Select the process template to use for the new
workflow from the list box. The required packages in the selected template must
match packages from the current workflow in both name and type. The matching
applies to all defined packages, not just visible packages.
• Sub-Process supervisor — Select the user to serve as the workflow supervisor for
the new workflow.
SMTP
You use this activity template to deliver content using email. Its parameters define
the content of the message, the address to which it is delivered, and the SMTP server
used to send the mail.
When you send content using email, the content files are delivered as attachments to
the message.
• To — This required parameter is the email address of the recipient, including both
the username and domain name (user@domain). You can include multiple recipients
separated by commas.
Click the ellipsis button (...) to display the Substitution Variable Dialog and choose
runtime variables.
• Cc and Bcc — These optional parameters list additional recipients of the email
message, in the same format as the To parameter.

• From — This required parameter is the email address of the sender, which displays
in the From field of the delivered message.
• Reply to — The address to which responses to this message are sent. Use this
parameter to format the reply address so that it properly addresses a Process
Integrator message handler. Typically, the Reply to address will include variables
for the server to replace at runtime, such as the workflow ID of the current
workflow. Appendix B, Substitution Variables for Custom Activity Template
Properties provides more details on this subject.
• Subject — The text you enter for this parameter displays as the subject line of the
delivered message. If you leave it blank, the message is delivered with an empty
subject line.
• SMTP Server hostname or IP — This required parameter identifies the SMTP server
used to send the message. You can type the name of the host machine or its IP
address.
• SMTP Server port number — This optional parameter identifies the port number
for the SMTP server. If you do not provide a value, the activity uses the standard
SMTP port 25.
• SMTP Server authentication user name and SMTP Server authentication password
— If the SMTP server requires a username and password, provide the name and
password.
• Attach content from activity packages — This optional parameter identifies which
content the activity includes as attachments to the email message. The value is the
names of one or more of the activity’s inbound packages, separated by commas.
If you do not provide a value, the activity sends the content of the first inbound
package (the package at index 0).
• Attach all content in folder packages — If any of the packages are sending contain
folder objects, the activity can send all documents in the folder (Yes) or it can skip
over the folder (No). If you click Yes, the activity attaches only those documents
directly inside the folder. It does not recursively attach documents from any
subfolders.
• Attach URL to the documents in message — Enables the URL to be shown as part of
the email message body.
• Attach URL to activity packages in message — Enables a user to add packages and
display the corresponding URL in the email message body.
• Attach URL to workflow attachments in message — Enables a user to add an ad hoc
attachment’s URL in the email message body.
• Use default URL to Webtop — Select No to enable users to use a URL other than
the default Webtop URL.
• Provide your URL prefix if not using default — If you are not using the default
Webtop URL, type the URL prefix to be used in the email message body.

• Provide your URL suffix if not using default — If you are not using the default
Webtop URL, type the URL suffix to be used in the email message body.
Publish to JMS Topic

You can send content using Java Message Service (JMS) in two ways: by sending it
to a JMS queue or by publishing it to a JMS topic. Use this activity template to create
activities that publish content to JMS topics.
• JNDI initial context factory class — This required parameter provides the fully
qualified class name of the JNDI initial context factory class.
• JMS provider URL — This required parameter provides the complete URL for
connecting to the JMS provider.
• Topic connection factory JNDI name — This required parameter gives the JNDI name
of the topic connection factory for the specified JMS provider.
• Topic name — This required parameter gives the name of the topic to which you
want to publish the content.
• Publish content from activity package — This optional parameter identifies which
content the activity posts to the specified URL. The value is the name of one of the
content of the first inbound package (the package at index 0). You can post the
content from only one package.
FTP
You use the FTP activity template to post content to an FTP site or directly to a file system.
• Protocol — This list box displays the available protocols for posting the content.
The supported standard protocols are FTP, FTPS (FTP over SSL), SFTP (SSH FTP),
and File.
• Server — The hostname or IP address of the FTP server to post the content to.
• Port — The port number on which the FTP server is listening.
• FTP Server user name — The username for connecting to the FTP server.
• FTP Server password — The password for the username.
• Remote Directory — The directory into which the content is posted.

• Transfer Mode — Select which method the activity uses when it posts the content.
When you select the Archive option, the activity creates a Zip file containing all of
the content and places it in the specified Remote Directory. When you select Create
Sub Directory, the activity creates a unique subdirectory in the specified Remote
Directory and places all of the content in the subdirectory. When you select All
Packages in Base Directory, the content is placed in the specified Remote Directory.
• Attach content from activity packages — This optional parameter identifies which
content the activity posts to the specified location. The value is the name of one or
more of the activity’s inbound packages. If you do not provide a value, the activity
posts the content of the first inbound package (the package at index 0).
• Archive/Directory Name — If you chose Archive or Create Sub Directory as the
Transfer Mode, the activity uses the value in this field to name the ZIP file or
subdirectory. When providing a directory name, you typically want to include a
substitution variable in the name, such as the workflow ID, so that the activity
creates a unique subdirectory for each workflow.
• Overwrite folder contents — Select whether or not to overwrite the existing files or
folders in the base directory of the FTP server with the one being transferred.
HTTP Post
The activity template for posting content using HTTP is the most straightforward of the
integration activity templates. It has one required custom parameter and two optional
parameters.
• URL — This required parameter is the complete URL of the site to which the activity
posts content, starting with the protocol prefix http://.
• Timeout (sec) — This optional parameter sets the timeout value for the HTTP
connection, in seconds. If you do not include a timeout value or set it to 0, the
connection will not timeout.
content of the first inbound package (the package at index 0). You can only post
the content from one package.
Send to JMS Queue

You can send content using Java Message Service (JMS) in two ways: by sending it
to a JMS queue or by publishing it to a JMS topic. Use this activity template to create

activities that send to JMS queues. Publish to JMS Topic, page 236 provides information
about publishing to JMS topics.
Note: Use Send to MQ JMS, page 238 to send messages to a queue when IBM MQ series
is the JMS provider.
• JNDI initial context factory class — This required parameter provides the fully
qualified class name of the JNDI initial context factory class.
• JMS provider URL — This required parameter provides the complete URL for
connecting to the JMS provider.
• Queue connection factory JNDI name — This required parameter gives the JNDI
name of the queue connection factory for the specified JMS provider.
• Queue name — This required parameter gives the name of the queue to which you
want to send the content.
• Reply to Queue name — This optional parameter provides the name of the JMS
queue to which any response message is sent.
• Message correlation ID — Process Integrator enables you to specify how inbound
messages are handled. The message correlation ID is the ID that Process Integrator
will use to identify messages as coming in response to this outgoing message.
content of the first inbound package (the package at index 0). You can post the
content from only one package.
Send to MQ JMS
Use this activity template to send content using Java Message Service (JMS) with IBM
MQ series as the JMS provider. All parameters are required.
Note: Use Send to JMS Queue, page 237 to send messages to a JMS queue when using a
JMS provider other than IBM MQ series.
• Server — The IP address or fully qualified name of the machine on which WebSphere
MQ is running.
• Port — The port on which the Queue Manager is listening. The default is 1414.
• Queue Manager — The name of the WebSphere Queue Manager. The name is case
sensitive. In most cases, the name has the form WAS_nodename_servername.

• Queue Name — The name of the queue to which you want to send the content. The
queue must be managed by the specified Queue Manager. The queue name has
the form WQ_queuename. You can locate the queuename queuename by selecting
Servers > Application Servers > servername > Server Component > Queue names
in WebSphere MQ.
• Channel Name — The name of the server connection changed created in WebSphere
MQ for connecting to MQ.
• Request Package — This parameter identifies which content the activity posts to the
specified queue. The value is the name of one of the activity’s inbound packages.
You can only post the content from one package.
Lifecycle Apply (5.3x and earlier)

Activities based on this template apply a document lifecycle to one or more packages in
the business process. A lifecycle defines an ordered series of states that correspond to
the stages of a document’s life.
To configure a Lifecycle Apply activity, you choose the lifecycle to apply and the
package(s) to apply it to. You also specify the initial state of the lifecycle and the scope
to use when resolving any aliases associated with the lifecycle. See the Documentum
Composer User Guide for details about creating and using lifecycles
• Package(s) To Apply Lifecycle — Click the ... button to display a dialog box from
which you can select the process packages to which the lifecycle will be applied. For
each package to which you want to apply the lifecycle, highlight its name in the list
on the left and click the Add button to move it to the list of selected packages on the
right. When you click OK in the dialog box, the names of the selected packages
appear in the data field.
• Lifecycle — Select the lifecycle to apply to the selected packages from the list box.
• Initial State — Enter the name of the lifecycle state in which the selected packages
will be placed.
• Scope — Select the scope to use for resolving any aliases associated with the selected
lifecycle.
Lifecycle Demote
Activities based on this template demote one or more packages to a previous state in the
associated lifecycle. You can choose to demote the package(s) to the base state (the first
state in the ordered list) or to any previous state that you identify by name.

• Package(s) To Demote — Click the ... button to display a dialog box from which you
can select the process packages that you want to demote to a previous lifecycle
state. For each package you want to demote, highlight its name in the list on the left
and click the Add button to move it to the list of selected packages on the right.
When you click OK in the dialog box, the names of the selected packages appear in
the data field.
• Demote To State — To demote the selected packages to a specific state, type the name
of the state in this field. If you leave this blank, it is demoted back to the previous
state.
• Demote To Base State — To demote the selected packages to the base state of the
lifecycle, select the Yes option.
Lifecycle Promote
Activities based on this template promote one or more packages to a subsequent state in
the associated lifecycle.
• Package(s) To Promote — Click the ... button to display a dialog box from which you
can select the process packages that you want to promote to a subsequent lifecycle
state. For each package you want to promote, highlight its name in the list on the
left and click the Add button to move it to the list of selected packages on the right.
When you click OK in the dialog box, the names of the selected packages appear in
the data field.
• Promote To State — Enter the name of the lifecycle state to which you want to
promote the selected packages. If left blank, the package is demoted to the previous
state.
• Force Promotion — Each lifecycle state has a set of entry criteria that a document
normally must meet in order to be promoted to that state. However, the Lifecycle
Promote activity template enables you to "force" promotion of a package even if it
does not meet the entry criteria for the state. Select the Yes option to promote the
selected packages regardless of whether they meet the entry criteria for the state.
BAM
The Observation Point activity template in the BAM folder provides a means of
publishing business data contained in packages from Process Builder to the ProActivity
database. This data becomes available to the Report Manager, where report designers
can create BAM reports based on package data.

Observation Point
This activity template enables you to select packages associated with a specific activity
and publish the business data to Process Analyzer to be used in reports. Activities that
are followed by an Observation Point activity template can publish package data to
Process Analyzer.
At runtime, the Observation Point activity inserts some standard attributes and all
custom attributes into the audit trail table where the Workflow Publish Events job picks
up the data and publishes it to the Process Analyzer. The following list shows the
standard attributes that are published as part of any attribute type definition:
• r_object_id
• object_name
• subject
• keywords
• title
• r_creation_date
• r_modify_date
Note: The audit trail must be enabled in the process template for package data to be
published by the Workflow Publish Events job.
See Setting process template properties, page 66 for more information on enabling the
audit trail.
To congure an Observation Point activity:

1. Identify the activities in a process that have packages that you want to monitor
and use in reports.
2. From the BAM folder, drag the Observation Point activity template into the process
and insert it immediately after the activity that you want to monitor.
There is a one-to-one correspondence between the activity and the Observation Point
that follows it. If an activity is followed by an Observation Point, the activity cannot
have outgoing links to other activities—it can only connect to the Observation Point.
Additionally, an Observation Point can have only one incoming link from an activity,
although it can have multiple outgoing links.
3. Open the Activity Inspector for the Observation Point, and click the Select Packages
tab.
4. Select the packages that will have data published to the ProActivity database at
this point in the process.
a. Click Select. A selection dialog box appears, showing the packages associated
with the process template.

b. Highlight the package name in the list on the left and click Add to add it to
the Selected Items list on the right.
c. Repeat these two steps for each package that you want to add.
d. When the selection list includes all of the packages that you want to monitor,
click OK.
The Select Packages tab displays a list of the packages that have been flagged for
monitoring.
Note: Observation Point activity templates are not visible when imported into Process
Analyzer. Instead, the activity that precedes the activity template is flagged as a
monitored activity and contains information detailing which packages are identified
for reporting. When the business process is imported back into Process Builder, the
Observation Point activity template is restored in the process flow.
Workow Publish Events job
The Workflow Publish Events job publishes the events captured in the audit trail to the
ProActivity database at regular intervals. This job is delivered as part of the Process
Engine install. For more information on configuring the dm_WFPublishEvents job, see
Process Builder Installation Guide.

Appendix B
Substitution Variables for Custom
Activity Template Properties
When typing values into the fields on a custom tab in the Activity Inspector, a user can include
variables that are replaced at runtime with values from the current environment, such as the name
of the workflow or the task performer. The variable can be the complete value of the field, or it can
appear anywhere within a longer string that contains literal text, other substitution variables, or both.
Note: Variable substitution is available only in fields whose data type is String.
To include a variable, type <dmp:param>supported_variable</dmp:param>, where supported_variable is
one of the variables listed in the table below. Each variable is composed of two parts, separated by
a period: a parameter type, which identifies the type of the object from which the value is derived,
and an attribute name, which identifies the specific value to insert at runtime. For example, the
variable <dmp:param>workflow.creator</dmp:param> will be replaced at runtime with the value of
the creator attribute of the workflow object. If the selected attribute can have multiple values, the
substitution variable also includes an index to specify which of the values to use.
If a field has an ellipsis (...) button next to it, you can select the variable from a dialog box rather
than typing it. When you close the dialog box, Process Builder inserts the selected variable at the
current cursor location.
To insert a substitution variable using the dialog box:

1. Position the cursor in the field at the location where you want to insert the variable.
2. Click the ellipsis (...) button next to the field.
The Substitution Variable Dialog box appears.
3. From the Parameter type list box, select the object type or the name of the package
that contains the intended value.
The Attribute list displays the available attributes for the selected item. Or, if you
select alias as the parameter type, the Alias Set and Alias Name lists appear.
4. If you selected alias as the parameter type, select an alias set from the Alias Set list
box, then select the specific alias from the Alias Name list.

Substitution Variables for Custom Activity Template Properties
5. If you selected any parameter type other than alias, select from the Attribute list the
attribute whose value you want to substitute into the string.
6. If the attribute you selected at step 5 can have multiple values, specify which value to
use by selecting FIRST or LAST from the Index list.
To use the value from a specific index position other than FIRST or LAST, edit the
variable after closing the dialog box, replacing FIRST or LAST with an integer value.
The FIRST position is equivalent to index position 0.
7. Click OK to close the dialog box.
Process Builder inserts the selected variable at the current cursor location.
Table 12. Supported Substitution Variables for Activity Conguration Fields
Variable Description
workflow.creator The username of the person who created
the workflow
workflow.instructions The text from the Workflow Instructions
text box in the Process Properties dialog
box.
workflow.id The ID of the workflow
workflow.name The name of the workflow
workflow.process_id The ID of the process template from which
the workflow was generated
workflow.start_date The date when the workflow was started
workflow.supervisor The username of the person identified as
the workflow supervisor (the workflow
creator by default)
workflow.supervisor_address The workflow supervisor’s email address
task.act_id The ID of the activity that generated the
current task
task.number The sequence number within the workflow
of the activity that generated the task
task.auto_method_id The ID of the method definition for an
automatic activity. If the task is not an
automatic activity, the value of the variable
is "0000000000000000".
task.creation_date The date format is determined by the
default time pattern set in DFC.

task.due_date The date format is determined by the
default time pattern set in DFC. If the task
has no due date, the value of the variable
is "nulldate".
task.performer The performer of the task
task.performer_address The task performer’s email address
task.priority The priority value assigned to the task

task.state The current state of the task, represented
as an integer
packagename.attribute The value of any single-value attribute of
the package specified by packagename.
When selecting the variable from the
Substitution Variable Dialog box, the dialog
box displays all custom attributes and a
commonly used subset of the standard
dm_document attributes. However, you
can use any attribute.
packagename.attribute[index] The value of any multi-value attribute of
the package specified by packagename. The
index identifies which value to use: FIRST,
LAST, or an integer indicating a position in
the list of values.
When selecting the variable from the
Substitution Variable Dialog box, the dialog
box displays all custom attributes and a
commonly used subset of the standard
dm_document attributes. However, you
can use any attribute.
doc.id The ID of the first document in the first
package processed by the activity
doc.name The name of the first document in the first
package processed by the activity
note.id The ID of the first note attached to the
document, if any exists
note.writer The name of the person who created the
note
note.text The text of the note

note.creation_date The date when the note was created
alias.alias_nameor alias.alias_set.alias_name System alias, where alias_name identifies
the alias you want to resolve. If you include
the optional alias_set, the server uses the
alias from the specified alias set
VarName or VarName.<attribute value> The value of the process variable

Appendix C
Process Builder Conguration File
Process Builder has a configuration file that controls certain aspects of its user interface. The
bpmconfig file is an XML file that resides in the folder \System\Workflow\Config. It controls:
• Whether Process Builder enables users to set the object type or version for packages
• Where in the repository users can save process templates
• Whether Process Builder requires unique names for process templates
• How many process template names appear in the Recent File list available from the File menu
The table below describes the parameters in the configuration file. To change a value, edit the file with
a text editor, changing the values as necessary.
Table 13. bpmcong Parameters
Parameter Description Default Value

unique-template-name Set to true to require that process template names false
be unique across the repository
show-package-version Specifies whether Process Builder enables users to true
select the version of a package. If set to false, the
process always uses the CURRENT version
show-package-type Specifies whether Process Builder enables users true
to explicitly set the object type of a package. If
set to false, Process Builder uses the object type
associated with the selected form template, or
dm_sysobject if no form template is selected

Process Builder Conguration File
Parameter Description Default Value

max-recent-file Sets the maximum number of filenames that 5
appear in the Recent Files list
template-save-path If this parameter exists, Process Builder requires None
users to save process templates in the specified
folder or a subfolder. If the parameter does not
exist, users can save process templates in any
folder to which they have appropriate security
access

Index
A configuring, 105
Access Control Lists, see ACLs creating a new template, 104
ACLs Definition tab, 106
assigning to a variable, 73 activity template window
minimum permissions, 75 adding templates, 105
selecting, 76 copying custom templates, 105
setting, 75 overview, 50
system, 76 activity templates
user, 76 configuring, 105
activities copying, 104 to 105
aligning, 57 creating, 104
changing display settings, 143 installing, 107 to 108
connecting, 93 location within system, 50
copying, 56 setting preferences, 47
described, 17 showing prompt messages, 48
enabling delegation, 113 showing validation and install
fault handler, 19 prompts, 48
initiate, 18 states, 51
moving, 56 uninstalling, 107 to 108
overriding, 74 validating, 107
pasting, 56 Add Business Day function, 154
performer roles, 24 Add Days function, 154
performers, 24 Add function, 153
planning, 23 adding categories, 51
repeatable, 127 Advanced tab, 75
replacing, 58 aging tasks, 30
retry intervals, 113 alias sets
selecting conditionally, 41 default, 119
setting triggers, 126 specific, 119
snap to grid, 58 aliases
task subjects, 28 creating alias sets, 27
transition types, 40 performers alias, 130
trigger condition, 37 using in workflow, 27
wait for messages, 18 aligning activities, 57
Activity Inspector, 109 all users in a group, 25
activity template folders all versions, 64
adding, 47 Apply to all selected option, 93, 110
removing, 48 assign performers now, 117
removing activity templates, 105 assigning performers, 116
Activity Template Inspector asynchronous messages, 18
attributes, 147

Index
audit trail Lifecycle Promote, 240

configuring, 67 Link to Folder, 178
enabling, 20 content-type, 147
observation points, 241 continue execution option, 114
sub-processes, 97 Copy function, 154
Workflow Publish Events job, 242 copying activities, 56
auto-launch package, 142 correlation ID, 157
automatic activities correlation sets
attributes, 17 creating, 78
execution parameters, 113 defined, 157
priority values, 30 using, 158
valid performers, 125 Count function, 154
automatic performers Create Folder activity template, 175
choosing, 112, 125 current versions, 64
tasks, 112
automatic workflow methods, 170
D
data, 147
B data definitions, 49
BAM reporting data mapping
configuring audit trail, 67 functions, 153
enabling, 20 input context, 152
exposing packages, 72, 142 procedure, 150
exposing structured data types, 54 repeating attributes, 151
sub-processes, 97 single-valued attributes, 152
updating BAM definitions, 54 using correlation sets, 157
updating process data, 49 using functions, 153
BAM updates, 49 data mapping tool
BOF Module activity template, 184 adding an XML schema, 149
breakpoints, 168 adding conditional nodes, 149
Business Activity Monitor, see BAM adding message properties, 148
Byte to String function, 154 editing process data, 147
function editor, 153
mapping data, 150
C overview, 145
calendars, see process calendars package attributes, 147
categories, 51 using repeating attributes, 151
checking out processes, 64 Data tab, 69, 109
choosing Database Inbound activity template, 186
automatic performers, 125 Database Read activity template, 188
manual performers, 114 Database Stored Procedure activity
complex data types, 35, 52, 55 template, 190
Concat function, 154 Database Write activity template, 193
conditional nodes, 149 Date to String function, 154
conditional performers, 116, 121 debugging processes
content services templates adding breakpoints, 165
Create Folder, 175 automatic tasks, 169
ECIS activity template, 179 automatic workflow methods, 170
Lifecycle Apply, 176, 239 continue to next breakpoint, 168
Lifecycle Demote, 176, 239 environment, 163, 170

Index
exiting, 168 email templates, 69

force complete task, 169 creating, 128, 139
graphical elements, 164 for timers, 128
inbound initiate activity, 166 end activities, 17
manual initiate activity, 166 enumeration, 149
manual tasks, 168 execution data, 20
overview, 161 execution log, 113
rerunning a debug session, 168 exporting process templates, 89
setting port number, 47 extension, 28
starting a workflow, 165
stepping into an automatic
activity, 167
F
stepping over an activity, 167 failover
stopping, 168 execution options, 113
Task Manager tab, 168 retry options, 113
Decision Split activity template, 181 setting method timeouts, 113
default alias set, 67, 119 fault handler activities, 17, 19, 66, 93
define performer alias, 119 FAX Outbound activity template, 208
defining performers, 115 File menu, 44
delegation, 28, 113 Flow Inspector, 93
deleting objects, 56 flow templates
determining performers, 116 Decision Split, 181
digital signatures, 29 Join, 182
display settings Post Event to Parent Process, 182
changing, 143 Start Sub-Process, 234
flows, 94 XSL Transformation, 183
Display tab, 94, 100, 109, 143 flows
Display toolbar, 45 adding fault handlers, 93
Divide function, 155 described, 93
dm_changedactivityinstancestate, 68, 139 display settings, 94
dm_delegatedworkitem, 68, 139 fault handler, 21
dm_QmPriorityAging job, 32 Flow Inspector, 93
dm_startedworkitem, 68, 138 forward, 21
dm_WfmsTimer job, 39 reject, 21
dm_workflow, 29 folders
dmi_package, 29 managing, 105
dmi_queue_item, 29 process sharing, 46
dmi_workitem, 29 Force Complete Task button, 169
draft state, 64, 103 format, 147
dynamic priority, 32, 111 forms
Dynamic Web Service activity adding, 70
template, 198 adding to a package, 37
adding to an activity, 142
properties, 71
E selecting, 77, 112
ECIS activity template, 179 Forms Builder, 18, 37, 71, 78, 112
Edit menu, 44 FTP activity template, 236
element data types, 55 FTP Inbound activity template, 211
Email Inbound activity template, 206 FTP Outbound activity template, 214
email notifications, 39 functions, 153, 190

Index
G Send to JMS Queue, 237

General tab, 66 Send to MQ JMS, 238
Get Day function, 155 SMTP, 234
Get Month function, 155 SMTP Activity, 224
Get Value function, 155 Web Service, 227
Get Year function, 155 Invoke Process activity template, 226
GetEmailAddress function, 155 IWQTaskPriority interface, 32
getInitialPriority method, 31
J
H JMS Inbound activity template, 220
HTTP Inbound activity template, 215 JMS Outbound activity template, 222
HTTP Outbound activity template, 218 Join activity template, 182
HTTP Post activity template, 237 Join function, 155
HTTP/WebService Inbound Port
Number, 47 L
Lifecycle Apply activity template, 176,
I 239
icons, 45 Lifecycle Demote activity template, 176,
IDfModule interface, 32 239
importing, process templates, 87 Lifecycle Promote activity template, 240
inbound activities Link to Folder activity template, 178
port number, 47
initiate activities, 17 to 18 M
installed state, 64, 103 manual activities
installing aliases as performer, 27
activity templates, 108 attributes, 17
process templates, 81 to 82 delegation, 28
installing activity templates, 107 extension, 28
integration templates valid performers, 24
BOF Module, 184 manual performers
Database Inbound, 186 all members in a group, 115
Database Read, 188 choosing, 112, 114
Database Stored Procedure, 190 defining performers, 115
Database Write, 193 multiple sequential performers, 115 to
Dynamic Web Service, 198 116
Email Inbound, 206 previous activity’s performer, 115 to
Fax Outbound, 208 116
FTP, 236 repository owner, 115
FTP Inbound, 211 selecting based on conditions, 116
FTP Outbound, 214 selecting based on process data, 116
HTTP Inbound, 215 single user from a group, 115
HTTP Outbound, 218 single user from group, 116
HTTP Post, 237 some users from a group, 115
Invoke Process, 226 specific user, 115
JMS Inbound, 220 tasks, 112
JMS Outbound, 222 work queue, 115
Process Data Mapping, 223 workflow supervisor, 115
Publish to JMS Topic, 236 mapping data

Index
to work queue skill set, 124 pasting activities, 56

message correlation Performer tab, 109, 112, 114, 125
configuration fields, 158 performers
correlation identifiers, 157 aliases, 119, 130
correlation sets, 158 automatic, 112, 125
defined, 157 choosing, 24
messages determining at runtime, 26
adding XML schemas, 149 manual, 112, 114
properties, 148 roles, 24
moving activities, 56 selecting based on conditions, 121
Multi-segment flows, 93 selecting based on process data, 123
multiple sequential performers, 25 using aliases, 27
multiple tabs view, 61 using delegation and extension, 28
Multiply function, 155 permissions, 75
placeholders, 225
Post Event to Parent Process activity
N template, 182
Navigator, 61 Post Timer Expires, 68
nodes post-timer, 38, 99, 127
adding conditions, 149 Pre Timer Expires, 68
mapping, 140, 226 pre-timer, 38, 99, 127
process data tree, 123 Preferences dialog box, 47 to 48, 50
Note Inspector, 59 previous activity’s performer, 25
Notification tab, 38, 109, 137 print preview, 90 to 91
Notification Template Wizard, 138 printing process templates, 90
notification templates, 138 priority
notifications, 39 activities, 30
from timers, 129 how system increases, 31
notifying supervisor, 38, 137 implementing, 32
resolving, 31
O selecting levels, 111
objects setting dynamic priority, 32
setting initial, 30
deleting, 56
selecting, 56 setting static priority, 32
priority module
overriding activities, 74
example, 33
priority modules
P associating with an activity, 114
package data, 20 defined, 31
packages Process Analyzer
adding to template, 69 sharing processes, 45
attributes, 147 XPDL files, 47
automatically launch, 142 process calendars, 77, 127
defining, 35 process data
exposing for reporting, 72 defining, 34
mandatory, 71 defining packages, 34
showing additional attributes, 148 defining process parameters, 36
storing document names, 67 defining process variables, 35
page setup, 90 described, 19
parameter type, 243 managing, 141

Index
mapping to work queue skill set, 124 versioning, 70, 84

Process Data Mapping activity process variables
template, 223 access control lists, 73
process debugger, see debugging processes adding to a flow, 69
process parameters defined, 20
administering, 36 defining, 35
defining, 36 permission requirements, 76
managing, 73 types, 73
overview, 36 prompts
types, 74 showing install and validate
Process Properties, see process templates prompts, 48
process sharing folders, 46 showing warning messages, 48
process template editor pane properties
adding text notes, 56 adding, 29
described, 56 adding to a message, 148
Process Template owner, 67 Properties tab, 109 to 110
process templates Publish to JMS Topic activity
adding a form, 70 template, 236
adding aliases, 67
adding email messages, 68
adding notes, 59
Q
adding process data, 69 Queue Task Rework Decision activity
adding process parameters, 73 template, 232
adding process variables, 72
Advanced tab, 75 R
architecture, 16 re-importing process templates, 88
canceling check out, 86 Reject flows, 93
changing properties, 66 repeating attribute
checking in, 84, 86 transition conditions, 136
checking out, 84 to 85 repeating attributes
creating, 56, 64 mapping, 151
Data tab, 69 task subjects, 29
deleting, 87 reporting
described, 17 configuring audit trail, 67
displaying multiple tabs, 61 configuring audit trail settings, 67
exporting, 89 enabling, 20
importing, 87 exposing packages, 72, 142
installing, 82 exposing process variables, 36
modifying, 83 exposing structured data types, 54
opening, 64 sub-processes, 97
printing, 90 updating BAM definitions, 54
re-importing, 88 updating process data, 49
saving, 79 repository owner, 24
setting ACLs, 75 Rerun debug button, 168
setting zoom level, 58 Resource Navigator, 43
sharing with Process Analyzer, 45 retry intervals, 113
states, 63
uninstalling, 82
using the navigator, 61 S
validating, 81 sample templates

Index
Queue Task Rework Decision, 232 sub-processes

Set Queue Task Skill, 232 bottom-up modeling, 98
saving process templates, 79 collapsing, 100
Select Performer, 114, 125 deleting, 101
selecting objects, 56 display options, 100
Send to JMS Queue activity template, 237 expanding, 100
Send to MQ JMS activity template, 238 notes, 101
server validations, 107 overview, 97
Set Queue Task Skill activity template, 232 removing activities, 101
sharing process templates, 45 setting properties, 99
sign-off requirements, 29, 113 Sub-Process Inspector, 98
simple data types, 35, 52 timers, 99
Single Segment Flows, 93 top-down modeling, 97
single user from group, 25 substitution variables, 243
skill set, 124 Substring function, 156
SMTP Activity activity template, 224 Subtract function, 156
SMTP activity template, 234 supervisor notifications, 38, 137
snap to grid, 58
some users from a group, 25
specific user, 25
T
Split function, 155 tabs
start activities, 17 Activity Inspector, 105
Start Sub-Process activity template, 234 suppressing the display of, 107
step activities, 17 viewing, 61
Step into button, 167 Task Manager tab, 168
Step over to next activity button, 167 task name, 111
stop execution option, 114 task_subject attribute, 28 to 29
stored procedure, 190 tasks
storing document names, 67 aging, 30
String to Byte function, 156 automatic performers, 112
String to Date function, 156 manual performers, 112
structured data types TaskSpace, 36
attributes, 53 templates
categories, 51 creating, 23
complex types, 52, 55 terminate execution option, 114
editing, 54 timers
element types, 55 associating with a calendar, 127
groups, 52 complete task, 38
managing, 72 completing a task, 132
repeatable option, 54, 56 delegate task, 38
report option, 56 delegating a task, 131
reporting option, 54 notification, 38
searchable option, 54, 56 run Java method, 38
simple, 35 running a Java method, 131
simple data types, 52 sending notifications, 129
using an XML schema, 55 starring a process, 130
wizard, 51 start process, 38
Structured Data Types window, 51 Timers tab, 99, 109, 127
Structured Data Types Wizard, 51 to 52 ToLower function, 157
Sub-Process Inspector, 98 to 99 toolbar, 44

Index
toolbar icons, 45 W
ToUpper function, 157 wait for message activities, 17 to 18
Transition Condition Wizard, 135 warning messages, 48
transition rules, 133 warning timers, 38, 99, 127
Transition tab, 109, 133 Web Service activity template, 227
transition types, 40 work items, 17
transitions work queue, 26
conditions, 41 work queue priority module, 114
Trigger tab, 109 work queue skill set, 124
triggers workflow availability, 28
events, 38 workflow instructions, 67
setting, 37, 126 workflow supervisor, 24
Workflow toolbar, 45
U workflows
uninstalling overview, 13
activity templates, 107 to 108 packages, 34
process templates, 82 planning, 22
Update BAM Data Definitions option, 49 process variables, 36
Use Form for Properties, 71
X
V XML schemas
validated state, 64, 103 adding to messages, 149
validating in Activity Template Inspector, 106
activity templates, 107 using in structured data types, 55
process templates, 81 XPDL
validation exporting, 89
server, 107 importing, 87
showing prompt messages, 48 re-importing, 88
variables XPDL files, 46
editing, 143 XSD file, 55
substitution, 175, 179, 185, 187, 189, XSL Transformation activity template, 183
195, 243
versions, 70 Z
View menu, 44 zoom options, 58
viewing processes, 64

Document Um Process Builder User Guide Version 6.5

Uploaded by

Copyright:

Available Formats

You might also like

Document Um Process Builder User Guide Version 6.5

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Document Um Process Builder User Guide Version 6.5

Uploaded by

Copyright:

Available Formats

EMC® Documentum®

Chapter 2 Using Process Builder ........................................................................... 43

EMC Documentum Process Builder Version 6.5 User Guide 3

Managing activity template folders .......................................................... 47

Chapter 3 Working with Process Templates .......................................................... 63

Chapter 4 Connecting Activities ........................................................................... 93

4 EMC Documentum Process Builder Version 6.5 User Guide

Chapter 5 Creating Sub-Processes ........................................................................ 97

Chapter 6 Working with Activity Templates ......................................................... 103

Chapter 7 Working with Activities ........................................................................ 109

Chapter 8 Mapping Process Data Elements ........................................................ 145

EMC Documentum Process Builder Version 6.5 User Guide 5

Adding message properties ....................................................................... 148

Chapter 9 Debugging a Process Template ........................................................... 161

Appendix A Delivered Activity Templates ............................................................... 173

6 EMC Documentum Process Builder Version 6.5 User Guide

Configuring HTTP proxy parameters in UNIX-based

Appendix B Substitution Variables for Custom Activity Template

Appendix C Process Builder Conguration File ..................................................... 247

EMC Documentum Process Builder Version 6.5 User Guide 7

Figure 1. Process templates capture business processes ................................................... 14

8 EMC Documentum Process Builder Version 6.5 User Guide

Table 1. Activity performer selection categories ............................................................ 24

EMC Documentum Process Builder Version 6.5 User Guide 9

10 EMC Documentum Process Builder Version 6.5 User Guide

Revision Date Description

EMC Documentum Process Builder Version 6.5 User Guide 11

12 EMC Documentum Process Builder Version 6.5 User Guide

EMC Documentum Process Builder Version 6.5 User Guide 13

14 EMC Documentum Process Builder Version 6.5 User Guide

EMC Documentum Process Builder Version 6.5 User Guide 15

Figure 2. Components of a workow

Process templates and associated workow

16 EMC Documentum Process Builder Version 6.5 User Guide

The process template defines the structure of a business process. It is composed of

EMC Documentum Process Builder Version 6.5 User Guide 17

Wait for message activities

A business process can participate in asynchronous communication with other external

18 EMC Documentum Process Builder Version 6.5 User Guide

Fault handler activities

A fault handler activity is a secondary activity that is triggered when an associated

Figure 3. Fault handler activity

EMC Documentum Process Builder Version 6.5 User Guide 19

• Process parameters that enable administrators to modify a constant value for a

Enabling reporting for Business Activity Monitor (BAM)

20 EMC Documentum Process Builder Version 6.5 User Guide

EMC Documentum Process Builder Version 6.5 User Guide 21

Planning workow processes

22 EMC Documentum Process Builder Version 6.5 User Guide

• When does the activity start?

Choosing or creating activity templates

EMC Documentum Process Builder Version 6.5 User Guide 23

Table 1. Activity performer selection categories

User category How performers are selected

24 EMC Documentum Process Builder Version 6.5 User Guide

User category How performers are selected

EMC Documentum Process Builder Version 6.5 User Guide 25

User category How performers are selected

Dening when the performer is determined