EMC Documentum ProcessBuilder · EMC®Documentum® ProcessBuilder Version6.5SP1 UserGuide P/N300-008-167-A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748 …

EMC® Documentum®

Process BuilderVersion 6.5 SP1

User GuideP/N 300-008-167-A01

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

Copyright © 2004 - 2008 EMC Corporation. All rights reserved.

Published December 2008

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS 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 ............................................. 13Introducing workflows ............................................................................... 13Process templates and associated workflow objects....................................... 16Activities ............................................................................................... 17Initiate activities ................................................................................. 18Wait for message activities .................................................................. 18Fault handler activities........................................................................ 19

Process data ........................................................................................... 19Enabling reporting for Business Activity Monitor (BAM) ...................... 20

Flows..................................................................................................... 21Planning workflow processes ...................................................................... 22Choosing or creating activity templates.................................................... 23Choosing activities ................................................................................. 23Choosing performers .............................................................................. 24Defining when the performer is determined ......................................... 26Using aliases ...................................................................................... 27

Enabling delegation and extension........................................................... 28Defining task subjects ............................................................................. 28Adding a signoff requirement ................................................................. 29Setting priority values............................................................................. 30Setting initial priority and aging of tasks .............................................. 30How the system resolves the initial priority of a task......................... 31How the system increases the priority of a task................................. 31

Setting static priority and aging logic for tasks...................................... 32Setting dynamic priority and aging logic for tasks ................................ 32Sample priority module .................................................................. 33

Understanding process data .................................................................... 34Understanding packages..................................................................... 34Understanding process variables ......................................................... 35

Understanding process parameters.......................................................... 36Associating form templates with packages ............................................... 37Setting trigger conditions ........................................................................ 37Setting timers ......................................................................................... 38Setting up notifications ........................................................................... 39Defining activity transitions .................................................................... 40Determining transition conditions ....................................................... 41

Chapter 2 Using Process Builder ........................................................................... 43Process Builder design environment ............................................................ 43Process Builder toolbar ............................................................................... 44Setting process template preferences............................................................ 45Sharing process templates with Process Analyzer ..................................... 45Setting process sharing folder locations................................................ 46

Setting the port number for debugging inbound activities ......................... 47

EMC Documentum Process Builder Version 6.5 SP1 User Guide 3

Table of Contents

Managing activity template folders.......................................................... 47Setting process template message preferences .......................................... 48Updating process data in the BAM database............................................. 49

Activity Templates window ........................................................................ 50Structured Data Types window ................................................................... 51Creating structured data type categories and groups ................................ 51Creating structured data types ................................................................ 52Editing structured data types .................................................................. 54Creating a complex structured data type from an XML schema ................. 55

Process template editor pane ....................................................................... 56Aligning activities .................................................................................. 57Replacing an activity............................................................................... 58Snap to grid ........................................................................................... 58Zooming in or out .................................................................................. 58Adding notes ......................................................................................... 59Viewing multiple processes by using tabs ................................................ 61

Process validation tab ................................................................................. 61Navigator .................................................................................................. 62

Chapter 3 Working with Process Templates .......................................................... 63Process templates overview......................................................................... 63Opening existing process templates ............................................................. 64Creating process templates.......................................................................... 64Setting process template properties.............................................................. 66Managing process data ............................................................................... 69Managing packages ................................................................................ 69Managing process variables..................................................................... 72Managing process parameters ................................................................. 73Overriding activity-level settings ............................................................. 74

Configuring advanced options .................................................................... 75Setting Access Control List (ACL) options ................................................ 75Selecting a calendar for the process .......................................................... 77Assigning a Process Parameter form ........................................................ 77Creating correlation sets.......................................................................... 78Enabling inbound web services ............................................................... 79

Saving process templates ............................................................................ 79Validating process templates ....................................................................... 81Using the process validation tab .............................................................. 82

Installing process templates ........................................................................ 83Modifying process templates....................................................................... 85Checking in, checking out, and versioning process templates ........................ 85Deleting process templates .......................................................................... 88Importing process templates ....................................................................... 88Keeping shared processes in sync ................................................................ 89Exporting process templates........................................................................ 91Printing process templates .......................................................................... 91Setting page setup options ...................................................................... 92Previewing printed processes .................................................................. 93

Chapter 4 Connecting Activities ........................................................................... 95Creating flows............................................................................................ 95

4 EMC Documentum Process Builder Version 6.5 SP1 User Guide

Table of Contents

Changing flow display settings.................................................................... 96

Chapter 5 Creating Sub-Processes ........................................................................ 99Creating a sub-process using top-down modeling......................................... 99Creating a sub-process using bottom-up modeling ..................................... 100Setting sub-process properties ................................................................... 101Using the Timers tab............................................................................. 101Using the Display tab............................................................................ 102

Managing sub-processes ........................................................................... 102Expanding and collapsing a sub-process ................................................ 102Removing activities from a sub-process.................................................. 103Adding notes to a sub-process ............................................................... 103Deleting a sub-process and its contents .................................................. 103

Chapter 6 Working with Activity Templates ......................................................... 105Creating activity templates........................................................................ 106Managing activity templates within folders ................................................ 107Configuring activity templates .................................................................. 107Validating and installing activity templates ................................................ 109

Chapter 7 Working with Activities ........................................................................ 111Setting activity properties ......................................................................... 112Selecting performers ................................................................................. 114Associating a work queue priority module with an activity ..................... 116Choosing manual performers ................................................................ 116Assign performer(s) now .................................................................. 119Have performer(s) of <activity> determine performer(s) ofthis activity ...................................................................................... 120Define performer alias (performer(s) will be assigned whenworkflow is underway) ..................................................................... 121Select performer based on conditions ................................................ 123Select performer based on process data and processparameters ....................................................................................... 125

Mapping process data to a work queue skill set ...................................... 126Choosing automatic performers............................................................. 127

Setting activity triggers ............................................................................. 128Setting warning timers .............................................................................. 129Sending a notification ........................................................................... 131Starting a process ................................................................................. 132Running a Java method......................................................................... 133Delegating a task .................................................................................. 133Completing a task................................................................................. 134

Setting activity transition rules .................................................................. 135Creating transition conditions ............................................................... 137

Setting notifications .................................................................................. 139Using the Notification Template Wizard ................................................ 140

Changing process data in an activity.......................................................... 143Changing display settings ......................................................................... 145

Chapter 8 Mapping Process Data Elements ........................................................ 147Understanding the data mapping tool........................................................ 147Adding or editing process data in the mapper ............................................ 149


Table of Contents

Mapping package attributes ...................................................................... 149Adding message properties....................................................................... 150Adding an XML schema to activity content ............................................... 151Incorporating Forms Builder forms in a process.......................................... 151Populating a form using an XML file...................................................... 152Creating a high-fidelity form using process data..................................... 152Using an HTTP Inbound - Initiate activity to create a newhigh-fidelity form instance ................................................................ 152Using a Process Data Mapping activity to create ahigh-fidelity form instance ................................................................ 153Using a high-fidelity form to add data to a process ............................ 154

Adding a node based on a condition .......................................................... 154Mapping the data ..................................................................................... 155Using repeating attributes ..................................................................... 156Input context.................................................................................... 157

Using data mapping functions............................................................... 158Understanding message correlation ........................................................... 162Using correlation identifiers .................................................................. 162Using correlation sets............................................................................ 163

Chapter 9 Debugging a Process Template ........................................................... 165Understanding the process debugger ......................................................... 165Using the process debug environment ................................................... 167

Preparing to debug the process.................................................................. 168Adding breakpoints.............................................................................. 169Starting a workflow in the debugger ...................................................... 169

Testing a process in the debugger .............................................................. 171Using the Task Manager tab .................................................................. 172Managing a manual task ................................................................... 172Managing an automatic task.............................................................. 173Debugging automatic workflow methods....................................... 174

Using the Process Data tab .................................................................... 174Using the Console tab ........................................................................... 175Using the Manage Workflow tab............................................................ 176

Appendix A Delivered Activity Templates ............................................................... 177Content Services ....................................................................................... 179BOF Module......................................................................................... 179Create Folder ....................................................................................... 181ECIS (Enterprise Content Integration Services) Search............................. 182Invoke Process ..................................................................................... 183Lifecycle .............................................................................................. 184Lifecycle Apply .................................................................................... 186Link To Folder ...................................................................................... 186New Case from Template ...................................................................... 187

Flow ....................................................................................................... 188Decision Split ....................................................................................... 188Join...................................................................................................... 189Post Event to Parent Process .................................................................. 190XSL Transformation .............................................................................. 190

Integration .............................................................................................. 191Create ACL (access control list) ............................................................. 192Create iCalendar Event ........................................................................ 194DB Inbound — Initiate and Step ............................................................ 195


Table of Contents

DQL Inbound — Initiate and Step.......................................................... 197DQL Read ............................................................................................ 198DQL Write ........................................................................................... 199Database Read...................................................................................... 200Database Stored Procedure.................................................................... 202Example Search Patterns ................................................................... 204

Database Write ..................................................................................... 205Dynamic Web Service ........................................................................... 207Invoking non-secure Web Services ..................................................... 208Invoking secure Web Services............................................................ 209Mapping Web Service parameters.................................................. 210Configuring the HTTP proxy server............................................... 211Configuring HTTP proxy parameters in Windows ...................... 211Configuring HTTP proxy parameters in UNIX-basedsystems.................................................................................... 213

Invoking DFS (Documentum Foundation Services) servicesfrom Process Builder......................................................................... 213

Email Inbound — Initiate and Step ........................................................ 216FTP Inbound — Initiate and Step ........................................................... 217FTP Outbound ..................................................................................... 220FTP Read ............................................................................................ 222Fax Outbound ...................................................................................... 223HTTP Inbound — Initiate and Step ........................................................ 226HTTP Outbound .................................................................................. 229JMS Inbound — Initiate and Step........................................................... 230JMS Outbound ..................................................................................... 232Process Data Mapping .......................................................................... 234SMTP Activity Template ....................................................................... 235WS Inbound - Initiate and Step .............................................................. 237Web Service.......................................................................................... 240xPression Publish Document ................................................................. 241xPression Publish Document — Advanced ............................................ 242

Sample..................................................................................................... 245Queue Task Rework Decision ................................................................ 245Sample Activity Template ..................................................................... 246Set Queue Task Skill.............................................................................. 246

Deprecated activity templates.................................................................... 247BAM ................................................................................................... 247Observation Point ............................................................................. 247Workflow Publish Events job......................................................... 249

FTP...................................................................................................... 249HTTP Post............................................................................................ 250Lifecycle Apply (5.3x and earlier) .......................................................... 250Lifecycle Demote .................................................................................. 251Lifecycle Promote ................................................................................. 251Publish to JMS Topic ............................................................................. 252SMTP................................................................................................... 252Send to JMS Queue ............................................................................... 254Send to MQ JMS ................................................................................... 254Start Sub-Process .................................................................................. 255

Appendix B Substitution Variables for Custom Activity TemplateProperties ............................................................................................ 257

Appendix C Process Builder Conguration File ..................................................... 261


Table of Contents

List of Figures

Figure 1. Process templates capture business processes ................................................... 14Figure 2. Components of a workflow ............................................................................. 16Figure 3. Fault handler activity ..................................................................................... 19Figure 4. Process Builder............................................................................................... 44Figure 5. Notes add text to the visual layout................................................................... 59Figure 6. Mapping an HTTP Inbound message to process data ...................................... 148Figure 7. Manual activity in debugger ......................................................................... 167Figure 8. Approval process without and with decision split activity............................... 189Figure 9. Review process without and with join activity................................................ 190


Table of Contents

List of Tables

Table 1. Activity performer selection categories ............................................................ 24Table 2. Activity template states and related icons......................................................... 51Table 3. Permission requirements for a process ............................................................. 75Table 4. Permission requirements for process variables.................................................. 76Table 5. Process template states and related icons.......................................................... 86Table 6. Default sender and recipient based on event................................................... 140Table 7. Data Mapping Functions............................................................................... 158Table 8. Fields used to configure correlation ID........................................................... 162Table 9. Process debugger graphical elements and their purpose.................................. 168Table 10. Process debugger buttons ............................................................................. 171Table 11. Lifecycle template mappings ......................................................................... 184Table 12. Required formats.......................................................................................... 244Table 13. Supported Substitution Variables for Activity Configuration Fields ................. 258Table 14. bpmconfig Parameters .................................................................................. 261


Table of Contents


Preface

This guide is intended to help users design and build business process templates by using EMCDocumentum Process Builder. Process Builder is the design center of the Process Suite, which enablesand supports all phases of the business process lifecycle.

Intended audienceThis guide is intended for users who design business processes. It assumes familiaritywith basic EMC Documentum functionality, especially with the runtime workflowfeatures available through Documentum Webtop or TaskSpace.

Revision historyThis section contains a description of this document’s revision history.

Revision history

Revision Date Description

December 2008 Initial publication

Support informationEMC Documentum’s technical support services and policies are available at the EMCPowerlink website (http://Powerlink.EMC.com).

Note: You must register online at Powerlink before using it.


http://powerlink.emc.com

Preface

Related documentationProcess Builder is a design tool for business process templates. Workflows are createdfrom these templates at runtime The user documentation for Documentum Webtop orTaskSpace 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 1Understanding Business ProcessDesign

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 workowsYou use Process Builder to create process templates. A process template captures thedefinition 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 anengineering development process. A workflow consists of the following elements:

• A process template is the business process represented as a formalized workflowdefinition.

Users can use the template to repeatedly perform the business process. Because aprocess template is separate from its runtime instantiation, multiple workflowsbased 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 anemail, 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 suchas a document, a form, process variables like part numbers or customer addresses,or process parameters that enable administrators to modify a constant value for aspecific parameter throughout the process instance.

Process data is comprised of the process variables, process parameters and packages thatmove through the workflow.

— Process variables are individual or grouped data types or execution data usedduring the life of the process.

Different data elements that represent various types of customer information arean example of process variables. See Process templates and associated workflowobjects, page 16 for further details about these workflow components.

— Process parameters are values that enable application administrators to modifyconstant values that are used in a process. Process parameters can be usedin values that are fixed within a process such as escalation roles, transitionconditions, performer conditions, dynamic performer assignments, taskname, and task instructions. When an administrator changes the values of theparameter from the Administration tab in TaskSpace, the value is updated in anynew process instances.

— Packages contain the object, generally a document or image file, passed betweenactivities 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 createworkflows that have both serial segments, in which activities follow one another ina specified sequence, and parallel segments, in which two or more activities happenconcurrently. 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 throughthe workflow can differ depending on what happens along the way. For example, apurchase order could be routed to different activities depending on whether the managerapproves it or rejects it.

You can create a process template that can be used in many contexts. This is done byincluding activities whose performers are identified by process data or aliases instead ofactual usernames. When process data or aliases are used, the actual user is selected atruntime. For example, a typical business process for new documents has four steps:authoring the document, reviewing it, revising it, and publishing the document. Theactual authors and reviewers will be different people for different documents. Ratherthan creating a separate workflow for each document with the author and reviewernames assigned during the design process, you create one process template with activitydefinitions that use process data to define author and reviewer names. Dependingon how you design the workflow, the author and reviewers can be chosen by theperson 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 logicdefined in the workflow.

You add activities to a process template by creating a blank activity or by selectingthe appropriate activity template for the type of task represented by the activity. Theactivity template determines what configuration attributes are necessary for a particulartype of task, including attributes common to all activities (such as a name and a list ofperformers) and custom attributes unique to a particular task. For example, the activitytemplate for activities that post files to a website would include an attribute containingthe URL to use for posting. Process Builder ships with predefined activity templatesrepresenting typical activity types, and you can create custom activity templates thatexactly match your needs.

Both packages and activities can have an associated form template. The form templatedefines the data entry fields that are displayed to the users performing the activity andspecifies how the entered data is stored in the Documentum repository. You createforms using Documentum Forms Builder and associate them with processes usingProcess Builder.

A workflow’s process template is implemented by Documentum Content Server asa dm_process object. The definitions of individual activities in a process template arestored in dm_activity objects. When you design a workflow, you can include existingactivity 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 activitystarts, the server creates one or more work items (dmi_workitem), which are tasks that theserver 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 runtimeinstance work together.



Figure 2. Components of a workow

Process templates and associated workowobjects

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



The process template defines the structure of a business process. It is composed ofactivity 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 containseveral 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 responsefrom the application.

• Fault handler activities enable you to specify an action to take if an automatic activityfails.

An activity can be either manual or automatic. A manual activity is performed by aperson or multiple people. An automatic activity is performed by the system on behalfof 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 completedActivities 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 anattribute containing the vendor’s email address. The set of custom attributes associatedwith 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 inboxesof the users identified as the performers of the activity. These work items contain thepackages that the user needs to work on and instructions about the required task. Theserver adds a queue item to the inbox, linked to the work item. The Documentum ContentServer Object Reference has more information on this subject.



Initiate activities

Initiate activities specify the conditions that begin a process instance. Initiate activitiescan connect to any start activities and can be manual or automatic activities. You canbegin a workflow with one manual initiate activity, multiple automatic initiate activities,or a combination of one manual activity and several automatic initiate activities. If theinitiate activity is an automatic activity, you must specify the channel configuration andmapping rules to copy data from the message to the process data carried through theprocess. If the initiate activity is manual, you can configure the activity to automaticallylaunch a form created in Forms Builder that starts the process.

For example, a loan application process flow can have multiple initiate activities. It canbe started with a manual initiate activity that automatically launches a loan applicationform that a processor can complete during a phone-in application. The same processcan also have an automatic initiate activity that receives a loan application throughan email message.

You assign a form created in Forms Builder to the manual initiate activity on theProperties tab of the Activity Inspector.

To include an automatic initiate activity, you could create an activity named Email FormReceived, where the email account is configured and details of the email header andbody are mapped to process data that has been defined for the process.

A manual initiate activity has only the Properties, Data, and Display tabs availablefor configuring. Other initiate activities such as the Email Inbound - Initiate activitytemplate 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 externalapplications. 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 matchthe response to the original request. Any receive activity template can be configuredas a Wait for Message activity.

For example, in one activity of a purchasing process, a JMS message is sent to thesupplier 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 andthe system uses the purchase order number and vendor ID carried within the message tomatch the request to the response.



Fault handler activities

A fault handler activity is a secondary activity that is triggered when an associatedautomatic activity fails at runtime. A fault handling activity can be either a manual orautomatic activity and can be linked from more than one automatic activity. A faulthandler activity cannot have an outgoing flow. It can only be used as a fault handlerin the process.

When a fault handler is assigned to an automatic activity, the fault handler runs everytime the method associated with the activity fails. So if you have configured the systemto retry the method at a specified interval and for a specified number of times, the faulthandler will run after each method failure until the system has run through the specifiednumber of retries.

Once the system has cycled through the specified number of retries, it will take a finalaction based upon the settings in the performer tab and will either continue, stop, orterminate the workflow. Selecting performers, page 114 gives more specifics on howto set up the number of retries and the interval between retries for failed automaticactivities.

Figure 3. Fault handler activity

In the editor pane, you associate the fault handler activity with the automatic activity byusing the Assign Fault Handler flow button in the toolbar. The system identifies the faulthandler activity with a lightening bolt icon on the activity template and uses a dashedline to link the fault handler activity with its associated automatic activities.

Note: Fault handling is not supported on Inbound activity templates.

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 instanceExposing and leveraging process data enables users to see meaningful business datawhen viewing their list of tasks such as the applicant’s name, the approval status of arequest, a loan amount, and so on. This information enables a task performer to workmore 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 processor can be initialized from a form that is associated with the process. Process variablescan be simple variables such as Boolean or string values or they can be complexdata types that are based on data types defined as Structured Data Types. SeeUnderstanding process variables, page 35 for more information on process variables.

• Process parameters that enable application administrators to modify constant valuesthat 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 Administrationtab 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 theprocess 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 databasewhere it can be used to create BAM reports. Process designers can select specific processvariables, structured data types, and objects contained in packages to be used in BAMreports.

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 BAMdatabase. Setting process template properties, page 66 provides instructions onenabling the audit trail.



• Create structured data types with attributes that are selected for reporting.

Creating structured data types, page 52 provides instructions on creating structureddata types that can be monitored for BAM reporting.

• Select the packages to include in reporting from the process level or from theindividual activity.

Managing packages, page 69 and Changing process data in an activity, page143 provide instructions on selecting packages for monitoring at the process leveland 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 thatwere selected for reporting when they were created. Changing process data in anactivity, page 143 provide instructions on selecting variables and structured datatypes for monitoring at the activity level.

• Ensure that any changes to the business data you are monitoring have been updatedin the BAM database. Updating process data in the BAM database, page 49 providesmore information on updating process data in the BAM database.

The Documentum Business Activity Monitor Implementation Guide provides more detailson 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 connectedactivities.

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 apackage from the Approve activity back to Edit

• Fault handler flows determine what action to take if an associated automatic activityfails. 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. Aninitiate activity has at least one outward flow, but no incoming flow. An end activitymust have at least one incoming flow, but no outward flow.



Planning workow processesEach time you create a process template, there are design decisions to make. You mustdecide 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 ofactivities required to complete it. Choosing activities, page 23 provides some guidancefor 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 whetheryou 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 informationabout 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 theactivity? Associating form templates with packages, page 37 describes thisoption.

• 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 Understandingpackages, page 34 and Understanding process variables, page 35 gives someguidelines on adding process variables to the process flow. Understanding processparameters, page 36 provides instructions for creating process parameters.

• If you will create reports based on the flow, what process data should be exposedfor reporting?

Creating structured data types, page 52 provides more information on makingprocess 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 mustdetermine whether there is an activity template that supports each activity you will addto the process. Many activity templates include one or more custom attributes that areunique to a particular task. For example, the activity template for activities that sendemail includes an attribute that contains the target email address. The template may alsoprovide default values for attributes common to all activities.

Process Builder comes with predefined activity templates representing typical activitytypes. If your business process includes special-purpose activities to which none of theavailable templates apply, you must create custom activities whose custom attributesreflect the tasks performed with the activities. You may also develop a custom workflowmethod to perform the required task. If you commonly use a particular type of customactivity, 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 activitiesyou include depends solely on the structure of the workflow, which will depend on itsbusiness 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 activitynames 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 leastRelate permission.

You can use an activity definition more than once in a workflow. For example, supposeyou want all documents to receive two rounds of review. You might design a workflowwith the following activities: Write, Review1, Revise, Review2, and Publish. TheReview1 and Review2 activities can use the same activity definition.

However, if you use an activity multiple times in a workflow, you must structure theworkflow so that only one instance of the activity is active at any time. A workflowcannot 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 whowill perform the activity. Process Builder supports a wide range of choices for a manualactivity’s performer. For automatic activities, you must still identify a user whosepermissions 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 useror users designated as the performer of that activity. For high-volume documentprocessing, you can add the work item to a work queue that many different users workfrom. The Documentum Webtop User Guide Documentum TaskSpace Configuration Guideorthe provides more information about work queue management and performers.

The following table lists the categories from which you can choose a performer. Eachcategory is represented by an integer value. Only the first four options (0 through 3) areavailable 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 theworkflow supervisor when the activity starts. Bydefault, the user who starts the workflow is theworkflow supervisor.

1 Repository owner The server selects the user identified as the ownerof the active Documentum repository.




2 Previous activity’s performer The server selects the performer from the previousfinished activity that satisfied the trigger conditionof the current activity. (See Setting triggerconditions, page 37 for information about triggerconditions.) This can include multiple performersand can include users from other previousactivities.

3 Specific user You select an actual username when you create thetemplate.

4 All users in group You select a group name when you create thetemplate. At runtime, the server assigns a separatework item to each group member.

5 Single user from group (Firstto acquire the work item)

You select a group name when you create thetemplate. At runtime, the server assigns a newwork item to every group member. When onemember of the group acquires the work item, thework items are removed from all other groupmember’s inboxes.

6 Single user from group (Leastamount of unfinished workitems)

You select a group name when you create thetemplate. At runtime, the server determineswhich user in the selected group has the smallestworkload and assigns a new work item to that user.Workload is measured as the number of dormantand active work items.

8 Some users from a group You select a list of multiple users or aliases as theperformer of the activity. The server assigns awork item to each of the users who are chosen asperformers.

9 Multiple sequential performers You select a list of multiple users or aliases as theperformer of the activity. The server assigns thework item to the first user in the list of chosen users.When that user completes the work item, the servercreates another work item for the next user in thelist of chosen users. This continues until all chosenusers have completed their work items.

10 Work queue The server assigns the work item to the work queueyou select. Users assigned to work on that queuepull work items from the queue in priority order, orthe queue manager assigns the item to a particularuser. For more information about work queue




processing, see the Documentum Webtop User Guideor the Documentum TaskSpace Configuration Guide.

Participants in a workflow have the option to mark themselves as unavailable forworkflow tasks. When the workflow runs, if the user selected as the performer isunavailable, the workflow engine attempts to give the work item to the user’s delegateduser. See Enabling delegation and extension, page 28 for information about delegatedusers.

For information about selecting performers for an activity in Process Builder, seeSelecting performers, page 114. For details about creating activities whose performersare selected at runtime, see Defining when the performer is determined, page 26 andUsing aliases, page 27.

Dening 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 sothat 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 moreflexible, since it lets decisions about performers be based on current circumstancesand business rules. Configuring a performer based on conditions is the most flexiblestructure used to determine a performer.

If you select category 0 (Workflow supervisor), 1 (Repository owner), or 2 (Previousactivity’s performer) as the user category, the actual user is defined by the category. Forexample, an executing workflow has only one workflow supervisor and the repositoryin which it runs has only one repository owner. It is not necessary to define the actualperson 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 createthe activity. To have the actual person selected when the workflow runs, use an alias ordefine conditional logic to determine the user. Using aliases, page 27 or Select performerbased on conditions , page 123 provide more details on these subjects.

When using an alias, the user can be resolved automatically by the server using an aliasset 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 createthe 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. Justas with the other categories, you can choose the actual performers when you create theactivity, have the performer of a previous activity choose the performer, or use aliasesto have the performer chosen at runtime.

With user categories work queue, specific user, all users in a group, single user from agroup, some users from a group, or multiple sequential users, you can define conditionallogic in the activity that resolves the performer based on process data and other logicthat you define in a decision table. At runtime, the process engine evaluates the rules asthey have been set up and assigns a performer for the activity. Select performer based onconditions , page 123 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 anactual user or group name. At runtime, the server replaces the alias with the name of theactual user or group who fits the category in that time and place. Using aliases in activitydefinitions 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. Eachdepartment in your company has a different manager who must approve vacations.Rather than create a different process template for every department, you want to createone template for everyone to use. After all, the business process is the same for everydepartment. In place of specific performer names for the activities, you use an alias, suchas Manager. When the workflow runs, the server answers the question "Who is theManager 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 aliasand its associated actual value. An alias set is an object that defines a list of aliases andtheir corresponding actual values. You create alias sets in Documentum Administrator.The Documentum Content Server Administration Guide provides more details on aliassets. You can associate alias sets with particular users, and in Process Builder you canidentify a default alias set for the workflow.

When you include an alias as the performer for an activity, you can specify that the serverresolve 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 valuesfor the aliases when the workflow starts. To require the workflow initiator to resolve thealiases, you define a default alias set for the process template that contains the aliasesbut not the names to which the aliases are mapped. See Choosing manual performers,page 116 for details.

Enabling delegation and extension

When you create a manual activity, you specify whether the user performing the activityis able to delegate the activity to another performer or extend the activity by identifyingan additional performer.

With delegation, the original performer does not complete the activity. With extension,both the original performer and the designated additional performer complete theactivity.

If delegation is allowed, it can occur automatically or manually.

• Automatic delegation occurs when the server checks the availability of an activity’sperformer or performers, and determines that the person or persons is not available.When this happens, the server automatically delegates the work to the users thatthe original performer designated in theWorkflow Availability dialog box. If thereis no user identified or that user is not available, the work item is either reassignedto the workflow supervisor or returned to the original performer depending on aconfiguration 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 generatesnew work items for the second round of performers. Only after the second roundof performers completes the work does the server evaluate the activity’s transitioncondition and move to the next activity. The second round of performers do not have theoption to extend the activity any further.

See Selecting performers, page 114 for information about setting these options.

Dening task subjects

The task subject is a message that provides a work item performer with informationabout the work item. The message is part of the activity definition. It can includereferences to one or more attributes whose values the server substitutes at runtime. Forexample, 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) andcan 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 Storedocument name to the package at runtime option in the Process Properties dialogbox (see Setting process template properties, page 66).

The reference must be enclosed in curly brackets. The object type name and attributename 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. Theunresolved reference error appears in the message.

The resolved string is stored in the task_subject attribute of the task’s associated queueitem object. Once the server has created the work item, the value of the task_subjectattribute in the queue item will not change, even if the values in any referenced attributeschange.

Adding a signoff requirement

Many business processes require accountability. One way to provide accountability is torequire 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 tocomplete the activity. Signing off requires the performer to type his or her passwordto confirm that they performed the task.

Note: Content Server also supports electronic signatures and digital signatures asways to sign off tasks or the documents associated with a task. See the Content Serverdocumentation for details about these advanced sign-off options.

Setting priority values

For automatic activities, you designate a priority value that determines the order inwhich the server runs the activity relative to other actions in its queue. You can set apriority value for manual activities as well, which is reflected in the list of tasks foundin the performer’s inbox. An inbox is a user-specific area that lists the tasks currentlyassigned to the performer.

When an automatic activity is started, the activity is placed on the execution queue for aserver facility that runs periodically. The server facility executes the activities in order ofpriority. 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 thefacility runs. If the server configuration setting max_wf_jobs is set to a low number andthere are a large number of queued activities with high priority, a lower priority activitymay have to wait several invocations for execution.

See Setting activity properties, page 112 for information about setting the priority ofan activity.

Setting initial priority and aging of tasks

For most queue processors, work items appear in the inbox based on their priority. Thehighest 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 queueitem and checks for logic to enable it to assign an initial priority to the item. After thetask 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 escalationmay trigger the queue administrator to redistribute tasks or reallocate resources betweenwork queues.

The priority level at which a task first appears and the speed at which it increases inpriority 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 basedon different values you set up in the policy.

For more complex initialization and aging scenarios, you use Documentum Composerto create a priority module that contains logic to dynamically calculate and update thepriority based on process data or other attributes that belong to the process. A prioritymodule 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 initialpriority of the task by using the following criteria in this order:

1. Priority module associated with the activity definition: If there is a priority moduleassociated with the activity definition, the system uses the getInitialPriority() methodof the module and sets the return value as the initial priority.

2. Priority module associated with the work queue policy: If there is a prioritymodule associated with the queue’s work queue policy, then the system uses thegetInitialPriority() method of the module and sets the return value as the initialpriority.

3. Work queue policy: If there is not a priority module associated with the task, thesystem uses the initial_priority setting of the work queue policy object to set itsinitial priority.

How the system increases the priority of a task

Each time that the dm_QmPriorityAging job runs, it increases the priority of all workqueue tasks by using the following criteria in this order:

1. Priority module associated with the activity definition: If there is a priority moduleassociated 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 prioritymodule associated with the queue’s work queue policy, then the system uses thegetIncrementPriority() method of the module and uses the return value as theincrement priority.

3. Work queue policy: If there is not a priority module associated with the task, thesystem uses the increment_priority setting of the work queue policy object to setthe increment priority.



Setting static priority and aging logic for tasks

Work queue policies enable queue administrators or managers to define the frequency atwhich 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 uponthe initial priority setting from the work queue policy associated with that task. Aslong as the task remains in the queue, whenever the dm_QmPriorityAging job runs, itincreases the priority of the task by the amount specified in the increment priority settingof the work queue policy associated with the task. The Documentum Webtop User Guideprovides more information on setting priority and aging logic for tasks based on workqueue policies.

Setting dynamic priority and aging logic for tasks

There may be situations where both the initial priority and the amount that priorityincrements both must be calculated dynamically. In these cases, you create a prioritymodule that the system uses instead of the work queue policy to set priority and aginglogic. A priority module can be selected when creating the work queue in Webtop orTaskSpace or can be selected when creating the activity in Process Builder.

Associating a work queue priority module with an activity, page 116 provides moredetails on assigning a priority module to an activity.

Process data can be used to set the initial priority and increase the priority based onvalues in the workflow. For example, if a loan application belonging to a preferredcustomer comes through a work queue, it can be immediately placed at a higher priorityvalue than a loan application from other customers. In addition, if the loan request isfor a greater amount or comes from a preferred loan broker, then the priority can beincreased at a higher rate, ensuring that the queue supervisor is alerted if the task is notcompleted within a specified period of time. This kind of logic can be especially usefulto 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 upthe 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"// increment_priority = 5// Else// increment_priority = 0//

String broker_class = (String) witem.getStructuredDataTypeAttrValue("loan_info", "broker_class");

if (broker_class.equalsIgnoreCase("A"))return 10;

if (broker_class.equalsIgnoreCase("B"))return 5;

elsereturn 0;

}}

Understanding process data

When you define a business process, the data that is managed in the flow needs to berepresented in a meaningful way. The data in a flow can be either a workflow variable, aprocess 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 adocument, a form, or process variables like part numbers or customer addresses. Thereare two main types of process data that you can define in a process: package data andprocess variables. Both of these types of data must be defined at the process level to beused in an individual activity within that process.

Understanding packages

Packages are the objects on which activities perform their work. A package can be adocument, a form, or other data that is associated with an activity. You list all of thepackages handled by a process object as part of the process properties, then specify foreach activity which of the packages it works with. An activity can handle multiplepackages. Each package can have a form template associated with it, defining the userinterface 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 workwith one or more packages.

To define a package, you identify the item to process with the workflow. You also havethe option to choose a form that the performer of the activity working with the packageuses 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 purchaseorder 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 documentfrom 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 thedocument. In this case, you want the activity to send the new version of the componentwhen it sends the package to the next activity. In Process Builder, you accomplishthis scenario by configuring the activity to forward the same packages it receives, butforward a different version. You can specify the version by using an actual versionnumber, 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 isentirely different from the package it received. For example, suppose an activity accepts apersonnel action notice. The performer (an HR employee) must file the notice, then senda different form to the accounting department. In Process Builder, you can configure anactivity to accept certain packages as inputs and pass along other packages as outputs.

For information about configuring flows and packages in Process Builder, see Changingprocess data in an activity, page 143.

Understanding process variables

Process variables are instances of different types of data that flow through your businessprocess. These can be simple data types (a string, Boolean, or date) or they can becomplex data types that are groups of logically related data such as purchase orders,manufacturing items, and so on. Complex data types are defined in the Structured DataType window, where, as structured data types, they can be reused in multiple processtemplates in a repository.



Default values can be set only in the simple data type. Complex data types have thedefault values in the type definition.

The attributes of structured data types (process variables) can be identified to use inreporting. The process engine exposes the elements so that reporting tools can consumethe data and create static reports and BAM reports. Process variables are defined for aprocess using the Process Properties component.

Managing process variables, page 72 provides more information about defining processvariables for a workflow. Creating structured data types, page 52 provides moreinformation on defining structured data types for your repository.

Understanding process parameters

Process parameters enable application administrators to use the Administration tabin TaskSpace to modify constant values that are used throughout a process. Processparameters can be used in thresholds, deadlines, escalation roles, and other values thatare fixed across a process. When the administrator changes the values of the parameterfrom the Administration tab, any new or currently running process instances use theupdated 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. Unlikeprocess variables, process parameters cannot be shared or reused in multiple processtemplates in a repository.

For example, an application administrator may need to make changes to performervalues to respond to different business requirements. The process designer creates aprocess template that includes a process parameter approver1 and creates a constant valueof manager. Once the process is complete and installed, the application administratorcan open the process template from the Administration tab in TaskSpace, and use theassociated Process Parameter form to change the value of approver1 from manager toanother 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 recipientfor an email notification by creating the process parameter recipient2 that has a valueof [email protected]. The process parameter appears on the source side ofthe data mapper in the activity template and is available for mapping. Later, once theprocess is installed and running, the application administrator can open the process andchange the email recipient by typing a new value in the Process Parameter form.

Managing process parameters, page 73 provides more information about definingprocess parameters in Process Builder.



Associating form templates with packages

You can associate a form template with each package passed to a manual activity. A formtemplate provides a custom user interface for the performer who viewing and enteringdata. Depending on the configuration options, the performer may see the form when oneof the following occurs:• A user opens the package from their Documentum inbox• When viewing the properties of the packageThe performer fills in the form to complete the activity or to update the packageproperties. If the activity receives more than one package, the performer fills in theforms associated with each package. If a package does not have an associated form, theperformer 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 witha package when you configure a manual activity. A package can have only one formassociated with it at a time, but which form it is may change as the package movesthrough the workflow. For example, the form displayed to a manager who approves apurchase request may be different from the form completed by the person making therequest. 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 bedifferent from the form template associated with the package at the business processlevel.

To associate a form template with a package, the form template and the package musthave the same underlying data model. When you are choosing forms, Process Builderdisplays only those form templates whose data model matches the data type selected forthe 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 FormsBuilder User Guide.

Setting trigger conditions

A trigger is a signal that the activity can begin. Trigger conditions define the startingcriteria for an activity. At runtime, the server does not start an activity until the activity’strigger condition is met. The trigger condition can optionally include a trigger eventthat must occur before the activity starts.

If the activity has more than one incoming flow, you can specify how many of theprevious activities must complete before this activity starts. The trigger condition is theminimum 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 thatthe activity can start when two of the three have delivered their packages. The triggercondition 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-definedevent, such as dm_checkin, or you can make up an event name, such as promoted orreleased. 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 eventyou identify queued to the workflow before starting the activity. The same event canbe used as a trigger for multiple activities, however, the application must queue theevent once for each activity. See the Documentum Content Server Fundamentals for furtherdetails about defining and queuing events.

For information about setting an activity’s trigger conditions, see Setting activity triggers,page 128.

Setting timers

When you configure an activity, you can set timers that take action if work does notappear to be flowing as it should. For example, you might want the workflow supervisorto receive a warning if the activity is not started within 12 hours of when the workflowstarted, or you might send a message to the activity performer if the activity has notbeen 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.

Both of these timers can be modified by administrators in Documentum TaskSpace. Ifthere are multiple timers for a task, the system uses the first timer as the due date inTaskSpace. The due date is used by the system to calculate overdue tasks in TaskSpace.The Documentum TaskSpace Configuration Guide provides more details on using theAdministration tab in TaskSpace to change timers.

When a workflow starts, the system creates pre-timers for all activities that havepre-timers configured. At the same time, the system creates the task for the first activityof the workflow. If it is an automatic activity, the workflow agent processes the taskimmediately and moves the workflow to the second activity. When the second activity istriggered, 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 methodas long as the activity performer has the necessary superuser privileges. The DelegateTask and Complete Task actions are available only as post-timer actions for manualactivities that handle a single work item.

When a timer completes a task, it can optionally set the value of an attribute on one ofthe process variables or packages in the workflow. The transition conditions for theactivity can test for this value, and depending on the attributes of a package or processvariables, the flow can be processed differently.

An activity can have multiple timers. You can also tell the server to repeatedly performthe 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 inboxqueue. However, you can configure the timer to send email notification using a customemail template.

See Setting warning timers, page 129 for more information.

Note: Post-timers are not stopped when a task is halted or suspended and will continueto count the time. For example, when a workflow task is stopped, the associatedpost-timer is not stopped. The post-timer continues to take into account the timedesignated for the task as though the task is still in progress.

The task of checking the warning timers and performing the requested actions isperformed by the dm_WfmsTimer job. The dm_WfmsTimer job is installed with ContentServer 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 thefrequency at which the job runs, use Documentum Administrator. See DocumentumAdministrator User Guide for further information about changing the configuration of jobs.

Setting up notications

Content Server has the ability to monitor for particular events and to notify interestedusers 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 emailmessage templates with several key workflow-related events. An email template is aspecially formatted document stored in the Documentum repository that defines thesubject and body of a notification email message. The template can include variableswhose values the server replaces at runtime. The delivered message includes contextualinformation such as the name of the current performer or the package that is beingrouted. If an event has an email template associated with it, any user who has registeredto receive notification of the event will get a message generated from the associatedemail template. The Documentum Process Builder Development Guide gives more specificson creating custom email templates.

Note: The server generates and sends notification messages only when one or moreusers has registered to receive notification of the event. The Documentum Content ServerFundamentals provides information about registering for event notifications.

See Setting notifications, page 139 for information on how to set notification options.

Dening activity transitions

When an activity has multiple outgoing flows, you may want packages sent to all ofthe following activities, or you may want packages sent to only some of the followingactivities depending on the outcome of the activity. For example, you might give aperformer who reviews the design of a new form the choice of forwarding the designto the next reviewer or sending it back to the designer for revision. You set up thisbranching logic by creating flows from this activity to the two possible followingactivities, then allowing the performer to choose which path to follow.

An activity’s transition type defines how following activities are selected when theactivity is complete. There are three types of transitions:

• Select all connected activities — The flow continues to all following activities linkedto this activity, including both forward flows and reject flows.

• Let performer select the next activities — The performer of this activity chooseswhich following activities to send packages to at runtime.

• Select next activities based on conditions — Which activities receive packagesor process variables is determined at runtime by evaluating a set of transitionconditions 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 ingroup) or 8 (Some users from a group) — you specify how many members of the groupmust complete the task before the server considers the overall activity complete andforwards 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 themare 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 followingactivities 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 toselect just one or two of them.

If you let a group of performers select the next activities — that is, if the performercategory is 4 or 8 and the transition option is Let performer select the next activity — youalso must advise the server about how to combine the performers’ selections. When agroup selects activities, it is possible that some performers might select forward activitieswhile others select reject activities. Which activities should the workflow engine startin this case? All of the selected activities, just the reject activities, or just the forwardactivities? You can also decide to complete the activity immediately whenever anyperformer selects a reject activity or a forward activity.

If you choose a conditional transition type, you must define at least one transitioncondition for that activity.

Determining transition conditions

Transition conditions enable you to define activities that route tasks differentlydepending on the results of the activity. A transition condition is a logical conditionand one or more associated flows. When an activity is complete at runtime, the serverevaluates the activity’s transition conditions to determine which following activities tostart as the next step in the workflow. It moves the workflow forward to the activitiesassociated with the first transition condition that is TRUE. An activity can have multipletransition conditions, although the server always selects just one at runtime, which isthe first TRUE one.

Transition conditions must be Boolean expressions. Transition conditions are typicallyused to check attributes of the package’s components, the containing workflow, or thelast completed work item. When the workflow package is an XML document, you cancreate 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 isthe action that the server takes if none of the transition conditions apply. The Else optiondoes 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 activitytransition rules, page 135.


Chapter 2Using Process Builder

This chapter covers information about using the design environment of Process Builder and includesthe 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 62

Process Builder design environmentProcess Builder is a graphical tool for laying out and defining your business process. TheProcess Builder window is divided into two major panes:

• The left pane contains the Resource Navigator subsystem , which displays the activitytemplates and structured data types that you can add to the process template.

• The right pane is the process template editor, which displays a graphicalrepresentation of your process templates as you create them.

You can control the size of the two panes by positioning the cursor over the borderbetween 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 panesto fill the entire window, click the arrow pointing away from the pane you want toexpand. To return Process Builder to its two-pane view, click the arrow facing the otherdirection, which now appears at the edge of the window. You can also open multipleprocesses from the same repository in the process template editor, enabling you to viewand compare processes. Viewing multiple processes by using tabs, page 61 gives morespecifics on this topic.


Using Process Builder

In the Resource Navigator, you can click the title bar buttons that display the name ofeach sub-window to minimize and maximize each of the windows.

A configurable toolbar appears across the top of the window, providing quick accessto common commands.

If the workflow is too large to display on the screen, you can use the Navigator to viewthe complete process template and specify which portion appears.

The following figure shows the Process Builder design environment.

Figure 4. Process Builder

Process Builder toolbarYou 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 Editmenus



• Workflow toolbar icons enable you to create activities or flows and to display theproperties of workflow objects

• Display toolbar icons enable you to zoom in and out on the process template editorpane

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. Thegroups 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. Ifyou select a checked option, the checkmark is removed and that group of icons isremoved from the toolbar.

Setting process template preferencesThis 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 ProcessBuilder, the process can be shared with the other application as an XML file (in XPDLformat) that is saved to a shared folder. Either application can then access the XML filefrom the shared folder, open it, and begin working with the process. Setting processsharing folder locations, page 46 provides details on setting up shared folders.

Note: Process sharing is enabled when both Process Analyzer and Process Builder areinstalled on the same machine. To share processes when the applications are not installedon the same machine, use the import and export options. Importing process templates,page 88 and Exporting process templates, page 91 provide more information on thoseoptions.



Use Get process from Analyst to open a process in Process Builder that was created ormodified using Process Analyzer. Use Share process with Analyst to make a ProcessBuilder process available to an analyst using Process Analyzer.

Automatic and manual activity types are preserved during the sharing process, althoughdefinitions such as methods and timers must be added by the developer in ProcessBuilder. Packages are not included in the shared processes.

Additionally, if you share a process from Process Analyzer that has multiple endactivities, Process Builder adds an extra empty activity to which all the end activitiesconnect. Process Builder supports only a single end activity, whereas processes exportedfrom 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 ProcessAnalyzer 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 theProcess 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 Analyzerprocess.If activity layout location information is available, it is applied to the shared processtemplate. Otherwise, the system will use default layout and graphical displaysettings. Since user interface information such as graphics or images is not includedin shared processes, you must re-create them in Process Builder.Next, you must define execution information for the process using the ActivityInspector.See Chapter 7, Working with Activities for more information on defining executiondetails for activities.

Setting process sharing folder locations

When processes are shared between Process Builder and Process Analyzer, the locationof 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 theProcess 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 forthe 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 inboundactivities

To be able to debug an inbound activity in the process debugger, you must specify theport 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 numberthat the debugger will use to debug inbound activities.

Managing activity template folders

You control which template folders display by using the Process Builder Preferencesdialog box. The preferences you set apply to your user ID only. Each user can setdifferent preferences. For information about controlling which activity template foldersappear in the Activity Templates window, see Managing activity templates withinfolders, page 107.

The Preferences dialog box also enables the configuration of process sharing folderlocations if both Process Analyzer and Process Builder are installed on the same machine.



Sharing process templates with Process Analyzer, page 45 provides more information onsetting 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 availablefolders, and the list box on the right displays the folders currently being displayedin Process Builder.

Note: Preferences are saved separately for each user. The list of folders may differ ifyou log in as a different user.

2. To add a new folder to the list of available folders, clickNew and type a name for thefolder 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 theActivity 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 availablefolders, and the list box on the right displays the folders currently being displayedin Process Builder.

Note: Preferences are saved separately for each user. The list of folders may differ ifyou log in as a different user.

2. To remove a folder from the Activity Templates window, highlight its name in theright list box and click << Remove.The name moves to the left list box and is removed from the Activity Templateswindow.

3. Click OK.

Setting process template message preferences

You can specify when the system prompts you to validate or install templates afteryou 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 templateswhen you save them.Before you can use a process template to create a running workflow, it must bevalidated and installed. If you select the Always show validate and install promptsafter save checkbox, Process Builder displays prompts whenever you save thetemplate, and asks whether you want to validate and install the template. If thecheckbox is not selected, the prompts do not appear. You must validate and installthe 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 datafrom Process Builder with the existing reporting data in the BAM database. This ensuresthat there is consistency between the structure of the data in Process Builder and thestructure in BAM. This option updates the BAM business data with the process data thatyou select in the Update BAM Data Definitions page.

Data definitions need only be updated when they are used for the first time or if therehas been a change in the data definitions. For example, if you modify a structured datatype 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 objecttype that is used in a package, these package type definitions must be updated withthe BAM database.

BAM must be installed and configured correctly on the Content Server for updatingto occur.

Note: Process data must be enabled for reporting from within Process Builder to updatethe 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 windowThe Activity Templates window, along the left side of the Process Builder window,displays predefined activity templates that you can add to the process template. Activitytemplate 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 specialproperties that are specific to that type of activity. For example, an activity template forsending email to external partners includes a property for the email address. See Chapter7, Working with Activities for more information about activity templates.

You control which template folders display by using the Process Builder Preferencesdialog box. Managing activity template folders, page 47 provides details on settingwhich folders display in the window.

Each activity template folder corresponds to a system folder in the Documentumrepository. The folders have the same name as the folders that reside in the system folderSystem/Workflow/Activity Templates. The folder contains the dm_activity objects thatcorrespond to the activity templates in the folder.

To add an activity to your process template, drag the appropriate activity template fromthe 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 withActivities 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 onthe File menu of the toolbar such as save, remove, and create new folders or activitytemplates.

Activity templates appear in the window in one of three states: draft, validated, andinstalled. Each state is represented by an icon. Only installed activity templates canbe added to a process template. You can validate, install, and uninstall an activitytemplate in the Activity Templates window by using the functions in the shortcut menu.Validating and installing activity templates, page 109 provides more details on this topic.



Table 2. Activity template states and related icons

State Icon

Draft

Validated

Installed

Structured Data Types windowThe Structured Data Types window shows all of the structured data types that have beendefined in the repository. They are displayed in a hierarchical structure organized intocategories that you define based on their use in your business.

Use this window to add and delete structured data types by using the Structured DataTypes Wizard, to create or delete categories, and view the details of the structured datatypes. You can also use this window to launch a wizard that enables you to create astructured 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 yourbusiness is organized. Nested within these categories are groups and attributes thatmake 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 StructuredData 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 newcategory 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 willnot 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 therepository.

Creating structured data types

A structured data type is a way to represent business data that pertains to the flow ofyour 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 asingle attribute such as a string or Boolean value. A complex data type is made up ofseveral attributes. For example, elements of an appropriation request can be organizedinto the group Request with the attributes submitter_name, submitter_address, andequipment_type. Within each structured data type, you can also organize attributesinto related groups that give visual structure to the data type. For example, within thecustomer structured data type, you can have an address group that contains the attributesfor 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 orright-click in the Structured Data Type window and select Add Structured DataType.



The Add Structured Data Type Wizard dialog box appears.

2. To change categories or to create a new category, click Change Categories and adda new category to the node that you have selected. Creating structured data typecategories 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, deleteit, 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 DataTypes window.

Note: Display names must be less than 70 characters in length. The Display Namefield 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 datatypes.

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 DataTypes window.

Note: Display names must be less than 70 characters. The Display Name field doessupport 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 defaultvalues. Process variables that have default values do not possess the unique attribute



characteristics required to match an incoming message to a single instance of aprocess. Understanding message correlation, page 162 provides more informationon 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 tablesbased on this SDT definition.This sends the new data type definitions to the BAM database where they are addedto 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 thestructured data type.

Editing structured data types

After you have created a structured data type and before it is used in a process, youcan change properties of the attributes, as well as add attributes and groups. Aftera structured data type is used in a process, minimal data can be changed in order topreserve 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-rightof the dialog box. If you click this text, the system launches the Process List dialog boxthat 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 nameand description of the structured data type. You can also add a new group or a newattribute.

Note: When you edit a structured data type that is used in BAM reports, select the optionon 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 nolonger be altered.

Creating a complex structured data type from an XMLschema

You can search for and retrieve an XML schema (as an .XSD file) and import it into therepository as a structured data type object, enabling you to use data from an externalapplication or from another part of your business.

Note: If the schema that you are using has many elements, it is best to import them oneelement 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 youwill be adding the structured data type.

2. To change categories or to create a new category, click Change Categories and add anew 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 Typesgroup 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 Typeswindow.

Process template editor paneThe process template editor pane is the area where you design the business processflow. To define a business process, drag predefined activity templates from the activitytemplates folders into the process template editor or create new manual or automaticactivities, connect them with flows, and then define the properties of the activities andflows. See Creating process templates, page 64 for more information. You can also addtext notes to label areas of the template.

The procedures you follow to control the visual layout of a business process are similarto those in other graphical layout software.

• To add objects to the process template, drag an activity from the activity templatefolder and drop it in the process template editor pane. The object is added to thetemplate at the location where you release the mouse button. The toolbar alsoprovides buttons for adding (blank) activities and flows.

• To move objects within the process template, select and drag them to their newlocation. 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 bemoved on their own.

• To remove objects from the process template, select them and click the DeleteSelected Objects icon from the toolbar or select Delete from the Editmenu.

• To copy activities, select them and click the Copy icon from the toolbar or selectCopy from the Editmenu. To add the new copy to the template, click the Paste iconfrom 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-clickit. A context menu appears at the location of the mouse cursor, showing the availableactions.

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, orclick 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 secondtime 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 automaticallyclears any previously selected objects.

4. To select all objects in the template, select Select All from the Editmenu.

Aligning activities

The Alignment options enable you to position workflow activities precisely. You canalign 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. SeeProcess 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 thesubmenu.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 activitydetermines the placement of the other activities. That is, the selected activities willmove up to be in alignment with the topmost activity. Similarly, if you choose to alignthe bottom edges of your activities, the lowest or bottommost activity determines theplacement 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 bydragging the new activity template from the activity templates folder and dropping itonto the existing activity.

For example, after a process developer imports a Process Analyzer process into ProcessBuilder, the process developer may need to replace the imported generic activities withsome existing activity templates. The developer simply drags a new activity to the correctlocation in the process and drops it into place, which deletes the former activity andreplaces it with the new activity. Replacing an activity in this manner preserves the linksbetween 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 andflows.

Select Snap To Grid from the View menu.

When the snap to grid option is turned on, a grid appears in the background of theprocess template editor. When you move activities or flows in the editor, they willautomatically align themselves with the grid, making it easier to align objects witheach other. Turning on snap to grid does not affect the layout of existing objects inthe template.

When the snap to grid option is turned off, the grid does not appear and objects areplaced exactly where you drop them. Turn the option off when you want to have finecontrol 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 boxbetween the Zoom In icon and the Zoom Out icon . Each time you click the ZoomIn 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 Viewmenu.

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 toclarify the process for people looking at the template. You can place a note anywhere inthe template layout. By default, the note appears with a yellow rectangle surroundingthe text, but you have a variety of display options. The following example shows notesin 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 theToolsmenu, 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 opensthe 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 ofthe 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 ofthe 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-downlist.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 thetransparency level is set to 100 percent, the note is opaque and completely obscuresany 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 ProcessModeling Notation format for text annotations. A heavy border appears alongthe left side of the note.



9. Click Apply to save your updates without closing the Note Inspector, or click OK tosave 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 thatappears along its edges.

Viewing multiple processes by using tabs

When you are creating a process template, you may need to view another existingprocess. Process Builder enables you to open and view multiple processes on differenttabs. As you open a process, it appears in a new tab, leaving any other open processes inseparate 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 ResourceNavigator. The current state of the open template appears in the title bar of the ProcessBuilder window. If there is unsaved data on the tab, the name of the process is precededby an asterisk (*).

Note: Multiple tab view is available only for processes that exist within the samerepository. 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.

Process validation tabThe process validation tab enables you to see validation errors whenever you validate asaved process. When you validate a process that has errors, the process validation tabshows all of the errors in the process grouped by the activity name.

Expand the node for the activity and view all of the errors found for each activity. Whenyou select an individual error within the tab, the system highlights the correspondingactivity in the process editor pane so that you can open the template and correct the error.

Using the process validation tab, page 82 provides more information on validatinga process.

Note: If there are no validation errors for the template, the process validation tab doesnot appear.



NavigatorWhen you are defining a process template, the graphical representation can easily growbeyond a size that can be completely displayed on the screen. The process templateeditor automatically scrolls as you add objects and create a larger layout.

The Navigator enables you to control which portion of a large template appears onthe screen.

To navigate to the portion of a template to display on screen:

1. Select Navigator from the Viewmenu, or click the Navigator icon in the toolbar .The Navigator window appears in the right pane of the Process Builder window. Itdisplays a reduced representation of the current process template with a gray boxaround the section displayed on the screen.

2. To change which area of the process template appears on screen, drag the gray boxin 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 3Working 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 83• Checking in, checking out, and versioning process templates, page 85• Deleting process templates, page 88• Modifying process templates, page 85• Importing process templates, page 88• Keeping shared processes in sync, page 89• Exporting process templates, page 91• Printing process templates, page 91

Process templates overviewProcess templates represent the business process through which a given object or setof objects flows. They define the overall workflow from beginning to end. You createprocess templates in Process Builder, then make them available for users to createindividual workflow instances from.

There are three possible states for process templates: draft, validated, and installed. Thecurrent 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 lockowner if the template is checked out by another user.


Working with Process Templates

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 ensurethat the template is correctly defined. A template in the installed state is ready for use inan active workflow.

Opening existing process templatesYou can open an existing template in order to review it, revise it, or save it under a newname 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 namesuntil the template name appears in the list box.

3. From the View list, select Show Current Versions to see only the current versionof the templates in the window or select Show ALL versions to see a listing of allversions of the templates.

4. Highlight the template name and select the checkbox to Check out process on Opento edit the process. View is only available when another user has the templatechecked 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 thetemplate name, and View will be the only available option for the template. Whenyou place the cursor on the name, the text displays the name of the user who ownsthe lock on the template.

5. Double-click the template name, or highlight it and click Open.

Creating process templatesThe following procedure provides an overview of creating templates. Several of the stepsprovide links to other topics where you can find more detail about the task described bythat 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 existingtemplate 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 businessprocess.See Managing packages, page 69 for details.

5. Add activities to the process template until you have one activity for each task inyour 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 theactivity to appear.

• Drag and drop an activity template from the Activity Templates window onto the process template editor pane.

If the Activity Templates window does not include a template representing thetype of activity you need, you can create a blank activity by clicking the manual orautomatic activity buttons in the toolbar, or you can create a new template. Chapter7, 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 canbe any type of initiate activity), and the last activity must be connected to the endactivity.To connect two activities, select one of the flow icons, move the cursor over the firstactivity 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 Buildertoolbar:• To connect activities in a forward movement of data, click either the Create

Single Segment Flow icon or the Create Multi-Segment Flow icon . Thedifference between the two is visual: one draws a straight line to represent theflow between activities, the other draws a line consisting of multiple segments.

• To connect activities in a backward movement of data, click the Create RejectFlow icon . Reject flows represent the path taken when the user of an activityrejects the object being processed.



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

Fault handler activities, page 19 provides more details on this topic.

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 inthe business process, starting with the initiate activity. Configure all of the necessarytabs for each activity. For example, remember to configure the Trigger tab for Joinactivities 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 templatedisplay, 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 83. Once you have installed the template,it is available to users.

Setting process template propertiesYou use the Process Properties dialog box to provide basic information about theworkflow 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 indisplay-only fields.

Note: To edit an existing template, you must uninstall the process. Modifying processtemplates, page 85 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 appearsnext 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 theowner if you are a superuser. If you are not a superuser, the Change button is notavailable.

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 buttonthat appears next to the current alias set.For more information about alias sets and how they are used in workflow, seeUsing 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 theWorkflow instructions box.For example, you can give performers of all activities specific instructions abouttheir 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 fromthis template. Auditing must be turned on to enable the system to publish reportingdata to the BAM database.

Note: To change audit trail settings, you must have CONFIG_AUDIT privileges.CONFIG_AUDIT is an extended user privilege and must be granted by anotherrepository owner or superuser using Documentum TaskSpace or DocumentumWebtop. The Documentum Webtop User Guide and the Documentum TaskSpaceConfiguration Guide provide more details on extending user privileges.

8. Specify whether to make the names of routed documents available for displayto users.By default, the package routed through a workflow does not include the names ofthe documents in the package for security reasons. If you want to store the documentnames as part of the package, so that the names can be used in the instructionspassed to workflow participants, select the Store document name to the package atruntime checkbox.

9. To send an email message when a timer expires or another event occurs, click Add inthe Select template for event notification group box.You can also delete a template and event from the group box by selecting the rowand clicking Remove.

10. Select the Event that will trigger the notification from the drop-down list.



11. Click Click to add a template to select the Email Template that will be used byserver to send notifications for the event.

a. Select the option to Choose an existing template from the repository or youcanCreate a new Email template using the Notification Template Wizard.Using the Notification Template Wizard, page 140 provides instructions on howto create a new email template.

The server uses the selected email template for all notifications of the same eventtype. If you do not select an email template, the server notifies users by sending adefault notification to their Documentum inbox.

12. To associate custom email messages with specific workflow events, select the eventsand 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-relatedevents. Users registered to receive notification of the event will receive a messageconstructed by using the email template associated with the event. Setting upnotifications, page 39 provides more information on this subject.

Note: You can also associate email templates with events as part of an activitydefinition.• 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 activityis 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 thedrop-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 anon-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 thestructure 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 dataThe Data tab of the Process Properties dialog box displays a list of the packages, processvariables, and process parameters involved in workflows created from this processtemplate. 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, aworkflow for reviewing and approving purchase orders passes the same purchase orderdocument as a package to all the necessary activities. In other cases, the work performedby some activities may result in the creation of a new document. For example, supposean activity accepts a personnel action notice. The performer (an HR employee) mustfile the notice, then send a different form to the accounting department. The list ofpackages in the Process Properties dialog box must include all packages involved in theworkflow, including packages created or discarded in the course of the process. Whenyou configure the activities, specify which packages each activity deals with. Changingprocess data in an activity, page 143 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 Toolsmenu, 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 viewwindow and click the + button above the window.



The new package appears under the Packages node in the tree and in the PackageDefinition 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 theactivities 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 contentyou 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 thelist does not appear, the workflow always uses the CURRENT version.

The specified version appears as the default version used for each activity thathandles 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 objectin the repository.

• CURRENT, which is the default selection. If you select CURRENT, the packagewill always contain the version labeled CURRENT, which is typically the mostcurrent version of the object in the repository.

6. Choose the object type of the object included in the package by selecting it fromthe 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 Typelist does not appear, or if you want Process Builder to select the object type based onthe form template you select you may skip this step.

Most commonly, the object type of a package is document or a custom documenttype you have created. Refer toDocumentum Content Server Reference for a descriptionof object types.

7. To associate a form template with the package, select the template from the Formdrop-down list.A form template defines a custom user interface for users who handle this packageduring the workflow. See Associating form templates with packages, page 37 formore information about using forms and form templates. To appear in the list, theform 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 overridethe 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 setsthe package object type based on the selected form template.

a. Select an existing form from the Form drop-down list. The list shows only thoseform templates whose data model matches the object type you selected at step5. If the intended form template does not appear, make sure you selected thecorrect object type at step 5.

b. To create a new form template or edit the selected form template, click the buttonwith the Forms Builder icon to launch Forms Builder.TheDocumentum Forms Builder User Guide provides more information on creatingcustom forms for your workflow.

8. To use the selected form to display the properties of the package, select the Use Formfor Properties checkbox.When the Use Form for Properties checkbox is not selected, the form from step 7appears 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 isused to set the package’s properties in the repository, not the content of the package.

Note: TheUse Form for Properties option is available only for form templates whosestorage mapping option is set to Store in Repository attributes. See the DocumentumForms Builder User Guide for information about this storage mapping option.

9. To prevent Process Builder from making this package visible to all activities bydefault, clear the Visible across entire process checkbox.By default, Process Builder makes the package visible to every activity in thebusiness process, on the assumption that the package will flow through the entireprocess. When you clear this option, the package will be visible only in activitiesto which you explicitly add it.

Note: If you select an existing package that has been set to be visible in someactivities and not visible in others, the checkbox is unavailable. To reset all activitiesto the same value, click the Change activity-level settings link, then click Yes in thedialog box that appears.

10. To require that the package have an associated document or other content, select theThis is a mandatory package checkbox.

Note: If you select an existing package that has been set to be mandatory in someactivities and optional in others, the checkbox is unavailable. To reset all activities tothe same value, click the Change activity-level settings link, then click Yes in thedialog box that appears.



11. To enable Process Builder to publish reporting data to the BAM database for thepackage, 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 theinitiate activity and moving forward through the business process.See Changing process data in an activity, page 143.

Managing process variables

Process variables represent different types of data that flow through your businessprocess. These can be simple data types (such as string, Boolean, or date) or they can becomplex data types made up of groups of logically related data such as purchase orders,manufacturing items, and so on. Process variables can be grouped into collections oflogically related attributes of data types that can be reused in the repository.

These process variables, or structured data types, are available in the Structured DataTypes 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, andassociate it with the process flow. You can then design a Forms Builder form with radiobuttons that signify the value for the approved field and associate it with the process flow.

To set the process variables for a business process:1. If the Process Properties dialog box is not already open, select Process Properties



3. To add a process variable to the business process, select the Process Variables nodein 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 theVariable 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 theactivities 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 structureddata 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 byselectingMore Values and navigating through the tree of structured data typesin 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-levelACL, if one is assigned to the process on the Advanced tab.

Setting Access Control List (ACL) options, page 75 provides more information onAccess 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 theinitiate activity and moving forward through the business process.Changing process data in an activity, page 143 provides more information onconfiguring process data within an activity.

Managing process parameters

Process parameters enable application administrators to modify constant values that areused throughout a process. Parameters that are defined within a process are availableto all activities contained in the process.

An administrator can change the values of the parameter from the Administration tab inTaskSpace and any new process instances, work items, and variables within a workflowuse the updated value.

Understanding process parameters, page 36 provides overview information on processparameters.

Note: When process parameters are migrated, Documentum Composer creates acorresponding installation parameter for every process parameter. The default value isset to the value from the source repository. The name of the install parameter is prefixedwith the name of the process and followed with the name of the process parameter:ProcessName_ProcessParameterName0.parameter The Documentum Composer User Guideprovides more details on using installation parameters in a Documentum Composerproject.



To set process parameters for a business process:1. If the Process Properties dialog box is not already open, select Process Properties



3. To add a process parameters to the business process, select the Process Parametersnode 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 theProcess 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 configurethe 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 valuecan be changed by application administrators by using the Administration tab inTaskSpace.

Overriding activity-level settings

Settings created in the Data tab of the Process Properties dialog box are global settingsthat extend throughout the process. The configuration for many of the properties can beedited 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 thereportable option changed in a specific activity. When the activity has different settingsthan the global setting specified in the process, you have the option to overwrite theactivity-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 activitiesthat 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.



Conguring advanced optionsThe Advanced tab of the of the Process Properties dialog box enables you to setpermissions on the entire process or individual variables associated with the processflow. You can also create the correlation sets that match attributes from an inboundmessage 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-levelpermissions applied to objects to which the permission sets are assigned. Permission setsspecify what access each user has to a particular item in the repository, such as a file orfolder. Each item in the repository is assigned a permission set by the item’s owner. Thepermission 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 relyon either the user’s default ACL or the parent folder’s default ACL, depending onthe configuration of the repository. To ensure that each user has the correct access toelements of the workflow, configure the ACL for the process and the activity fromwithin Process Builder.

If a task performer does not have at least Read permission for the process, they willreceive the task in their inbox and can open it, but they will be unable to complete thetask. 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 doesnot have Write permission, they are unable to modify the process variables

The Documentum Content Server Administration Guide provides information about usingACLs.

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:1. If the Process Properties dialog box is not already open, select Process Properties


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 areavailable for use by any user in the repository and are managed by the repositoryowner. Other ACLs can be managed by their owners or a user with sysadmin orsuperuser privileges.

b. Highlight the ACL to use for all process variables.As a default, the server defines the ACL for the variable. The associatedpermissions 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 theProcess 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 areavailable for use by any user in the repository and are managed by the repositoryowner. Other ACLs can be managed by their owners or a user with sysadmin orsuperuser 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 ondifferent time periods or working hours than found in the standard system calendar. InDocumentum Webtop or TaskSpace, designers can create calendars based on regionalwork schedules, country-specific holidays, or other unique time constraints. In thisway, timers and notifications for a process are calculated based on a specific calendarrather than the system calendar.

Note: When a task first arrives in the user’s inbox, the due date for the task may becalculated based on the system calendar. The next time the timer job runs, the jobupdates the due date according to the business calendar.

To select a calendar for a process1. If the Process Properties dialog box is not already open, select Process Properties



3. Select a calendar from the list box.The list of calendars reflects all calendars located in the System/Workflow/Calendarsfolder.

Note: If different calendars are selected for both a process and an activity within thatprocess, 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 constantvalues that are used throughout the process. Administrators make these changes in aDocumentum Form that they access from the Administration tab in TaskSpace. Any newprocess 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 enableadministration 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 onadministering processes in TaskSpace.

Creating correlation sets

Process Builder must be able to match an inbound message to a unique instance of aworkflow in order to process the incoming data. Correlation sets are collections of processvariables that you define for an activity that enable the system to match a message toa process instance.

You create correlation sets at the process level based on the type of information you willbe receiving from inbound message activity templates. This includes using structureddata types that have been defined with the repository. You can create multiple correlationsets for a process, although an activity can only be associated with one correlation set.Understanding message correlation, page 162 gives more details on using correlationsets to match messages from external sources to process data.

To create a new correlation set:1. If the Process Properties dialog box is not already open, select Process Properties



3. In the Correlation Set group box, select the Correlation Sets root node and click theadd (+) 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 Editset 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, andclick .The new, undefined property is added to the tree.



7. Right-click the attribute, and select Edit correlation modelThe Correlation dialog box appears showing process variables that are associatedwith 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 Datatab, 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 targetnamespace URI for the WSDL location. If there are multiple web service activities withinthe process, they use the same target namespace.

Note: If there are Web Service Inbound activities within the process, this field must becompleted 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 templatesWhen you have completed a process template, you must save it before you can validateand install it. Saving the template copies your changes to the repository.

The process of saving differs depending on whether you are saving changes to anexisting 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 leastWrite permission on the template, and you must be working with a draft or validatedtemplate. A template that is installed must first be uninstalled in order to save it as thesame version. If the Save options are unavailable on the File menu, it may mean thatthe template has been installed.

The current state of the template appears in the Process Builder title bar. The title baralso shows if the template is checked out and the username of the lock owner if thetemplate is checked out by another user.



Process Builder can be configured to enforce unique names or specific folder locationsfor process templates. Appendix C, Process Builder Configuration File provides moredetails on this subject. By default, however, process templates can be saved to anylocation 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 newname: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, selectingSave 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. Longernames are not allowed in Business Activity Monitor and will interfere with processmonitoring.

3. To create a folder in which to store the template and its associated objects, make surethe Create new folder for associated items checkbox is selected.The checkbox is selected by default. Process Builder saves the template and itsactivities in a folder with the same name as the template, located under the folderyou select in the next step.If the checkbox is not selected, navigate to the folder where you want to save thetemplate by double-clicking on cabinets and directories in the Save in dialog boxuntil you have highlighted the folder name.The complete path to the folder appears in the text box at the bottom of the dialogbox.

4. Click OK.If you have sufficient permissions on the selected folder, Process Builder saves thetemplate and its activities.If installation and validation prompts are set to display, a dialog box appears askingwhether you want to validate the template. (Installation and validation prompts areset on or off in the Preferences dialog box. Setting process template properties, page66 provides more information on this subject.)

5. Choose whether to validate the process template.See Validating process templates, page 81 for more information about validatingtemplates. If you choose to validate the template, Process Builder attempts thevalidation. If validation fails, a dialog box appears telling you so. Click the Detailsbutton to see the error that prevented validation.If the validation is successful, a dialog box appears asking whether you want toinstall the template, making it available for use.



6. Choose whether to install the process template.See Installing process templates, page 83 for more information about installingtemplates.

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, ProcessBuilder updates the saved file.Checking in, checking out, and versioning process templates, page 85 providesmore specifics on checking in a template.

2. If you have sufficient permissions on the selected folder, Process Builder saves thetemplate and its activities. If installation and validation prompts are set to display, adialog box appears asking whether you want to validate the template.See Validating process templates, page 81 for more information on validating thetemplate.

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.If you have sufficient permissions on the selected folder, Process Builder saves thetemplate and its activities. If installation and validation prompts are set to display, adialog box appears asking whether you want to validate the template.

3. Choose whether to validate the process template.See Validating process templates, page 81 for more information about validatingtemplates. If you choose to validate the template, Process Builder attempts thevalidation. If validation fails, a dialog box appears telling you so. Click the Detailsbutton to see the error that prevented validation.If the validation is successful, a dialog box appears asking whether you want toinstall the template, making it available for use.


Validating process templatesValidating a template verifies that the process defined in the template meets systemrequirements. The Process Validation tab appears when you validate a template and the



template has errors. If there are no errors in the process, the tab does not appear and youcan continue to install the process in your repository or choose to continue working on it.

You can validate only if your open template is in the draft state and you have Writepermission.

You can invoke the validation process from within the process debugger and view bothtabs at the same time, enabling you to troubleshoot a process.

This tab shows a tree of activities and any associated errors listed for each activity. Ifyou click the error for an activity in the tree, the associated activity opens in the designcanvas, enabling you to correct the error at the time of validation. Use control buttons toexpand and collapse the tree, close the validation tab, or export a preview of the errortree to a text file. This file contains a text representation of the validation tree that youcan copy to a text editor or save to a location on your system.

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.

To validate a process template:1. From the Tools menu, select Process Template.

2. Select Validate.If there are errors in the process, the Process Validation tab appears with a list oferrors for the process.

3. If the validation is successful, a dialog box appears asking whether you want toinstall the template, making it available for use.

Additionally, if installation and validation prompts are set to display, any time you savea 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 dialogbox. Setting process template properties, page 66 provides more information on thissubject.

Using the process validation tab

The process validation tab enables you to see validation errors whenever you validate asaved process. When you validate a process that has errors, the process validation tabshows all of the errors in the process grouped by the activity name.



The process validation tab shows errors that result from changes in process data thatdefine:• Performer• Conditional performer• Transition logic• Timer actions• Task name• Task instructions• Configuration of elements on the custom tab of an activity templateExpand the node for the activity and view all of the errors found for each activity. Whenyou select an individual error within the tab, the system highlights the correspondingactivity in the process editor pane so that you can open the template and correct the error.

To view all of the errors for all activities, click Expand All. To close the list of errors forall activities, click Collapse All.

You can also click the Export to a file button to save a text-only version of the errors to afile or copy it to the clipboard.

The Process Validation tab and the Process Debugger tabs can be used together totroubleshoot a process.

Installing process templatesA 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 Writepermission. 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 Toolsmenu. See Validating process templates, page 81 for more information.

If you need to make changes to an installed template, you must uninstall it first. Anyactive workflows based on the template are halted. After making the changes, validateand install the template again.

When you reinstall, you can choose how to handle any workflows that were halted whenyou uninstalled the template. You can choose to:• Resume the halted workflows at the point from which they were halted• Abort the workflowsThe options you choose depends on the changes you made to the workflow. Perhaps youdeleted an activity, or added an activity that you want to perform on all objects in theworkflow, or you modified transition conditions. In any of these instances, you abortthe workflows and then restart them. To delete a running workflow, you must abort theworkflow and choose the option to destroy the runtime objects in Webtop. The defaultbehavior 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 hasnot been saved or has not been validated.If there are any halted workflows based on this process template, you are given theoption 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 whichyou have made significant changes, incompatibilities between the old processtemplate and the changed process template may result in the workflow beingplaced 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 Writepermission.If any users are running workflows based on this template, a warning messageappears indicating that there are active workflow instances.

2. If you see the warning message, click Yes to halt the workflows or No to cancel theuninstall 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 templatesYou 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 templatewith the changes or create a new version of the template. Any changes you make aregoverned by object-level permissions.

To make changes to a process template and save the changes without versioning, youmust uninstall the template. To uninstall a template requires Relate permission on thetemplate or sysadmin or superuser privileges. To save your changes requires Writepermission.

To create a new version of a process template, you must check out the template beforeyou 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 theprevious version of the template.

When you save or check in your changes, the server sets the new version to the draftstate. The new version must be validated and installed before you can start a workflowbased on it.

See also Saving process templates, page 79.

Checking in, checking out, and versioningprocess templates

To lock and edit an existing process template, check it out using Process Builder. As theprocess opens for editing, the system locks the file so that no one else can make changesto it. When you complete your edits and check in a changed process template, modifythe 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 dialogbox 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 atemplate in after having modified it, you can decide whether to check the file in as a newversion or the same version. When checking a template into the repository, the systemprompts you to select whether to increase the version number by a whole number orby a decimal point (by a tenth). Increasing the version number by a whole number isconsidered a major revision. Increasing by a decimal point is a minor revision. Thesystem marks the most recently checked-in file as CURRENT. If you decide to check thefile back in without increasing the version number, the template keeps the same versionnumber as the original template and the system overwrites the original template with thechanges that you have just made and labels it as CURRENT. When checking a templateout, 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 tochecking documents in and out in other Documentum applications. One very importantdifference 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 mustfirst uninstall the template (which stops all instances of the template in the runtimeenvironment). This prevents you from making changes to a template when it is in use inthe runtime environment. After uninstalling the process, you are free to make changes toit, 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 runninginstances of the workflow and prevents any new instances from starting. Once thetemplate is installed again, you can either cancel or resume the halted instances,depending on the complexity of changes made to the template. Modifications to existingtemplates should be limited to minor changes of activity properties that are not currentlyused 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 todestroy the runtime objects in Webtop.

If you check out an installed template without first uninstalling it, any running instancesof the process continue to run using the existing version of the template (labeledCURRENT). The version of the template that you are editing is opened as a draft andyou 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 canbe used in the runtime environment. All process instances created using the previous



version will continue to run until they have completed. Documentum Administrator UserGuide gives more specific information on using versions.

Canceling a check-out unlocks the process template and discards all changes that havebeen made to the process template during the time it was checked out. The repositoryretains the last version of the template as the current version.

To check out a process template:1. From the Filemenu, 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 orselect 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 thetemplate name. You can only View a read-only version of the template until it ischecked 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 theoption to uninstall the template first or continue with the check-out withoutuninstalling the template. An installed template only opens as a draft template andcan be saved only as a new major or minor version. To make changes to an existingversion 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 Templatedialog box.

2. Select the option to save the new process as the Same Version, aMinor Version, oraMajor Version.Checking in the template as the same version makes changes to the CURRENTversion.

Note: If you have made changes to an installed template, you can save only thetemplate as a minor version or a major version. The option to check in as thesame version is not available as overwriting the current version will affect runninginstances 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 withoutkeeping any changes that were made to it. The existing version that is labeled CURRENTin the repository will not be changed.

1. Click the icon or select File > Cancel Check out to display the Cancel Checkout 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 templatesThe option to delete a process template is only available if the process template is openin Process Builder.

To delete a process template:1. From the Toolsmenu, select Process Template > Delete Process.

If a template is currently in an installed state, the system prompts you to uninstall itbefore deleting it. Additionally, if any users are running workflows based on thistemplate, 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 templatesThe import process takes an exported XPDL file and makes it available for you to workwith in either Process Builder or Process Analyzer. Automatic and manual activitytypes are preserved during the import, although definitions such as methods and timersmust be added by the developer in Process Builder. Packages are not included in theimport process.

Additionally, if you import (or re-import) a process from Process Analyzer that hasmultiple end activities, Process Builder adds an extra empty activity to which all the endactivities connect. Process Builder supports only a single end activity, whereas processesexported from Process Analyzer may contain multiple end activities.



Note: If there are semantic errors in the imported XPDL, the system will save the newprocess template in an invalid state. Use the information from each validation errormessage 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 directorieslisted 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 Analyzerprocess.If activity location information is available, it is applied to the imported processtemplate. Otherwise, the system will use default layout and graphical displaysettings. Since user interface information such as graphics or images is not exportedwith the process, you must recreate them in Process Builder.Next, you must define execution information for the process using the ActivityInspector.See Chapter 7, Working with Activities for more information on defining executiondetails for activities.

Keeping shared processes in syncBusiness processes can be shared and modified in either Process Builder or ProcessAnalyzer. To keep the process synchronized between the two applications, you mustre-import the changed process into its native application.

A Process Analyzer process can be exported and then imported into Process Builderand modified. For example, use Process Builder to define execution details, add a newactivity, or change the order of activities. As a result of these changes, the businessanalyst checks the process again in Process Analyzer or runs a simulation of the changedbusiness process. Re-importing the process that was changed in Process Builder updatesthe original process in Process Analyzer, keeping the process in sync between bothapplications.

An existing Process Builder process can be exported out of its native application,imported into Process Analyzer, and modified. For example, the business analystcan change the order of activities, add an activity, or delete an activity. To keep theexecutable model of the process in sync with the newly changed process, it must bere-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, aminor 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 88 for the procedure to import a processinto Process Builder.

3. From the File menu, select Save.The Checkin Process Template dialog box appears, indicating that the system hasdetected an existing version of the process in the repository.

4. Select the option to save the new process as the Same Version, aMinor Version, oraMajor Version.The new process becomes the current version of the process and the system retainsthe older versions for historical purposes. All process instances created using theprevious 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, ProcessBuilder will not allow saving an older version of the process if a newer versionexists in the repository. For example, the system will prevent saving an importedof version 1.0 of a process if version 1.1 already exists in the repository. The olderversion can be renamed and saved as a different process.A business process can only be saved as the same version if that version of theprocess has not yet been installed. If an existing version of the business processhas 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.If you have sufficient permissions on the selected folder, Process Builder saves thetemplate and its activities. If installation and validation prompts are set to display, adialog box appears asking whether you want to validate the template.See Validating process templates, page 81 for more information on validating thetemplate.




Exporting process templatesThe 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 filesystem. This file is then available to import into either Process Analyzer or ProcessBuilder. Templates exported from Process Builder contain the type definitions thatProcess Analyzer uses to create the corresponding business objects. The exported XPDLalso 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 thedirectories listed in Export Process dialog box until you have highlighted the folder.

3. Click Save.

Printing process templatesYou 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 92 and Previewing printed processes, page93 for information about these options.

3. Click the Print Template Layout icon in the toolbar, or select Print from the Filemenu.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 printerproperties.

6. To print your process template to a file rather than to the printer, select the Printto file checkbox.

7. To print more than one copy of the process template, type the number of copies youwant from the Number of copies box.



Note: The controls in the Print range box are unavailable except for the All radiobutton. 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, theprocess 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 thefull 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 formatdisplay either in inches or in centimeters, depending on the unit of measurementselected in theMargins 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 decimalplaces, 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 Printto print the current template with these settings.



Previewing printed processes

The Print Preview option gives a graphical representation of the image that will beprinted.

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 previewimage of the process template as it will appear on the printed page(s). The layout isbased 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 musttype 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 clickPrint to print the current template with these settings.




Chapter 4Connecting Activities

The flow lines that connect the activities in a workflow represent the flow of the document orobject that the workflow routes. Flows enable the movement of packages, their properties, anddependencies between the connected activities. See Process templates and associated workflowobjects, page 16 for a description of flows.

Once you have added a flow to the template, you configure it using the Flow Inspector. You accessthe Flow Inspector by double-clicking on a flow in the process template editor pane, or by selectingone 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 processtemplate. Changing flow display settings, page 96 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. Ifmore than one flow is selected, arrow buttons appear on either side of the text box, enabling you toscroll through the selected flows. The settings you make apply to the flow whose name appears in thebox, unless you select the Apply to all selected option.

When multiple flows are selected, each tab in the Flow Inspector displays one or more checkboxeslabeled Apply to all selected. When this checkbox is selected, Process Builder applies the associatedsettings — that is, those settings that appear to the right of the checkbox — to all selected flows, notjust the one whose name appears in the text box at the top. Any settings for which the checkboxis not selected apply only to the current flow.

Creating owsYou 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 differencebetween the two is visual: one draws a straight line to represent the flow betweenactivities, the other draws a line consisting of multiple segments.


Connecting Activities

• To connect activities in a backward movement of data, click the Create Reject Flowicon . Reject flows represent the path taken when the user of an activity rejects theobject being processed.

• To connect an automatic activity to a fault handler activity, click the Assign FaultHandlers icon . Fault handlers enable you to assign a secondary error handlingactivity to an automatic activity in the event that the automatic activity fails. A faulthandler activity has a dashed line representing the flow between the automaticactivity and its related fault handler.

Fault handler activities, page 19 provides more details on this topic.See Process templates and associated workflow objects, page 16 for a description ofthe types of flows.

Changing ow display settingsThe options on the Display tab control how the flow appears in the visual display of theprocess template.

Note: The options on the Display tab do not control whether the flow line begins with aBPMN-style diamond. Flows have a diamond when the originating activity selects thenext activity using conditional logic. Setting activity transition rules, page 135 providesmore 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 betweenthe connected activities or asMulti-segment lines with each segment runninghorizontally 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 packagesrouted over the flow.These settings are relevant only if you elect to display the package names in the nextstep 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 todisplay the flow without a label. The two radio buttons below the checkbox areunavailable when the checkbox is not selected.

b. Select Show visible packages at destination activity to label the flow with thenames of the packages that the following activity handles. or select Customlabel 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 tosave your updates and close the Flow Inspector.




Chapter 5Creating Sub-Processes

Sub-processes improve your ability to communicate the business meaning of a process template. Alarge or complicated process can become difficult to organize visually when there are many activitiesrequired to complete an entire workflow. To simplify the layout of a process, you may want to grouprelated 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 tocreate a more simplified overview of a process. The process contains activities that are related in someway and are grouped into a container for ease of administration. This can be particularly useful whengrouping 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 reportingdatabase when the audit trail has been enabled for the process. Activity templates contained in thesub-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 99• Creating a sub-process using bottom-up modeling, page 100• Setting sub-process properties, page 101• Managing sub-processes, page 102

Creating a sub-process using top-downmodeling

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


Creating Sub-Processes

when you plan to design the initial high-level concepts of the process first and want tofill 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 labeledSub-Process.

2. Click the sub-process and drag it to the intended position in the process editorwindow.

3. Right-click the sub-process and select Sub-Process Inspector to set the propertiesthat are shared for all activities within the sub-process.Setting sub-process properties, page 101 provides detailed instructions for settingthese 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-processboundary.

5. Drag each activity that you want to include in the group into the sub-processcontainer.The system displays a message confirming the action. If you move the sub-process toanother 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 individualactivities within the sub-process. A sub-process is not limited in the number of inputor output flows that enter or exit its boundaries.

Creating a sub-process using bottom-upmodeling

Bottom-upmodeling is the practice of creating the business process with all of its activitiesfirst, and then bundling the related activities into sub-processes. This method enablesyou to create all of the required activities first, group them into sub-processes, andcollapse 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 theactivities you want to include in the sub-process or by holding down the Shift keyand 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 propertiesthat are shared for all activities within the sub-process.Setting sub-process properties, page 101 provides detailed instructions for settingthese properties.

4. You can click the new sub-process and drag it to the intended position in the window.

Setting sub-process propertiesRight-click the sub-process and select Sub-Process Inspector to set the properties that areshared for all activities within the sub-process. Sub-process properties are independentof 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 notnecessarily acquired by a user. Pre-timers are not activated on the first activity of aworkflow as they are automatically triggered during the workflow’s start.

• A post-timer takes action if an activity has not completed within a designatedamount of time after the activity starts.

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 inthe 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 displayof the process template.

Note: When an activity has one or more timer actions set for it, a small clock iconappears 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 clickOK to save your updates and close the Sub-Process Inspector.

Managing sub-processesThis section describes the following functions available to manage sub-processes:• Expanding and collapsing a sub-process, page 102• Removing activities from a sub-process, page 103• Adding notes to a sub-process, page 103• Deleting a sub-process and its contents, page 103

Expanding and collapsing a sub-process

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

To collapse an individual sub-process, click the minus sign and the sub-processminimizes, 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 hiddenfrom view. You can drag a collapsed sub-process to different locations in the ProcessTemplate 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. Theactivity will not change position on the canvas, so you must drag it to a new locationoutside 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 permanentlyremoved 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 theNotes icon, and then clicking within the boundary of the sub-process. You can also createa note within the Process Template Editor and drag the note into the sub-process. Notesare hidden when the sub-process is collapsed and are displayed when the sub-processis expanded. Adding notes , page 59 provides instructions on using notes in a processtemplate.

Deleting a sub-process and its contents

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



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 6Working with Activity Templates

An activity template represents a particular type of task that you can add to a business process. Thetemplate identifies any underlying workflow method required to complete the task and determineswhat configuration attributes must be set in order to accomplish the task. The template may alsoset default values for some common attributes.

To add an activity to a business process template, you select the appropriate installed activity templatefrom one of the folders in the Activity Template window and drag it into the Process TemplateEditor window. Process Builder includes templates for common integration activity types as well asa sample activity template. See Appendix A, Delivered Activity Templates for a list of the activitytemplates provided with Process Builder. The Documentum Process Builder Development Guide givesmore information on how to create custom activity templates.

There are three possible states for activity templates: draft, validated, and installed. An activitytemplate in the draft state has not been validated since it was created or last modified. A templatein the validated state has passed the server’s validation checks, which ensure that the templateis correctly defined. A template in the installed state is ready to be used to create an activity inthe process flow. The current state of an activity template is indicated on the template icon in theActivity Template window.

This chapter explains how to create activity templates, configure them, validate and install them.The topics are:

• Creating activity templates, page 106• Managing activity templates within folders, page 107• Configuring activity templates, page 107• Validating and installing activity templates, page 109


Working with Activity Templates

Creating activity templatesIf your business process contains activities for which Process Builder does not include anappropriate activity template, you can create a new template. You can either copy anexisting 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 Toolsmenu, select Activity Template > New or right-click the folder andselect New from the menu.A new activity template with the name Untitled appears in the currently activefolder 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 107 for information about configuringactivity 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.TheRepository Explorer appears listing the folders under System/Workflow/ActivityTemplates, which represent the available activity templates.

3. Select the activity template folder 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 samecharacteristics as the template selected in step 1. However, the original templateand the new template are independent of each other. Future changes to one donot affect the other.

6. Make any necessary changes to the new activity template.See Configuring activity templates, page 107 for information about configuringactivity templates.



Managing activity templates within foldersThere are many delivered activity templates that are organized by function under folders(or nodes) in the Activity Template window. You can browse through the deliveredactivity templates by opening and closing the folders to which they belong. Appendix A,Delivered Activity Templates gives details on which node the activity template belongsto and instructions on configuring each activity template. Managing activity templatefolders, page 47 provides more details on creating, adding, or removing folders fromthe 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 businessprocess, 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 Toolsmenu, select Activity Template > Add or right-click in the ActivityTemplates 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. Thetemplate is now linked to this folder as well as its original folder. Any changes madeto 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 theActivity Templates window and select Remove.The activity template is removed from the current folder. If the template is linked toanother folder, it still appears in that folder.

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



input and output flows, or transition options. These configuration attributes relate tohow an individual activity fits into a specific process flow, and so are not relevant foractivity templates.

The Activity Template Inspector also includes an additional tab, labeled Definition,which defines custom attributes for activities created with the template. The attributesare defined using XML. The XML defines the names, data types, and displaycharacteristics of the custom attributes, as well as assistance for users who enter valuesfor the attributes. When an activity is created from the template, the Activity Inspectorincludes one or more extra tabs for the user to use when entering values for the customattributes. 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 thedisplay of one or more of the standard Activity Inspector tabs. When an activity iscreated from the template, the Activity Inspector does not display any of the suppressedtabs, thereby preventing the user from changing any of the values on that tab. The valuesset in the Activity Template Inspector remain unchanged.

The structure of an activity template XML file is defined by the schema fileactivity.xsd, which is located on the local file system in the directory ProgramFiles\Documentum\bpm\classes. See the Documentum Process Builder Development Guidefor further details about the file structure. For a sample activity template XML file, seethe 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 activitiescreated from the template. See Chapter 7, Working with Activities for details aboutsetting the attributes. Commonly, you will want to link the template to a customworkflow method on the Performer tab.

3. Select the Definition tab.A text box displays the XML elements that define the custom attributes for thisactivity template. If this is a new activity template, or a template with no customattributes, 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 DocumentumProcess 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 specifiesthe custom tabs to display in the Activity Inspector. For each tab you want tosuppress, 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, Workingwith Activities for information about the options on each of these tabs. TheshowInActInspector parameter is ignored for custom tabs.

6. Click OK to close the Activity Template Inspector.

Validating and installing activity templatesThere are three possible states for activity templates: draft, validated, and installed. Anactivity template in the draft state has not been validated since it was created or lastmodified. 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 activityand cannot have outflows.)

A template in the installed state is ready to use for creating activities. The current state ofan 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 templatehas 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 Writepermission.

An activity template must be installed before it is available for creating activities. Youcan only install an activity template if it is in the validated state and you have Writepermission.

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 orinstalled or you do not have permission to validate.If validation fails, a dialog box appears. Click the Details button to see the error thatprevented validation. If the validation is successful, a red check mark appears nextto 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 youdon’t have permission to install. If the installation is successful, the validation iconappears 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 Writepermission. If the template is successfully uninstalled, the arrow next to the templateicon (representing installed state) is replaced with a red check mark (representingvalidated state).


Chapter 7Working with Activities

Activities are the tasks that comprise the workflow. Most of the configuration of the workflow relatesto 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 bydouble-clicking on an activity in the process template editor pane, or by selecting one or moreactivities 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 formanual performers, and enables you to provide a form for the activity. Setting activity properties,page 112 provides more details.

• The Performer tab enables you to select who performs the activity and what actions the performershave available to them. Selecting performers, page 114 provides more details on this subject.

• The Trigger tab settings determine when the activity starts. Setting activity triggers, page128 provides more details on this subject.

• The Timers tab sets timers to take action if work bogs down. Setting warning timers, page129 provides more details on this subject.

• The Transition tab settings determine which activities come next in the workflow. Setting activitytransition rules, page 135 provides more details on this subject.

• The Notification tab specifies whether to notify the workflow supervisor when certain systemevents occur. Setting notifications, page 139 provides more details on this subject.

• The Data tab controls the process data the activity handles including packages and processvariables. Changing process data in an activity, page 143 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 145 provides more details on this subject.


Working with Activities

• Many activities include one or more additional tabs containing properties specific to that type ofactivity. The name of the tab and the properties contained on it are set in the activity template.Configuring activity templates, page 107 provides more specifics on configuring custom activitytemplates.

When typing values into the fields on a custom tab, you can include variables that are replaced atruntime 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 variablesubstitution. See Appendix B, Substitution Variables for Custom Activity Template Properties fora list of the supported variables.

Note: Depending on the nature of the activity, some of the tabs may not appear in the ActivityInspector. For example, an activity created from the Decision Split activity template displays onlythe Timers, Display, and Definition tabs. The settings on these tabs are the only ones relevant forDecision Split activities. The set of displayed tabs is defined by the activity template. Configuringactivity templates, page 107 provides more details on this subject.

The name of the activity you are configuring appears in the text box at the top of the ActivityInspector. 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 selectedactivities. The settings you make apply to the activity whose name appears in the box, unless youselect the Apply to all selected option.

When multiple activities are selected, each tab in the Activity Inspector displays one or morecheckboxes labeled Apply to all selected. When this checkbox is selected, Process Builder applies theassociated settings — that is, those settings that appear to the right of the checkbox — to all selectedactivities, not just the one whose name appears in the text box at the top. For example, you can selectmultiple activities and choose the same performer for all of them at once. Any settings for which thecheckbox is not selected apply only to the current activity.

Setting activity propertiesThe Activity Inspector’s Properties tab enables you to set the priority of automaticactivities, provide instructions for the performers of manual activities, or associate aform with an activity. When you create an activity that uses a form, at runtime theperformer of the task sees that form instead of the standard Task Manager interfacewhen 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 theActivity 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. Thevalue is ignored for manual activities. For more information, see Setting priorityvalues, page 30.Dynamic priority is when the priority of the activity is set using custom code as theworkflow runs rather than being set as part of the process template. You shouldassign Dynamic priority only when your system includes custom code to set thepriority 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 TaskName box.The default message appears in the box by default. In addition to normal text, themessage can include the values of workflow attributes that the system determines atruntime. For example, the message can include the name of the workflow or of thedocument being routed. You can type up to 255 characters. The message that theuser 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 byfollowing these steps:

a. In the Task Name box, position the cursor at the location in the text where youwant to place the variable.

b. Click Insert. The Insert Task Name dialog box appears from which you canselect the runtime attribute you want to include.

c. From the Parameter type tree, select the attribute you want to include in thesubject message.

d. Click OK to close the dialog box.See Defining task subjects, page 28 for information about the available variables. Youcan include multiple variables in the task name.

5. Enter any instructions you want to include for the performer of this activity in theTask Instructions box.

Note: Double quotation marks are not supported in the Task Instructions field andwill prevent the system from sending custom email notifications.

To include a runtime attribute in the task instructions, you add a parameter to themessage by following these steps:

a. In the Task Instructions box, put the cursor at the location in the text where youwant to place the parameter.

b. Click Insert. The Insert Task Instruction dialog box appears from which you canselect the runtime attribute you want to include.



c. From the Parameter type tree, select the attribute you want to include in thetask 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 displayingthis 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 Administrationform 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 OKto save your updates and close the Activity Inspector.

Selecting performersWhen defining an activity, you need to specify who performs the activity. Activities canbe 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 specificperformers or allow the workflow participants to choose performers. For automatic tasksyou 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 116.



• To choose the user whose permissions are used for an automatic activity, seeChoosing automatic performers, page 127.

4. If you selected one or more manual performers, choose what actions the performercan or must perform.• To enable the performer to pass the task to another user or group, selectDelegate

the activity’s work to someone else. When you select this option, you must alsospecify where the task is sent if the user to whom the performer delegates itis also unavailable. The task can be forwarded to the workflow supervisor orreturned to the original performer if auto-delegation fails.

• To enable the performer to choose another user or group to also perform thistask, select Have someone else repeat the activity’s work.

• To require that the performer sign off when the activity is complete, selectPerformer’s sign-off required when finished.

For details about the delegation and extension options, see Enabling delegationand extension, page 28.

5. If you selected an automatic activity, set the execution parameters.

a. Select the checkbox Execute this method automatically to choose an automaticexecution parameter from drop-down list. (The checkbox is automaticallyselected when using Documentum Process Builder 6.5 and earlier releases.) Theactions in the drop-down list are workflow methods.When the checkbox is not selected for the option Execute this methodautomatically, then the system uses the delivered dm_bpm_noop_method toconnect to the repository and complete the activity rather than launch a methodat runtime. This means that the system acquires and completes the task onbehalf of the task performer.

Note: To make a custom method available here, the attribute a_special_appmust be set. a_special_app is a dm_sysobject attribute reserved for use byDocumentum products. This attribute must have the value Workflow. See theDocumentum Process Builder Development Guide for details about developingcustom workflow methods.

b. To save an execution log when the automatic method runs, select Yes for SaveExecution Results.

c. Specify how long the process engine tries to run this method before quitting.Enter a number of seconds in theMethod 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 typea Retry Interval to specify a time interval between retries. Use theMaximumtries field to enter maximum number of times the system should retry beforeperforming one of the actions you specify in step 6c.



b. If you have assigned a fault handler to this activity, the system displays the nameof the fault handler activity in the Proceed to the fault handler field. The faulthandler runs each time the method fails.Fault handler activities, page 19 provides more details on this topic.

c. Decide whether the workflow will stop or continue if the workflow methodencounters problems.

Selecting Stop Execution causes the task to be placed in a paused state andbe reassigned to the workflow supervisor.Selecting Continue Execution causes the task to be placed in an acquiredstate 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 anactivity

You can associate a priority module with an activity from the Performer tab of theActivity Inspector. Setting dynamic priority and aging logic for tasks, page 32 providesmore 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. SelectWork 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 prioritymodules.

Note: If two different modules were selected for a workflow (one from the activitydefinition and one from the work queue policy), the system uses the module that wasselected 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 keyfactors:

• 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 aliasesFor 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 determinesthe 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, seeMapping process data to a work queue skill set, page 126.

• Workflow supervisor— The activity will be performed by the workflowsupervisor, which by default is the user who starts the workflow.

• Repository owner— The activity will be performed by the user who owns therepository.

• Previous activity’s performer— The activity will be performed by the same useror users who completed the previous activity in the workflow. This option caninclude multiple users. You select the activity name that has the performer orgroup of performers that you want to complete this activity. You can then selectone of two options for selecting a performer:

Assign to the last performer of previous activitymeans that the person whotriggered the completion of the previous activity is the assigned performer.Assign to all performers of previous activitymeans that all performers ofthe 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 selectWorkflow Supervisor or Repository owner, the specific user will be determinedwhen 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 specificperformers of this activity will be selected.

3. If you chose Previous activity’s performer, select the activity name that has theperformer or group of performers that you want to complete this activity. You canthen 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 activitymeans that all performers of the

identified activity are the assigned performers.4. If you choseMultiple sequential performers, specify whether each performer of this

activity has the right to reject the package they receive and return it to the performerwho 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 themdetermined 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 selectthe performer(s) of this activity when the workflow is run. If this activity hasmultiple preceding activities, select from the drop-down list which activity’sperformer selects the performer for this activity.

• Define performer alias (performer(s) will be assigned when workflow isunderway)— The performer of this activity will be determined by an aliasset. You will specify which alias set is used in the next steps. This option isnot available if you selected Some users from a group orMultiple sequentialperformers.

• Select performer based on conditions— The performer of the activity willbe determined by conditional logic that you define, including package dataand process variables.

• Select performer based on process data— The performer of the activity isdetermined by process data that you define including package data, processvariables, and execution data.

6. If you chose Single user from group, specify which user in the selected group willperform the activity.You will select the group in the next step. To specify which single user from thatgroup will perform the activity, choose one of the options from the Select UserFrom Group By box:



• First to acquire the work item—When the preceding activity completes, awork item is added to the inbox of every user in the group. The first user whoacquires the work item from their inbox is the performer. The work items areremoved from the other user’s inboxes.

• Least amount of unfinished work items—When the preceding activitycompletes, a work item is added to the inbox of the user who has the smallestnumber 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 119• Have performer(s) of <activity> determine performer(s) of this activity, page 120• Define performer alias (performer(s) will be assigned when workflow is

underway), page 121• Select performer based on conditions , page 123

Assign performer(s) now

The following options are available for the option to assign performers now:

• If you selectedWork queue, highlight the name of the work queue, then click Nextto display the data mapping screen where you can assign process data to skill setsthat have been defined for the queue.

For more information on mapping process data to skill sets, see Mapping processdata to a work queue skill set, page 126.

• If you selected Specific user on the previous screen, highlight the name of a groupor <All users> in the Groups list box, then select the performer of this activity fromthe users in the selected group from the Users in Group list box. After selecting auser, 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 orMultiple sequential performers, youcan designate multiple users, groups, or alias names to perform the activity. See theprocedure in the topic Have performer(s) of <activity> determine performer(s) of thisactivity, page 120 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 listyou build as performers, not use the list to provide a selection list to the performerof a previous activity as described in the topic Have performer(s) of <activity>determine performer(s) of this activity, page 120.



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

This feature is also known as dynamic performer selection. This option gives the performerof one activity the ability to choose which users will perform a future activity in theworkflow. At runtime, the performer of the activity can choose one or more users fromthe group you specify.

If you selected Some users from a group orMultiple sequential performers, you candesignate a combination of multiple users, groups, or alias names from which theperformer of the previous activity can choose at runtime. If you selected any of theother performer types, no further definition of the performer is necessary. This pagedoes 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 userand 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 determinethe actual users and groups.

2. Click Next.

3. If you chose Specific users and/or groups, select the names of the groups or userswho can perform this activity.

a. Highlight the user or group name in the list on the left and click Add to addit 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 Nextor 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 initiatorand 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 repositoryto 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 anddescription for the alias set. The server will create a new alias set using theinformation 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 valuesfor 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 appearsin 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, thenclick Add to add it to the Selection List.

c. To use an existing performer alias, select the appropriate alias from the Existingperformer 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 isclear 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 aliasset, select the aliases that the server will resolve from selected alias sets.

a. Select an alias set from theAlias 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 changethe position of the alias sets in the list by using the up and down arrows afteryou select the alias you want to move.

7. Click Finish.

Dene performer alias (performer(s) will be assigned whenworkow is underway)

When you select this option, you need to specify which alias set and alias the processengine will use at runtime to determine the actual person to perform this activity. Firstyou 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. Thedefault alias set is defined on the Template Properties dialog box. If no alias sethas 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 fromthe adjacent drop-down list. The list includes alias sets in the repository to whichyou are currently connected and on which you have Write permission.

• Alias set of document in package— The server refers to the alias set assignedto a document in a package that this activity receives. Select which package’salias set to use from the adjacent drop-down list. If you choose <Any>, the serverwill scan through the alias sets of all packages until it finds the first match to thespecific alias you will identify at step 4.

• Alias set of previous performer— The server refers to the alias set assignedto the performer of the previous activity. Use this option, for example, ifthis activity needs to be performed by the Manager of the previous activity’sperformer. If, at runtime, the previous performer does not have an associatedalias set, the server will use the alias set belonging to the previous performer’sgroup. If the group does not have an alias either, the failed activity task is sentto the workflow supervisor.

2. Click Next.If you chose Default alias set but have not yet selected a default alias set for thisworkflow, you need to choose an alias set.If you chose one of the other options or have already set the workflow’s defaultalias set, clicking Next takes you to a page where you can choose the specific aliaswithin 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 repositoryto 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 anddescription for the alias set. The server will create a new alias set using theinformation 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 includesthe aliases defined in that alias set.



If you chose an alias set that will be selected at runtime, such as the previousperformer’s alias set, the Performer Alias drop-down list is empty. Type the name ofthe alias in the box. Ensure that the name exactly matches the name in the alias setthat the server will find. If at runtime the server does not find a match between theperformer alias and the available aliases in the alias set, the activity task is returnedto 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 youhave set up in the activity. The performer is resolved based on process data and onlogic that you define in the decision table.

The left side of the expression defines the conditions based on data from the processattributes. 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 aperformer 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 thiscondition 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 apackage or a process variable associated with the process.

7. Based on the selections made in step 5, choose the attribute whose value you wantto 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 indexvalue to use in this condition by selecting one of the four options in the list, or bytyping a valid index value.

9. Choose a logical comparison operator from the Condition drop-down list and type acomparison 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 orprocess 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 clickAdd to move the performer to the selection list.

• If you choose to Type a DQL Query, type the query into the text box and clickValidate Query to ensure that the query is valid.

• If you choose to Select from Process Data, you can select process data or aprocess parameter to assign a performer. Select performer based on process dataand process parameters, page 125 provides more details on using process datato assign a performer.

You may find that you need to add attributes or elements to some of the datato complete the performer selection.

— Understanding the data mapping tool, page 147 provides procedures forusing the data mapping tool.

— Using repeating attributes, page 156 provides details on adding andmapping repeating-valued attributes.

— Mapping package attributes, page 149 provides instructions for exposingother 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 thefollowing 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 andrepeat the preceding steps.



When a condition includes multiple clauses, the server uses the rules of naturalprecedence to evaluate the expression. That is, clauses connected by AND areevaluated before clauses connected by OR. For example, suppose the condition hasthis form, where the letters represent conditional clauses:IF A AND B AND C OR D AND E OR F SELECT Performer NameThe 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 taskis assigned if none of the conditions are met.When you have defined all of the conditions, highlight the row in the Query tablethat begins with the word ELSE and select the performer to be used if none of theother 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 processparameters found in the activity. The performer can be the name of a user, group, orwork queue. In general, only STRING-based attributes can be used to select a performer.

To assign a performer based on process data1. 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, orprocess 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 tocomplete the performer selection.• Understanding the data mapping tool, page 147 provides procedures for using

the data mapping tool.• Using repeating attributes, page 156 provides details on adding and mapping

repeating-valued attributes.



• Mapping package attributes, page 149 provides instructions for exposing othersource 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 adollar 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 thework queue name and set the required skills for the activity on the Performer tab in theActivity Inspector. You can use process data mapper to relate process data from packagesor variables to the skills you defined in the work queue. When you map process data to askill, 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 aprocessor.

Note: Before you can set skills for a particular activity, the work queue must be definedalong with the set of skills that are associated with the queue. Additionally, the JavaMethod Server must be running in order for the system to use these mappings to assigna 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, selectWork 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. ClickNext to display the mapping tool with the list of process data in the left columnand the work queue and related skills in the right column.

8. Use the data mapping tool to associate attributes from the package data to thepredefined work queue skills in the work queue.See Understanding the data mapping tool, page 147 for details about using the datamapping 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 requirementlimits 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 userIf 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 whostarts the workflow.

• Repository owner— The automatic activity will use the permissions of therepository owner.

• Previous activity’s performer— The automatic activity will use the permissionsof the user or users who performed the previous activity in the workflow.

• Specific user— The automatic activity will use the permissions of a user youchoose 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 usersin 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 theSelection 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 triggersA trigger is a signal that the activity can begin. Use the Trigger tab to describe theconditions 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 theprevious activities must complete before this activity starts. The trigger condition is theminimum number of input flows that must have accepted packages for this activity tobegin. For example, if an activity has three input flows, you may decide that the activitycan start when two of the three have accepted packages.

Tip: When an activity has more than one incoming flow, it represents a join activity inthe overall business process. That is, packages following different paths through theprocess 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 triggerconditions for the next activity, which has only one incoming flow — the one from theJoin activity. See Join, page 189.

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 beforethis 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 precedingactivities that must be complete before the activity runs. The total number ofinput 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 Andwhen 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 makeup an event name, such as promoted or released. If you include a trigger event inthe starting condition, the server must find the event you identify queued to theworkflow before starting the activity. See Documentum Content Server Fundamentalsfor 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 Thisactivity can run more than once in a workflow checkbox.



A repeatable activity is an activity that can be used more than once in a particularworkflow. By default, activities are defined as repeatable activities. Activities withmultiple performers performing sequentially cannot be repeatable. Choosingperformers, page 24 describes the user categories for performers.If you use an activity multiple times in a workflow, you must structure the workflowso that only one instance of the activity will be active at any time. The server cannotstart an activity if a previous activity based on the same definition is still running.

5. Do one of the following:• Click Apply to save your updates without closing the Activity Inspector.• Click OK to save your updates and close the Activity Inspector.

Setting warning timersProcess 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 notnecessarily acquired by a user. Pre-timers are not activated on the first activity of aworkflow as they are automatically triggered during the workflow’s start.

• A post-timer takes action if an activity has not completed within a designatedamount of time after the activity starts.

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 inthe 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 Calendarlist 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 thatprocess, 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 becalculated based on the system calendar. The next time the timer job runs, the jobupdates 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 existingtimer from the list box.

4. From the Event drop-down list, select which type of timer action to create, eitherPre-Timer expiration or Post-Timer expiration.

5. Specify when the timer should expire by typing the number of elapsed hours andminutes in the Expire in text boxes.If this action is the first timer of a given type (pre-timer or post-timer), the timerexpires when the specified number of hours and minutes have elapsed since thestart of the workflow or activity, respectively. Subsequent timers expire when thespecified 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 asthough 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 templatecheckbox, then click the Select button.


b. After selecting an existing email template or creating a new template, name ofthe email template appears in the Use email template field.

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, theserver notifies users by sending a default notification to their Documentum inbox.

7. 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 templatecheckbox, then click the Select button and choose the custom email template touse for notification.

a. To open an existing template, navigate to the template it in the file structureand 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 newemail template dynamically. Using the Notification Template Wizard, page140 provides instructions on using the wizard to create an email template.



8. To have the server continue to repeat the final pre-timer or post-timer action until theactivity is completed, select the Repeat last action checkbox.You set the value of the Repeat last action option separately for pre-timer andpost-timer actions. When it is selected, the server will perform the last timer action atthe specified time interval until the activity is completed.

9. From the Action drop-down list, select the type of action to take when the timerexpires.The available options depend on whether you are defining a pre-timer or post-timerand on the nature of the current activity:• Notification— Enables Sending a notification, page 131 message to one or more

people.• Start Process— EnablesStarting a process, page 132 using the current activity’s

packages.• Run JAVA Method— Enables Running a Java method, page 133 (available for

users with superuser privileges only).• Delegate Task— Enables Delegating a task, page 133 to another performer

(available for manual activity post-timers only). A task can also be delegatedto a performer based on process data.

• Complete Task— Enables Completing a task, page 134 and forwarding it to thenext activity in the workflow (available for manual post-timers only).

10. Repeat steps 2 to 7 for each timer you want to add to this activity.

11. To change the order of a timer in the list box, highlight the timer action and clickthe 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 acertain interval after the preceding timer expires.


Sending a notication

Use this option to send an email notification to a person when the timer expires

To send a notication: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 theGroupsbox, 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. Whenyou select any of these aliases, the system displays the name the alias set isassigned 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 wantto select for the notification.You may find that you need to add attributes or elements to some of the datato complete the performer selection.• Understanding the data mapping tool, page 147 provides procedures for

using the data mapping tool.• Using repeating attributes, page 156 provides details on adding and

mapping repeating-valued attributes.• Mapping package attributes, page 149 provides instructions for exposing

other source attributes of a package that do not currently appear in the treeb. Click Add >> to move the selection to the list box on the right.

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 thecurrent activity.

3. Select the users to be notified.Sending a notification, page 131 provides more details on selecting users fornotifications.

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 theMethod 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 mustbe set. a_special_app is a dm_sysobject attribute reserved for use by Documentumproducts. This attribute must have the value Workflow. See the Documentum ProcessBuilder Development Guide for details about developing custom workflow methods.

3. Select the Yes, save the execution results checkbox to save an execution log whenthe method runs.


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 onGroups & 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 theGroupsbox, 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 isassigned 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 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.You may find that you need to add attributes or elements to some of the datato complete the performer selection.• Understanding the data mapping tool, page 147 provides procedures for

using the data mapping tool.• Using repeating attributes, page 156 provides details on adding and

mapping repeating-valued attributes.• Mapping package attributes, page 149 provides instructions for exposing

other source attributes of a package that do not currently appear in the treeb. Click Add >> to move the selection to the list box on the right.

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 particularvalue, so that an activity transition condition can route it differently based on thatattribute 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 whoseattribute the timer will set a value for.

3. From theAttribute 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 valuesto use in this condition by selecting one of the four options in Index list box or bytyping a valid index value.

5. In the Value text box, type the value to which the timer will set the selected attribute.


Setting activity transition rulesTransition rules determine which activities are next in the workflow. The flow is changedbased on the transition logic that is defined using process data. When an activity hasmultiple 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 onthe outcome of the activity. For example, you might give a performer who reviews thedesign of a new form the choice of forwarding the design to the next reviewer or to sendit back to the designer for revision. You set up this branching logic by creating flowsfrom this activity to the two possible following activities, then allowing the performerto choose which path to follow.

Tip: When an activity has multiple outgoing flows with branching logic, it represents adecision point in the overall business process. To display the decision point clearly inthe business process template, insert an explicit Decision Split activity template into theflow. Instead of setting the branching logic in the current activity, connect the currentactivity to a single Decision Split activity and set the branching logic in the DecisionSplit activity. See Decision Split, page 188.

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 performerchoose option, unless the automatic workflow method for the activity uses the setoutputmethod to choose the next activities. Documentum Process Builder Development Guideprovides more details on this subject.

Defining activity transitions, page 40 provides more details on transitions



To dene 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 tabyou selected All users in group or Some users from a group— specify how manyperformers 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 requirednumber of performers in the text box. If the number you type is greater than thenumber of performers who receive work items for this activity at runtime, theserver 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 ofactivities the performer can select using the Select up to [ ] activities drop-downlist box.The list box displays the total number of available next activities by default. You canselect any number between 1 and this maximum. At runtime, the server will notallow 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 performercategory is All users in group or Some users from a group and the transition optionis Let performer select the next activity— specify when to forward packages to theselected next activities.• To start selected reject activities immediately, select the Any performer rejects

radio button. If any performer selects reject activities, the activities are startedwithout waiting for other responses. All other performers’ selections are ignored.

• To start selected forward activities immediately, select the Any performerforwards radio button. If any performer selects forward activities, the activitiesare started without waiting for other responses. All other performers’ selectionsare ignored.



• To start the selected next activities only after the number of performers identifiedin step 3 have completed the task, select the All performers complete thetask radio button. With this option, the server combines the selections of allperformers. If some users select forward activities and others select rejectactivities, the server determines which activities to start based on the final setof radio buttons on this tab.

— To start all of the activities selected by performers, both forward activitiesand reject activities, select Start all selected activities.

— To start only the selected reject activities (if there are any), click Start onlyreject activities. Forward activities are started only if all performers selectforward activities.

— To start only the selected forward activities (if there are any), click Startonly forward activities. Reject activities are started only if all performersselect reject activities.

6. Specify the conditions that the server uses to determine which activities receivepackages.See Creating transition conditions, page 137 for information about creating transitionconditions.

7. Do one of the following:• Click Apply to save your updates without closing the Activity Inspector• Click OK to save your updates and close the Activity Inspector.

Creating transition conditions

When you choose the Select next activities based on these conditions option, a tableappears showing the defined transition conditions. When you first define an activity,the table is blank. Follow this procedure to add transition conditions for automaticallychoosing the next activities in the workflow. For more information about transitionconditions, see Defining activity transitions, page 40.

Note: When an activity uses transition conditions, the flows that lead to the nextactivities have a diamond at the start of the flow line. This format follows the BusinessProcess 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 thiscondition to apply:



• The running workflow — The condition will check attributes of thedm_workflow object.

• The last completed work item for the activity— The condition will checkattributes of the dmi_workitem object.

• Process Data— The condition will check attributes of the process package orprocess 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 aprocess variable associated with the process.

4. If you select an input package that is an XML document and you want this conditionto check a value of an internal XML element, select the XPath Expr checkbox andidentify 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 towhich the document in the package conforms. You can type the name into thetext box, click Local to choose the schema from the local file system, or clickRepository 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 youwant to use in the condition. If you selected a schema at step a, you can clickthe Select button to choose from a list of valid XPath expressions. If you did notselect a schema at step a, click theWrite-in Expression link and type the fullXPath 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 repositoryattribute 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 thebox for selection.If a drop-down list labeled Repeating attribute, choose or type an index appears, itmeans that the attribute you chose can have more than one value. Indicate whichindex 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 toa repeating attribute, the attribute must have at least one value or the conditiongenerates 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 acomparison value in the Value text box. The data type for the selected attribute isshown below the box.

7. Select the activities to perform next when this condition is true by highlighting theactivity 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. Toselect more than one activity, hold down the Ctrl or Shift key when clicking theactivity names.

Note: You must select an activity now even if you plan to add additional clauses tothe condition.

8. To add an additional clause to this transition condition, click the AND or OR buttonnext to the Add another clause label and repeat steps 2 through 6.When a condition includes multiple clauses, the server uses the rules of naturalprecedence to evaluate the expression. That is, clauses connected by AND areevaluated before clauses connected by OR. For example, suppose the condition hasthis form, where the letters represent conditional clauses:IF A AND B AND C OR D AND E OR F SELECT Activity 1The 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 (whichadds a row starting ELSE IF), then repeat steps 2 to 7.

10. When all of the specific transition conditions are defined, select the activities towhich packages are routed if none of the conditions are met.When you have defined all of the transition conditions, highlight the row in theQuery table that begins with the word ELSE and select the activities to performif none of the other conditions apply.

Setting noticationsOn the Notification tab, you can set the messages that the server sends in responseto workflow-related events such as activity state changes, a method failure during anautomatic event, and so on. Users registered to receive notification of the event willreceive 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 sendnotifications in response to workflow timers. Setting warning timers, page 129 providesmore details on this subject.

Note: The server does not send a notification At the start of a work item for automaticactivities.

To specify the email messages used for notications:1. In the Activity Inspector, select the Notification tab.

The tab displays the names of the events for which notifications are sent. The nameof 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 anevent, select the Change email template check box next to the event name.The Select button becomes active when the check box is selected.


b. After selecting an existing email template or creating a new template, name ofthe 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 Notication Template Wizard

Use the Notification Template Wizard to create email templates dynamically from withinan activity. The email notification templates can be based on process data, enabling youto Templates are saved to /System/Workflow/EmailTemplates folder. Templates can beshared among processes, although it is not recommended since templates are based onmappings and process data specific to a process.

Note: Editing the mappings in the notification template changes the template throughoutthe system. All activities using the template will be immediately updated to reflectany changes you make.

The list of default notification senders and recipients is based upon the type of event. Thesystem sends the notification to the default recipient in addition to any recipients that arespecified by the mappings. If the email From field is mapped to a value, the mappedvalue 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 Defaultrecipient

dm_startedworkitem New task iscreated

User whose actionhas triggeredthe new taskgeneration suchas the performer ofprevious activity

Taskperformer



Event name Description Default sender Defaultrecipient

dm_delegatedworkitem Task is delegatedor reassigned

User who delegatedthe task

Target user

dm_changedactivityin-stancestate

Automatic taskhas failed

Task performer Workflowsupervisor

Pre-timer expires Pre-timerexpires

Repository installowner

Users/groupsselected to benotified in thepre-timer list

Post-timer expires Post-timerexpires

Repository installowner

Users/groupsselected to benotified in thepost-timer list

To create a new email template1. 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 representdynamic 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. Theplaceholder starts after the dollar sign $ and ends with first non-alphanumericcharacter.

For example, to send a message indicating that a purchase order was processedsuccessfully, you would use the following template text: Purchase Order $ordernosuccessfully processed. The placeholder orderno appears in the data mapping screenand can be mapped to a package or process variable. The notification sent have thefollowing subject: Purchase Order 0896523 successfully processed, where 0896523 is thesubstituted 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, andplaceholder parameters that can be mapped to process data.If you are including HTML markup in the email body, you must map the constantvalue text/html to the Content-Type in the Body node of the email message. IfContent-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 firstnon-alphanumeric character. Additionally, all placeholder values must bemapped to process data.

5. Click Next to create the input message mapping associating process data to theemail message.The email message structure appears in the right-hand pane and the process data onthe left side. You can set values for email message attributes by mapping them fromattributes of the process data model. If you have multiple email attachments, youcan 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 theNotification field. When a recipient is also mapped in the email template, one emailis sent to that recipient for each user defined in the Timer tab. If there are three usersselected to be notified and a recipient is mapped to the To: field in the template, thesystem sends a notification to each of the three users and also sends three copies ofthe notifications to the user specified in the To: mapping.

You may find that you need to add attributes or elements to some of the data tocomplete the mappings.Understanding the data mapping tool, page 147 provides procedures for using thedata mapping tool.Using repeating attributes, page 156 provides details on adding and mappingrepeating-valued attributes.Mapping package attributes, page 149 provides instructions for exposing othersource attributes of a package that do not currently appear in the tree

Note: All placeholder nodes under the Subject and Body nodes must be mapped atthis point. Recipient fields are not required to be mapped.

6. Click Next to map the output message.For example, if you added a process variableMsgId, you can map the notificationmessage ID attribute from the source message to that process variable.



You may find that you need to add attributes or elements to some of the data tocomplete the mappings.Understanding the data mapping tool, page 147 provides procedures for using thedata mapping tool.Using repeating attributes, page 156 provides details on adding and mappingrepeating-valued attributes.Mapping package attributes, page 149 provides instructions for exposing othersource attributes of a package that do not currently appear in the tree

7. Click OK.The template becomes the default template for specific notification for which youhave created it.

Changing process data in an activityWhen you configure an activity, you need to specify what process data is workedon during the activity and define how the activity deals with each package, processparameter, or process variable that is part of the process template. Process data isdefined on the Data tab of the Process Properties component. Managing packages, page69 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 organizedinto the categories associated with either the packages, process parameters, or processvariables used in the process. The list box displays the available information about theprocess data such as the type, version, and other attributes specific to the process data.

To view information about the individual packages, process parameters, or processvariables, highlight the specific node for Packages, Process Parameters, or ProcessVariables. For packages, the name, type, and version fields are read-only and can onlybe changed from the Process Properties page. Process variable and process parameterinformation can be changed from the node view.

You can change how the activity handles the process data by selecting or clearing thecheckboxes 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 displayingthis package to the activity performer.



The form template assigned to the package in the Process Properties dialog boxappears by default. Only form templates that use the same data model as the defaultform template are displayed in the drop-down list. See Associating form templateswith 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 defaultoptions for displaying the contents of the package, which usually enables the userto open it in the application associated with the document type, such as MicrosoftWord for Word documents.

4. To use the form you selected in step 3 to display the properties of the package, selectthe Use Form for Properties checkbox.When the Use Form for Properties checkbox is not selected, the form from step 3appears 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 isused 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 atthis activity checkbox.If the Visible at this activity checkbox is not selected, the activity performer does notsee 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 isa mandatory package.If the checkbox is not selected, the activity performer can assign content to thispackage, but need not do so.

7. To enable Process Builder to publish reporting data to the BAM database for thepackage, select This package can be used to generate reports.

8. Repeat steps 2 through 6 for each package in the process.

9. Do one of the following:• Click Apply to save your updates without closing the Activity Inspector• Click OK to save your updates and close 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 processflow.

2. Click Auto-Launch Package to have a package or associated Form displayautomatically when the activity starts.This option enables this package to display right away. By default, when a performerstarts 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 assignedto 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 theprocess template.

2. To make variables available to the performer of this activity, select the This variableis 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 canbe 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 theprocess template.

2. To expose this variable and use it to generate reports, select the This variable canbe used to generate reports checkbox.

Changing display settingsThe options on the Display tab control how the activity appears in the visual displayof the process template.

Note: When an activity has one or more timer actions set for it, a small clock icon appearsin 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, select BrowseRepository or Browse Local to search for a new image.

3. Navigate to the file containing the graphic.• If you are browsing the local file system, navigate to the file and click Open.• If you are browsing the repository, navigate to the file and click Select.The selected file appears in the Image file box.



Note: If you select an image from outside of the standard location for activityimages (which is the repository folder System/Workflow/Images), Process Builderautomatically 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 directoryC:\Program Files\Documentum\BPM\classes\images, Process Builder imports theimage file into the System/Workflow/Images repository folder.

4. To change the size of the graphic representing the activity, select a percentage fromthe Image size drop-down list.The percentage is the percentage of the actual size of the graphic.

5. Specify whether to display a label for the activity by selecting or clearing the ShowLabel checkbox.If you clear Show Label, skip steps 5 and 6.

6. Choose whether to display a label for the activity with its activity Name or thePerformer.Note that error messages, such as any that occur when you validate the template, willrefer to activities by their names. If you label activities with the performer name, youmight want to temporarily change this setting toName in order to locate the activity.

7. Set the font and style used to label the activity in the template.

a. Select a font from the Label font list.



8. Do one of the following:• Click Apply to save your updates without closing the Activity Inspector.• Click OK to save your updates and close the Activity Inspector.


Chapter 8Mapping Process Data Elements

This chapter describes how to use the data mapping feature of Process Builder from within an activitytemplate and includes the following topics:

• Understanding the data mapping tool, page 147• Adding or editing process data in the mapper, page 149• Mapping package attributes, page 149• Adding message properties, page 150• Adding an XML schema to activity content , page 151• Adding a node based on a condition, page 154• Mapping the data, page 155• Understanding message correlation, page 162

Understanding the data mapping toolThe data mapping tool provides a graphical data mapping tool that simplifies theprocess of passing workflow data. The tool enables you to map data between processdata, process parameters, or workflow attributes on the left side of the window to serveror workflow attributes on the right side of the window. This can include data sourcessuch as workflow method arguments, web service parameters, database query returnvalues, 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 processdata from packages or variables in the flow to the skills that you defined in the workqueue.

Many automated activities require mapping information from one data source toanother. For example, suppose a loan-origination process includes an activity that calls aweb service to look up a customer’s credit score. The activity needs to pass the socialsecurity number from the loan application package to the web service, and it needsto copy the returned credit score into another package attribute so that it is available


Mapping Process Data Elements

to subsequent activities. The graphical mapping tool enables you to map data frompackage attributes to the web service input parameters and from the web service outputmessage 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 datamapping functions and lines that connect the boxes to their input sources and outputdestinations.

The contents of the left and right columns depend on the type of activity you areconfiguring. For activities for which you need to provide input values, the left columntypically shows the attributes for all business process packages, process variables, andthe runtime execution variables, such as the name of the supervisor, that are available atruntime.

The center column displays the functions used to transfer data from one or more datasources on the left to a data destination on the right. The mapping tool enables you tocopy values directly from one data source to another, perform data type conversions,concatenate strings, perform mathematical operations on numbers, and include constantvalues. See Using data mapping functions, page 158 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 thetree, using the + or— icon to expand or collapse the tree. Data types exposed in the treeinclude packages, process variables, execution data, and process parameters.

Adding or editing process data in the mapperYou can add or edit many of the individual elements of the data tree by selecting the Editlink 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 processmodel as needed during the design of the process without having to exit the designerand launch the Process Properties dialog box.

Whenever you see a green plus sign icon on a node, package, or data attribute, itsignifies that you can add or edit the data associated with that location in the process data.

Mapping package attributesFor packages on both sides of the mapper, the tree displays only selected attributes bydefault. It displays all custom attributes for the package’s object type plus a selection ofcommonly used standard attributes. The package node also displays the following threeadditional 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_idattribute 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 inthe 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 completelist 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 reappearwhen you save the activity and reopen the Activity Inspector.

Adding message propertiesThere may be times when you need to add a service-specific property to a message inorder to complete a mapping. In this case, you can add the property to the message, butyou must ensure that it is added to the correct node and that it is named correctly. Thereis 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 savedwhen you reopen the Activity Inspector.

Adding an XML schema to activity contentYou can associate an XML schema with attachment or package content or with thecontent received from external sources (such as HTTP or JMS services) and use themapper to map elements from the schema. Before attaching the schema to a node in thedata mapper tree, modify the schema to change all schema import statements containingrelative URLs to use absolute URLs.

The data node expands once a XML schema is associated with the content data. If apackage is associated with a form that uses an XML schema, the content data nodeautomatically displays the XML schema associated with the form.

Note: If the value that you are mapping is based on an enumeration set, you can viewthe 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.You can filter the list to show XML and XSD files or you can select to view all contenttype formats.

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.

Incorporating Forms Builder forms in a processWhen you associate a Forms Builder form with a workflow, users can enter informationinto the process using a form and then submit it to a specified URL or email address.This data can then be incorporated into the workflow. Once the data from the form issubmitted to the workflow, the elements from the form’s schema can be mapped toprocess variables, a package, or an attachment.



Populating a form using an XML le

You can use the data mapper to populate the fields of a form by using an incoming XMLschema and mapping those elements to the form schema.

To populate a form with data from an XML le:1. Create a form in Forms Builder and associate it as a package to the process and to

an activity such as an FTP Inbound activity template.The forms schema appears in the data node of the package.

2. Use the data mapper to associate an XML schema from the repository with the Datanode of the activity.Adding an XML schema to activity content , page 151 provides the instructions onadding an XML schema to the data mapper.

3. Use the mapping functions within the mapper to move content from the XML fileschema to the form schema.

Creating a high-delity form using process data

High-fidelity form templates generate forms that closely resemble their papercounterparts and incorporate functionality from OpenOffice.org.

When a high-fidelity form template is associated with a process, you can map processdata to the elements of its schema and create or generate an instance of the high-fidelityform from process data.

Using an HTTP Inbound - Initiate activity to create a new high-delityform instance

You can use an inbound activity to create a new high-fidelity form instance.

To create a new high-delity form instance:1. Configure the HTTP Inbound - Initiate activity template with the URL suffix and

select the Request type as Post and choose to include attachments in the request.

2. Create a package in the process that is based on a high-fidelity form that is installedin the repository.Make sure that the package is not mandatory to the process by clearing the checkboxThis is a mandatory package.



3. In the data mapper for the HTTP Inbound - Initiate activity template, right-click theSource Data node for the attachment and select Add Form Template.

4. Browse to the location of the Form template and select it.The object type is dm_xfm_form.


6. Click OK.When you expand the Data node, you can view the high-fidelity Form attributes.

7. Map the required schema elements from the HTTP attachment Data node to thePackage node and save the activity template.

8. If you would like to send an email with the form you have created, you can add anSMTP Outbound activity template to the process and map the package contentto the email attachment node.

Using a Process Data Mapping activity to create a high-delityform instance

You can use a Process Data Mapping activity template to create a high-fidelity forminstance in the workflow and then use an outbound activity template like FTP Outboundor SMTP Outbound to send the form as an attachment or a package.

To create a high-delity form instance as a package:1. Create a package in the process that is based on a high-fidelity form that is installed

in the repository.Make sure that the package is not mandatory to the process by clearing the checkboxThis is a mandatory package.

2. Open the Process Data Mapping activity template, right-click the data Source nodefor the package and select Add Form Template.

3. Browse to the location of the Form template and select it.The object type is dm_xfm_form.


5. Click OK.When you expand the package data node, you can view the attributes of thehigh-fidelity form.

6. To create the new high-fidelity form in folder that is not the default folder, map ther_folder_path to the new folder location.



7. If you would like to send an email with the form you have created, you can add anSMTP Outbound activity template to the process and map the package contentto the email attachment node.

To create a high-delity form instance as an attachment:1. Follow the steps in the preceding procedure to create a high fidelity form instance

as a package.

2. In the Destination mapping, right-click the FormTemplateName for the Attachmentnode and assign it to the high fidelity form template name.

Note: This mapping is mandatory.

3. Map the necessary process data values to the attributes of the form.

4. If you would like to send an email with the form you have created, you can add anSMTP Outbound activity template to the process and map the attachment contentto the email attachment node.

Using a high-delity form to add data to a process

You can receive a high-fidelity form in a process and incorporate the information fromthe form into the process for use later in the workflow. For example, if you receivethe form from an Email Inbound activity template that has an attachment that is ahigh-fidelity form, you can map the incoming process data to process variables and addthat information to the process.

Adding a node based on a conditionUse the Conditional Node Builder to add a node to the data tree that uses an expressionbuilt using the child attributes the node. This option is available for some repeatingnodes that have more than one attribute and for the Workitem node located withinthe 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 thetext of the expression is not visible in its entirety, right click the node and open theConditional Node Builder to view the complete text of the expression.

Mapping the dataThe center column contains boxes representing data mapping functions and linesconnecting the function boxes to their input arguments and output destinations. Atruntime, the activity passes the values of the input arguments to the function, and savesthe result as the value of the destination attribute.

You create one mapping function at a time. The data mapping tool requires you tocomplete one mapping (by selecting its input parameters and output destination) beforestarting on the next mapping. Whenever process data is mapped, the correspondingformat 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-valuedattributes. When the input argument is a repeating-valued attribute, or a query withmultiple 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 anyexisting value or adds a new attribute value. See Using repeating attributes, page 156 fordetails 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 158 for information about the availablefunctions.An icon representing the function appears in the mapping area. A red X in the lowerright 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 doesnot affect the order of execution.

3. From the left column, select the attributes whose values will be the input data forthe 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 ofthe selected attribute does not match the data type the function expects, the line isdashed. The system will attempt to convert the value to the required data type atruntime. Clicking the attribute name a second time clears it and removes the line.If the current function accepts multiple input values, you can select multipleattributes from the left column. By default, the attributes are added to the function’slist of input arguments in the order you select them. See step 5 for informationabout modifying the order of arguments.If the attribute you want is already linked to another function, you can link it tothe current function by clicking the Line drawing mode button (to the right ofthe function list at the top of the center column) and drawing a line from the blackdiamond at the left end of the previous selection line to the box representing thefunction.In some cases, you may want to define a function that does not use any attributes asinput data. That is, all of the input values are constants. In these cases, skip this stepand type the relevant constant values at step 5.

4. From the right column, select the attribute into which the activity will write theresult 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 dialogbox displays the name of the function, its syntax, and a list of the input values. Thenames of the attributes you selected at step 3 appear in XPath format. Using thisdialog box, you can change the order of the attributes or add constants as additionalinput values. Using data mapping functions, page 158 provides more details onthis 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 activitytemplates provides support for multivalued attributes.

A multivalued attribute has an Add link next to its name. Use the Add link to create anode 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 canselect FIRST/LAST or type a numeric value.



To copy a single-valued attribute to a specic index of multivaluedattributes: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 thesingle-attribute node.

3. Select the node that represents the specific index of the multivalued attribute inthe target tree.

To copy the specic index of a multivalued attribute to a single-valuedattribute: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 inthe 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 specic index ofmultivalued 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, andselect 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 afteror before the index. When using the Overwrite option, the existing values areoverwritten

Input context

Depending on the Input Context option selected for a mapping rule, all values of amultivalued attribute are either passed to the mapping function as arguments (ALLoption) or the mapping rule function is executed once for each value (FOR-EACH). TheInput 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 youselect a function from the list, an icon representing it appears in the mapping area. Afterlinking the function to its input arguments and output destination (as detailed in thesection Mapping the data, page 155), you may need to use the Function Editor dialogbox to complete the function definition. The Function Editor enables you to modify afunction’s order of input arguments, and also to add constant input arguments whosevalues do not come from process data.

Double-click the function box to display the Function Editor dialog box. The dialog boxdisplays the name of the function, its syntax, and a list of the expected input values. Thenames of the input attributes linked to the function appear in XPath format. If the valuethat you are mapping is based on an enumeration set, you can view a list that shows theenumerations values of the destination node of the function.

• To change the order of the input arguments, highlight one of the arguments and clickthe 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 willprecede the constant and click the + button. A new line appears below the line youhighlighted. Type the constant value on the new line.

Note: You cannot add a new package attribute to the function using this dialogbox. To add a new package attribute, return to the mapping screen and select itfrom 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. Toremove a package attribute, return to the mapping screen and clear it from the leftcolumn.

The following table lists available functions.

Table 7. Data Mapping Functions

Function Input Arguments Result

Add Two or more numbers. Sum of the inputarguments.

Add Business Day An integer date value, astring for the calendar,and an integer for thenoOfDays.

Adds a business day to thenoOfDays value. The valuefor a business day is basedon the selected businesscalendar.




Add Days An integer date valueand an integer for thenoOfDays.

Returns a date after addingthe specified number ofdays to the date.

Byte To String Two strings, the firstrepresenting the binarydata, and the secondspecifying its encodingvalue, such as UTF-8,UNICODE, and so on.Default encoding value isUTF-8.

Data as a string.

Concat Two or more strings. Concatenated stringconsisting of the inputarguments in order.

Copy One argument of any type. Unchanged inputargument.

Count Object param[]): Returns the number ofvalues in the multi-valueinput. For single valueinputs, the return in 1.

Date to String A date and a stringrepresenting a valid datepattern.The date pattern mustconform to the standardJava SimpleDateFormat.For details, refer to theJava API and developerreference documentationlocated on the Sundeveloper website.

Date value as a string withthe specified pattern.

Divide Two or more numbers. Result of dividing thefirst input argument bythe second argument.When there are morethan two arguments, eachsubsequent number is usedto divide the previousresult.




Get Day Integer. Returns an integer thatrepresents the day segmentof the date.

GetEmailAddress String. Queries dm_user to returnan email address for a user.

Get Month Integer. Returns an integer thatrepresents the monthsegment of the date.

Get Value String parameter thatspecifies the object and theindex position number.

Returns a value from aspecified position in theindex.

Get Year Integer. Returns an integer thatrepresents the yearsegment of the date.

Join Two or more string arrays. Creates a join of theselected inputs.

Multiply Two or more numbers. Product of the inputarguments.

Split String that can include anoptional index positionvalue.

Returns a repeatingstring or a position inthe repeating value if theoptional index position isused.

String To Byte Two strings, the firstrepresenting the data, andthe second specifying itsencoding value, such asUTF-8, UNICODE, and soon. Default encoding valueis UTF-8.

Binary data.




String to Date Two strings, the first givinga date and the secondspecifying its pattern.The date pattern mustconform to the standardJava SimpleDateFormat.For details, refer to theJava API and developerreference documentationlocated on the Sundeveloper website.

Value of Date data type.

Substring A string, a numberrepresenting how manyof the initial characters toremove from the string,and optionally a numberrepresenting the position ofthe last character to includein the substring.

String consisting ofcharacters from the firstinput argument, startingfrom the specified startposition and ending at thespecified end position.

For example, if the inputarguments are "unhappy"and 2, the result is thestring "happy". If the inputarguments are "unhappy",2, and 5, the result is "hap".

Subtract Two or more numbers. Result of subtracting thesecond number fromthe first number. Whenthere are more than twonumbers, each subsequentnumber is subtracted fromthe previous result.

ToLower String. Converts the string tolower case letters.

ToUpper String. Converts the string toupper case letters.



Understanding message correlationProcess Builder must be able to match an inbound message to a unique instance ofa workflow in order to process the incoming data. Process Builder uses correlation setsand correlation identifiers that are made up of unique data to match the response to theoriginal request.

For example, in one activity of a purchasing process, a JMS message is sent to thesupplier 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 whichincludes both the vendor ID and the purchase order number. When these identifiersare mapped to the appropriate process data, the system can match the request to theresponse and continue the workflow.

Using correlation identiers

When a process instance starts, the Process Engine creates a unique correlation_identifierattribute in dm_workflow to identify the process. When an inbound step activityreceives this identifier in a message, it can match the message to the process instancebased 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 sameidentifier in its response. In other words, the correlation_identifier must have beensent out at some point earlier in the process for the system to be able to receive it inthe incoming message. For example, when the message is sent to a vendor requestinginformation on a purchase order, the system-generated correlation identifier is sent inthe outgoing message. When the inbound message also contains the same correlationidentifier, the system uses it to match the message to the process instance.

The fields that contains the correlation identifiers are configured in each inbound stepactivity template on the configuration page where you define the connection, protocol,and processing instructions. This identifier is specific to the protocol of the message. Formany inbound messages, unique properties of the message such as data in the messageheader or a unique filename can contain the correlation identifier to match the messageto a process instance. If there is no match between these values, the system will use thespecified correlation set to match the message to a process instance.

Table 8. Fields used to congure correlation ID

Activity template Field name Example

JMS Inbound - Step N/A Use the JMS header CorrelationId



Activity template Field name Example

HTTP Inbound - Step CorrelationProperty

MessageID

Email Inbound - Step CorrelationHeader

Subject

FTP Inbound - Step CorrelationPattern

po_$id$.txt

Web Service Inbound - Step N/A Use the WS-Addressing headerMessageID

Using correlation sets

If a correlation ID has not been configured for an activity or if the correlation ID ismissing from an incoming message, the system looks for a correlation set mapping tomatch the message to a workflow. A correlation set is a collection of process variablesthat you define for an activity. In most business processes, there are unique attributesof process data that can be identified and used to match incoming data to a processinstance. These mappings are created using the data mapping tool within the activitytemplate, 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 ProcessProperties component. From the list of process variables that are associated with theworkflow, you name the correlation set and add the attributes to it that you will use forthe correlation mapping. For example, you can use a unique purchase order numberand a name to match messages to a process instance. If the purchase order and name arepassed in all messages that are sent to and from the instance of the process, then thosevalues can be used to match response and request messages. You can create a correlationset named Purchase Order and within it, select the process variables for purchase ordernumber and address. In the data mapping tool, you would then link the attributes forthe purchase order number and address from the incoming message attributes.

A correlation set can have more than one correlation identifier and a process canuse multiple correlation sets, if necessary. You can only select one correlation set formapping within an activity. For example in a process flow that manages product ordersfrom 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 messageswithin inbound activities.

The data that a correlation set uses must exist or be set in the process before the workflowreaches the activity that uses the correlation set. The data can be set in the activity usingan initiate activity or another step activity earlier in the process.



Note: Process variables that will be used in correlation sets should not have defaultvalues. Process variables that have default values do not possess the unique attributecharacteristics 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 fora process.


Chapter 9Debugging a Process Template

This chapter introduces the basic concepts of debugging a Process Builder process template. Thefollowing topics are included:• Understanding the process debugger, page 165• Preparing to debug the process, page 168• Testing a process in the debugger, page 171

Understanding the process debuggerProcess Builder’s debugger enables you to test the design of a process templateinteractively by setting breakpoints, running through the process, examining andmodifying process data, testing integrations, and acquiring and acting upon taskswithin the process.

Debugging a process before deploying it to a production environment helps to ensurethat the process flow you have designed satisfies the original business requirementsupon which you have based your design. Using the debugger to troubleshoot a processenables you to test a process from within the process design environment withouthaving to save, validate, or install the process. You can also test activities as you aredeveloping 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 duringthe 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 youmake to process variables are only kept on the local system for the life of the debuggingsession. They are not saved after the session has ended. However, the server does savechanges made to the objects in the package or attachments during the debug sessionand overwrites the existing attribute data. The system also creates any objects that areneeded for automatic activities within the process such as renditions or attachmentscreated through mapping rules.


Debugging a Process Template

When the system executes a manual activity, the system automatically acquires andcompletes the activity enabling you to run through the entire process without stoppingat that particular activity. To manually complete an activity or to perform anothermanual function on the activity, you can set a breakpoint on the activity. This enablesyou to execute the functions that a performer might take such as select the next activityin 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 datathat is associated with the activity.

As the debugger runs through the different activities of the process flow, it marksprogress through the flow with a bold line. This is especially useful when following theprogress through a flow that has transitions with different potential paths. When thedebugger is ready to execute an activity, a green arrow appears above it indicating thatthe 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 iscomplete in both the Task Manager and the Console tabs. At this point you still haveaccess to the process in debug mode and can view the messages from the Process Engineusing 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 beenadded to the process.



• The bottom pane is comprised of the following tabs:

— TaskManager tab that manages the execution options for manual and automatictasks,

— 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 borderbetween 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 modeor reruns the process in debugmode.

Adds or removes a breakpoint.

Identifies all current activities inthe workflow. The workitem hasbeen created and acquired by theperformer. The arrow only appearsfor activities that require manualintervention or have breakpoints.

Identifies an activity that has alreadybeen executed in the debugger.

Identifies an activity where abreakpoint has been set.

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



Adding breakpoints

Breakpoints enable you to stop the process flow at a specific activity in order to changeprocess data, add packages, and view the execution information for the task. You canadd breakpoints for any number of manual or automatic activities.

When running through a process in debug mode, the system stops before each activitythat has a breakpoint, enabling you to open the activity and add content to packages andto 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. Withan automatic activity, you can open the activity, execute the task and see the input andoutput 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 workow in the debugger

You can debug a saved process template from the repository or you can debug a processas you are designing it before you have saved it. Once the process is open in the processeditor, start the debugger, you select an initiate activity to begin the process. You can addpackages or attachments to the process and edit package data and process variables inorder 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, thedebugger icon appears in the tab next to the process name. The system will not launch anew 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 launchthe Debug Process dialog box.

3. Type a name for the workflow in theWorkflow 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 youwant to test.You must add content to each mandatory package.

6. If necessary, you can edit attributes by expanding the node, clicking any that isavailable 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 therepository and overwrite the existing package attribute data.

7. Expand the Variables node to edit the values by right-clicking any editable fieldand selecting Edit Value.Changes made to process variables are only kept on the local system for the life ofthe 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 171 provides detailed instructions on testingthe process.

To start a debug session using an inbound initiate activity:Note: Before debugging an HTTP Inbound or Web Service Inbound initiate activity, youmust specify the port number to be used for the listener in the Preferences dialog. Settingthe port number for debugging inbound activities, page 47 provides instructions forsetting the port number. Other inbound activities use the pollers that are specified inthe 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 tolaunch the Debug Process dialog box.

3. If you will use an inbound initiate activity to debug the process, select Startworkflow using inbound initiate listeners.The system starts the listener for the message type associated with the activity andbegins 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. Oncethe process receives the message, the workflow begins.Testing a process in the debugger, page 171 provides detailed instructions on testingthe process.



Testing a process in the debuggerYou can choose to run a process straight through without having any breakpoints or youcan stop at the activities for which you’ve defined breakpoints and test the activityinteractively using the process debug window. You can perform manual tasks and runautomatic tasks, set different values for process variables and packages, and send eventsto the workflow. Using the Console tab, you can view the message from the ProcessEngine that assist you in troubleshooting the process.

In addition, there are several toolbar buttons that enable different functions in theprocess debug window.

Table 10. Process debugger buttons

Button Purpose

Step Over to Next Activity advances thedebugger to the next activity even if thereis no breakpoint set.

Step Into the execution of the current activityenables you to view the details of theautomatic activity. The activity executes butdoes not continue on to the next activity.You must step into an automatic activity toview the service messages associated withthe execution of the activity. You can makechanges to the activity’s mappings andconfiguration, rerun the activity if it hasfailed, and perform other troubleshootingfunctions.

Rerun Debug reruns the process from thebeginning of the flow and without havingto reload process data.• For packages or attachments, the processruns with the same data that it ended theworkflow with. If there were changesmade to a package or attachment duringthe workflow, those changes are saved tothe repository and the process starts overusing the changed attributes.

• For process variables, the process runswith the attributes that were originallyfront-loaded into the debugger. If therewere changes made to process variables,



Button Purpose

those changes are not saved, so theprocess runs with the original values.

This option is only available after theprocess has been completed. You cannotrerun a partially completed process.Continue to Next Breakpoint enables you tomove to the next breakpoint in the process.

Stop Debug terminates the debug processand deletes the workflow and workitemsthat were created for the debug session.

Exit Debug Session exits the debugger andreturns to the process template editor.The system deletes the workflow and allworkitems that were created for the debugsession.

Using the Task Manager tab

The Task Manager tab enables you to perform different tasks for both manual andautomatic activities. The tab displays the state of the workitem in the activity (forexample, acquired) .

Managing a manual task

By default, manual tasks are acquired and completed by the system enabling the processto run through the debug process without intervention. When you place a breakpoint ona manual activity, you can select the content for a package, modify process variables, andperform 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 theDocumentum TaskSpace Configuration Guide provide details on the different actionsavailable for managing manual tasks.

Managing an automatic task

When you step into an automatic activity, the debugger executes the current activity anddisplays the protocol-specific input and output messages, as well as any exceptions.These messages enable you to view the communication between systems that the processintegrates with such as external web services databases and helps to troubleshoot anyproblems.

In addition, you can open the Activity Inspector and edit any of the properties of theactivity with exceptions. After editing an activity with exceptions, you can rerun theactivity to ensure that the activity completes without errors.

To complete an activity that has errors that you cannot correct, click Force CompleteTask 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 followingfunctions:• 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 activityexecutes immediately and you cannot changes packages or attachments.

• Execute the task and then view input and output messages as well as exceptionmessages 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 activityand trigger the execution of the activity. This enables you to view any input or outputmessages, 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, thetext of a SOAP request appears in the message window enabling you to copy it andpaste it into a text editor. You can also view the text of the response message (the SOAPresponse) and any subsequent updates to the process data.



Debugging automatic workow methods

Several of the activity templates delivered with Process Builder execute automaticmethods that extend from WorkflowMethod. These activity templates are:• Create Folder• Link to Folder• XSLT TransformationThe code for these automatic methods are located in the bpsintegration.jar file. Duringthe installation process, the Process Builder installer places these files in the C:/ProgramFiles/Documentum/BPM/classes/custom directory so that they are available to theprocess debugger.

If a process contains custom Java methods, the methods must extend fromWorkflowMethod. If the Java methods do not extend from WorkflowMethod (instead,they implement IDfMethod), they cannot be executed from the debugger and will resultin an error. Use the Force Complete Task button to complete the task and continuedebugging 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 selectionin the Activity Inspector.

3. Create a .jar file (or the classes with the full package structure) for thecustom Java code and place the .jar file (or classes) in the C:/ProgramFiles/Documentum/bpm/classes/custom directory.This enables the debugger to load the .jar file or classes for the execution of thecustom 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 activityand to perform in-line editing of process data. You can add or update packages or changevariables for the current instance in the process. Click the Refresh Process Data buttonto 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 andclick the link to View Content. The debugger will display the content in theappropriate editor or application in another window.

Note: Changes made to the package attributes in the debugger are saved to therepository and overwrite the existing package attribute data. Changes made to processvariables are only kept on the local system for the life of the debug process. They will notbe 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 theprocess. These messages include when the workflow was started, which workitems werecreated, acquired, completed, if an email notification was sent, and so on. The Consoletab 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 displaysthe message from the service.

• For inbound messages, the Input Messages text box represents the message receivedby the process from the external service and the Output Messages text box is themessage sent from the process to the service.

For HTTP and web service protocols, the message is a close approximation of themessage that is transmitted over the network. For other services, the message uses XMLformat 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 systemwhere the content is stored. Once the workflow has completed in the debugger, thefile 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 textbox of the Task Manager tab for any automatic activities that use messaging.

Using the Manage Workow tab

The Manage Workflow tab enables you to send an event to the workflow in order tocomplete a task or continue debugging the process.

The name must match the name of the event that the workflow is waiting for (specifiedon the Trigger tab of the waiting activity in the workflow).

To send an event to the workow: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 areorganized in a tree structure that reflects the type of task each one represents. For example, theContent Services node has activity templates related to basic content management functions, and theIntegration node has templates for activities that send workflow process data to external participantsusing the messaging features of Documentum Process Integrator.

You can create custom activity templates to supplement the delivered templates. See Creating activitytemplates, page 106. Process Builder includes a Sample Activity Template that illustrates the formatof the activity template XML file to help you create custom activity templates. It appears on theSample activity node.

This appendix describes each of these activity templates and the special parameters they require youto type when creating an activity from them. The standard activity templates are:

Content Services, page 179• BOF Module, page 179• Create Folder, page 181• ECIS (Enterprise Content Integration Services) Search, page 182• Invoke Process, page 183• Lifecycle, page 184• Lifecycle Apply, page 186• Link To Folder, page 186• New Case from Template, page 187Flow , page 188• Decision Split, page 188• Join, page 189• Post Event to Parent Process, page 190• XSL Transformation, page 190Integration , page 191



• Create ACL (access control list), page 192• Create iCalendar Event , page 194• DB Inbound — Initiate and Step, page 195• DQL Inbound — Initiate and Step, page 197• DQL Read, page 198• DQL Write, page 199• Database Read, page 200• Database Stored Procedure, page 202• Database Write, page 205• Dynamic Web Service, page 207• Email Inbound — Initiate and Step, page 216• FTP Inbound — Initiate and Step, page 217• FTP Outbound, page 220• FTP Read , page 222• Fax Outbound, page 223• HTTP Inbound — Initiate and Step, page 226• HTTP Outbound, page 229• JMS Inbound — Initiate and Step, page 230• JMS Outbound, page 232• Process Data Mapping, page 234• SMTP Activity Template, page 235• WS Inbound - Initiate and Step, page 237• Web Service, page 240• xPression Publish Document, page 241• xPression Publish Document — Advanced , page 242

Note: Inbound activity templates require the BPS.war file to be deployed on the application server.

Sample, page 245• Set Queue Task Skill, page 246• Queue Task Rework Decision, page 245Deprecated activity templates, page 247

• FTP, page 249• HTTP Post, page 250• Lifecycle Demote, page 251• Lifecycle Promote, page 251• Observation Point, page 247



• Publish to JMS Topic, page 252• Send to JMS Queue, page 254• Send to MQ JMS, page 254• SMTP, page 252• Start Sub-Process, page 255

Content ServicesThe activity templates in the Content Services window enable you to include basiccontent management tasks in your business processes.

Activities based on these templates display only three tabs in the Activity Inspector: thePerformer tab (which identifies the workflow method to run), the Definition tab, and acustom tab. The other standard Activity Inspector tabs are not relevant for contentservices activities.

The activities in the Content Services window are:

• BOF Module, page 179• Create Folder, page 181• ECIS (Enterprise Content Integration Services) Search, page 182• Invoke Process, page 183• Lifecycle, page 184• Lifecycle Apply, page 186• Link To Folder, page 186• New Case from Template, page 187

BOF Module

Activities based on this template run a Java method that has been packaged as a moduleusing Documentum’s Business Object Framework (BOF). You use the data mapping toolto provide values for the method’s input parameters and to map any return values intopackage attributes so that they are available to subsequent activities.

Note: The data type of the parameters and the return value must be a Java primitivetype, Byte[] (and/or byte[]), a DataSource object, or a JavaBean object. BLOB (BinaryLarge Object) and binary data are represented as Byte Array. Char data type is notcurrently supported.



For information about packaging a Java method as a BOF module, see the DocumentumFoundation Classes Development Guide.

To congure 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 theBOF Module box. Process Builder populates the Interface andMethod listboxes 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 onthe current page.

5. If the selected method has input parameters, provide values for the parametersusing the data mapping tool.On the Input Message Mapping screen, the right column of the data mappingtool shows the input parameters for the method. The left column shows packageattributes and the workflow substitution variables. You can map the value of thedata attribute of a package as an input argument for a method as Byte[] (and/orbyte[]). You can also map the entire content, that is, data and content-type, of apackage to a DataSource. See Understanding the data mapping tool, page 147 fordetails about using the data mapping tool.If the selected method does not have input parameters, the Input Message Mappingscreen 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 mappingtool shows the output values from the method. The right column shows packageattributes.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 contentto 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 thepackage.See Understanding the data mapping tool, page 147 for details about using the datamapping tool.

8. Click OK or Apply to save the configuration settings.At runtime, if the destination package exists, the data attribute value of the packageis replaced by the data from the DataSource or Byte[] (and/or byte[]). In case ofDataSource, the format attribute value of the destination package is replaced by theformat value of the DataSource. If the destination package does not exist, a newpackage is created. The data and format of the source package is copied to the newpackage. However, if the source package does not have a format mapping, then thevalue for the format attribute in the destination package is set to "crtext".

Create Folder

Activities based on this template create a new folder in the repository based on a givenfolder name or on a folder template. To configure the activity, you provide a name forthe new folder and specify the path to the location in the folder hierarchy where youwant to create it.

• New Folder Name — Type name of the new folder. The name can includesubstitution variables. Click the ... button to display a dialog box from which youcan select from the available variables.

• Create From Folder Template (optional) — Select a predefined folder templatefrom the repository. The folder template enables you to create a copy of the folderincluding nested folders, with the root name of the folder template used as the newfolder name.

• Destination Folder — Click the ... button to navigate to the parent folder in which thenew folder will be created. When you click OK in the dialog box, the name of theparent folder appears in the data field.

• Or Type In Path To Folder — Enter the full path to an existing parent folder inwhich the new folder will be created, starting with a backslash and the name of thetop-level cabinet (for example, /System/Workflow). When you type the folder pathrather than selecting it, you can include one or more substitution variables in thepath specification. Click the ... button to display a dialog box from which you canselect from the available variables, including package variables.

• Link Folder to Package — Link the entire folder to the package that you select fromthe drop-down list.



ECIS (Enterprise Content Integration Services) Search

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, andso on, and are saved in the ECIS Search Results folder and are displayed in the orderspecified 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 FileNetand Open Text servers, external websites, and other Documentum repositories thatECIS adapters are able to access.

A pre-configured ECIS search is executed based on the Name keyword automatically inthe 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 DocumentumECI 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 aresearching or click the ellipsis (...) button next to the field to select a pre-configuredsearch 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 toa 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 rankingpercentage that the system saves. For example, to save results that match 50% to100% of the search criteria, type .5. To save search criteria that meets at least 20% ofthe search criteria, type .2



Invoke Process

An Invoke Process activity launches a new workflow. The activity is complete when thenew 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. Topause the current workflow until the process completes, define the next activity so thatit triggers in response to an event (on the Trigger tab) and include in the other processan activity, based on the Post Event to Parent Process activity template, that posts theevent the parent process is waiting for.

Before configuring an Invoke Process activity, you must select the user to serve as theworkflow supervisor for the new workflow.

To congure 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 theselected template must match packages from the current workflow in both name andtype. 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 ofthe process with the same workflow ID.

4. Click Next.

5. If the child process has packages, provide values for the packages using the datamapping tool.On the Input Message Mapping screen, the left column of the data mapping toolshows the packages of the parent process. The right column shows the packages ofthe child process. If there is more than one package in the process, you must mapthe 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 attributemust be String data type. If you do not select the supervisor, then the supervisorof the parent process is used. While mapping, the packages of the activity must beof the same package type or a super type of the packages of the parent workflow.See Understanding the data mapping tool, page 147 for details about using the datamapping tool.

6. Click Next.

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 toolshows 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 packageattributes of the parent process.See Understanding the data mapping tool, page 147 for details about using the datamapping tool.


LifecycleNote: This activity template is only supported for Documentum Process Builder version6.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 move the object’s lifecycle to another state. Fourlifecycle 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 lifecyclestate of the object.Hints for the required and optional mappings for each lifecycle appear on theconfiguration page for you to reference.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.Understanding the data mapping tool, page 147 provides procedures for using thedata mapping tool.Using repeating attributes, page 156 provides details on adding and mappingrepeating-valued attributes.Mapping package attributes, page 149 provides instructions for exposing othersource attributes of a package that do not currently appear in the tree

Table 11. Lifecycle template mappings

Operation Requirement Description

Promote Required r_object_id identifies the object to be promoted.



Operation Requirement Description

Optional state identifies the desired target state. Thedefault is the next state.

Optional override_entry_checks set to true will ignorethe configured lifecycle state entry checks.(Each lifecycle state has a set of entry criteriathat a document normally must meet in orderto be promoted to that state.) The default isfalse.

Demote Required r_object_id identifies the object to be demoted.

Optional state identifies the desired target state. Thedefault is the previous state.

Optional demote_to_base_state set to true to forcedemotion to base state. The default is false.Supersedes state.

If both the state and the demote_to_base_stateare mapped, then demote_to_base_statesupersedes the state mapping.

Suspend Required r_object_id identifies the object to besuspended.

Optional state identifies the desired target state (defaultis the suspended state associated with thecurrent state).

Optional override_entry_check set to true to ignoreconfigured lifecycle state entry checks (defaultis false).

Resume Required r_object_id identifies the object to be resumed.

Optional state identifies the desired target state (defaultis the resumed state associated with the currentstate).

Optional override_entry_checks set to true to ignoreconfigured lifecycle state entry checks (defaultis false).

Optional resume_from_base_state set to true to forcemoving object to base state (default is false).Supersedes state.

Optional If both state and resume_from_base_stateare mapped, then resume_from_base_statesupersedes the state mapping.



Lifecycle ApplyNote: This activity template is only supported for Documentum Process Builder version6.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 businessprocess. A lifecycle defines an ordered series of states that correspond to the stages ofa document’s life.

To configure a Lifecycle Apply activity, you choose the lifecycle to apply and whichlifecycle will be applied to the process data. You also specify the initial state of thelifecycle 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 theselected lifecycle.This is the key to the dm_alias_set type for retrieving the alias value mappingdefined there. The values in the drop-down list box 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 tothe object.

Required mapping — The following parameters must be mapped to process data:• r_object_id identifies the object to which the lifecycle is applied.

Link To Folder

Activities based on this template add the objects from one or more packages into aspecified folder in the repository. To configure the activity, you specify the name andlocation 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 intothe 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 inwhich the new folder will be created, starting with a backslash and the name of thetop-level cabinet (for example, /System/Workflow). When you type the folder pathrather than selecting it, you can include one or more substitution variables in thepath specification. Click the ... button to display a dialog box from which you canselect from the available variables, including package variables.



• Link Folder to Package — Link the entire folder to the package that you select fromthe drop-down list.

• Package(s) — Click the ... button to display a dialog box from which you can selectthe 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 itto the list of selected packages on the right. When you clickOK in the dialog box, thenames of the selected packages appear in the data field.

• New Folder Name — Type name of the new folder. The name can includesubstitution variables. Click the ... button to display a dialog box from which youcan select from the available variables.

• Create New Folder If Not Exists — Select Yes to have the system create a folder withthe specified name if it does not already exist.

• Create From Folder Template (optional) — Select a predefined folder templatefrom the repository. The folder template enables you to create a copy of the folderincluding nested folders, with the root name of the folder template used as the newfolder name.

• Destination Folder — Click the ... button to navigate to the parent folder in whichthe new folder will be linked. When you click OK in the dialog box, the name of theparent folder appears in the data field.

• Or Type In Path To Destination Folder — Enter the full path to the parent of thefolder into which the contents will be linked, starting with a backslash and the nameof the top-level cabinet. When you type the folder path rather than selecting it, youcan include one or more substitution variables in the path specification. Click the ...button to display a dialog box fromwhich you can select from the available variables.

• Unlink From Original Folder(s) — Select Yes to have the activity move the packagesinto the specified folder, unlinking them from other folders or select No to copy thepackages 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, selectthe package to attach it to from the list box.

New Case from Template

Use the New Case from Template activity template to create a folder and its contents froma pre-defined template. This folder can be included in the process either as an attachmentor as a package with the contents of the folder displaying in Documentum TaskSpaceor Webtop. For example, you can use the New Case from Template activity template tocreate a folder that contains sub-folders and associated documents. You can then use thedata mapper to set some of the attributes of those documents based on process data.



To congure a New Case from Template activity template:1. On the Create Folder tab, navigate to and select the folder template from the

repository that will be used to create the new folder and its contents.

2. Click Next to use the Input Mapping page to map the folder attributes to the processdata. This includes all the custom attributes that can be set when the template youhave selected is a sub-type of dm_folder.

Required mapping — The following parameters must be mapped to process data:• object_name maps to the name of the new folder.• r_folder_path maps to the location of the new folder.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using


repeating-valued attributes.• Mapping package attributes, page 149 provides instructions for exposing other

source attributes of a package that do not currently appear in the tree.3. Click Next to use the Output Mapping page to attach the new folder and its contents

as a package or attachment to the process.

FlowYou use the activity templates on the Flow node to control the flow of work through thebusiness process. The activities on the node are:

• Decision Split, page 188• Join, page 189• Post Event to Parent Process, page 190• XSL Transformation, page 190

Decision Split

The Decision Split activity template enables you to display decision points explicitly in abusiness process template. Rather than specifying the branching logic on the Transitiontab of an activity that performs some other action, you add an activity whose only actionis to evaluate the branching logic and forward packages as appropriate. Separating thedecision 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 DecisionSplit activity and set its transition to Select all connected activities. Set the branchinglogic on the Transition tab of the Decision Split activity.

The Decision Split activity template does not include any custom tabs or fields. Whenyou 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 thesettings relevant to a decision point activity.

Note: The system uses the dm_bpm_noop_method to connect to the repository andcomplete the activity rather than launch a method at runtime.

Join

The Join activity template enables you to include activities to evaluate trigger conditionswhen multiple flows converge in a business process. Rather than specifying the triggerconditions on the Trigger tab of an activity that performs some other action, you add anactivity whose only action is to evaluate the trigger conditions and forward packages asappropriate. The Join activity waits for a certain number of its preceding activities tocomplete, then forwards its packages to the next activity. The next activity does not needto 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 viewan 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 toa join activity.

Note: The system uses the dm_bpm_noop_method to connect to the repository andcomplete the activity rather than launch a method at runtime.

Post Event to Parent Process

Activities based on the Post Event to Parent Process template work in conjunction withInvoke Process activities to enable synchronous sub-processes. A parent workflowlaunches a new sub-process using a Invoke Process activity, then waits for a particularevent to be posted to it before continuing. The child sub-process uses a Post Event toParent 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 namemust match the name of the event that the parent workflow is waiting for (specifiedon 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 transformationon an XML file. An activity based on this template retrieves XML content from aworkflow package, applies an XSL file to it, then attaches the transformed file as anotherworkflow package.

• Transform content in package — The name of the workflow package that containsthe XML content.



• Transform using this XSL file — Click the button next to the field to select the XSLfile to use for transforming the XML content. The XSL file must be stored in therepository.

• Attach result as content in package — The name of the workflow package into whichthe transformed content is written. You must specify a valid package defined for theprocess.

• Transformed output format — Specifies whether to save the transformed output inXML or HTML format.

IntegrationThe activity templates in the Integration window provide means of exchanging databetween the business process and external systems or external performers. Several ofthe templates provide a wizard-like interface for defining how data is passed from onedata source to another.

Note: Inbound activity templates require the BPS.war file to be deployed on theapplication server.

The activities on the Integration node are:

• Create ACL (access control list), page 192• Create iCalendar Event , page 194• DB Inbound — Initiate and Step, page 195• DQL Inbound — Initiate and Step, page 197• DQL Read, page 198• DQL Write, page 199• Database Read, page 200• Database Stored Procedure, page 202• Database Write, page 205• Dynamic Web Service, page 207• Email Inbound — Initiate and Step, page 216• FTP Inbound — Initiate and Step, page 217• FTP Outbound, page 220• FTP Read , page 222• Fax Outbound, page 223• HTTP Inbound — Initiate and Step, page 226• HTTP Outbound, page 229• JMS Inbound — Initiate and Step, page 230



• JMS Outbound, page 232• Process Data Mapping, page 234• SMTP Activity Template, page 235• WS Inbound - Initiate and Step, page 237• Web Service, page 240• xPression Publish Document, page 241• xPression Publish Document — Advanced , page 242

Create ACL (access control list)

Use the ACL activity template to create a Documentum ACL object from an ACLtemplate and apply it to objects within a process instance. The ACL template mustalready exist within the repository and must have been created to include placeholdersor aliases for users and groups. The system uses the Create ACL activity template tosupply values for these placeholders and aliases based on process data and creates a newACL object from the template after resolving the aliases.

For example, using Documentum Composer, you can create an ACL template for acustomer case that enables a supervisor to have write and delete permissions for apackage, while the processor for the case has only write access. An ACL template canhave different aliases for users and groups and can grant them different permissions.You can also create separate ACLs for departments that require different permission setsfor its users and groups.

To congure an ACL activity based on an ACL template:1. In the Choose ACL Template field, select an ACL template that exists within the

repository.

2. Click Next to map process data to the attributes of the ACL template.Required mappings

The following attributes must be mapped to process data:• acl_name is the name of the new ACL object.• acl_domain is the owner of the new ACL object.



• acl_class indicates the type of ACL.

Valid values are:

— 0: Private ACL

Private ACLs are ACLs that are available only to the users who create them.Only the owner of a private ACL or a user with Superuser privileges canmodify or delete the ACL.

— 3: Public ACL

Public ACLs are ACLs that are available for anyone in the repository touse. Only the owner of a public ACL or a user with Sysadmin or Superuserprivileges can modify or delete the ACL.

• %grpcat, %Usercat, and %usrgrpcat are the individual alias names for group,user, and user or group categories. Map these values to the correct user or groupname values in the process data.

For more information on how the Content Server resolves aliases, see theappendix on aliases in Content Server Fundamentals Guide.

Note: Aliases belonging to categories such as permission set, cabinet path, andfolder path are not supported for this action in the data mapper.

You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using



source attributes of a package that do not currently appear in the tree.3. Click Next to map the output ACL parameters to the process data. This applies

the ACL to the package or attachment.Required mappings

The following attributes must be mapped:• r_object_id is the object ID of the new ACL object.

acl_domain is the owner of the new ACL object.

acl_name is the name of the new ACL object.



Create iCalendar Event

The Create iCalendar Event activity template enables you to create a calendar dataexchange (.ics) file that can be used to create a calendar event or meeting in any client thatsupports iCalendar file types. The activity template creates the file based on the inputmappings that you assign to values in the .ics file. You can then send this file to recipientsor attendees using an SMTP activity template or an HTTP Outbound activity template.

The activity template supports only iCalendar events (VEVENT).

This activity template does not write the calendar event to process data. That is, if theevent is rescheduled or cancelled from an external client, the process data does notget updated with the changes.

Note: The Create iCalendar Event activity template does not support the TaskSpacebusiness calendar feature. The activity creates the ICS file based on a standard calendar.

To create an iCalendar event le:Note: The Create iCalendar Event activity template does not have a configuration page.

1. Use the data mapper tool to associate process data with the calendar file attributes.Optional mappings

The following attributes can be mapped to process data:• Associate an existing UID from the process data to the uid in the destination

calendar attributes to update an existing calendar event. To update an existingevent with new information, use the existing identifier as the UID for the file.This will change the event when the ICS file is sent out in a subsequent activity.The system uses the existing UID to locate and update the existing calendarevent.

If the UID is not mapped to a value, the method server generates one and thesystem assigns it to the ICS file. When the ICS file is created, the method servergenerates a unique identifier for the event.

• Associate any other process data with the attributes of the calendar.

The Internet Calendaring and Scheduling Core Object Specification (iCalendar)published by the Internet Engineering Task Force (IETF), provides detailedinformation about the different properties of the iCalendar file.



repeating-valued attributes.



• Mapping package attributes, page 149 provides instructions for exposing othersource attributes of a package that do not currently appear in the tree.

2. Click Next to attach the calendar invitation file to the process data as a packageor an attachment.

DB Inbound — Initiate and Step

Use the DB (database) Inbound activity template to retrieve rows from a database tableor view and create workflows or complete an activity. The system creates a listener atruntime 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 toensure that it not processed multiple times.

For example, a company has a database application that queries an inventory table tofind items that need restocking. The DB Inbound activity can query the table of itemsthat need restocking and in order to start a purchase order process for the required items.

The DB Inbound activity template fetches records from one table or one view only. Eachrow starts a new process instance or completes a step activity. Each record must havecolumns that can be used to uniquely identify the record. In addition, one row in thedatabase must correspond to only one event. For example, if an expense report hasseveral line items associated with it, they must be stored in a separate table.

To congure the DB Inbound activity template:1. Open the DB 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 connectingto the database.The expected syntax of the connection string appears below the box when you selectthe 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 youprovided in steps 2 through 4, a message appears in green below the ConnectionString 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 immediatelybelow the text box containing the query.If the query is not valid, the message is the error message from the database. Revisethe query to make it valid.

8. For step activities only, select a column name as the Correlation ID for the system touse to match the retrieved data to the workflow.The column contains the appropriate correlation ID related to the specific workflowinstance.A correlation ID is a unique string associated with each process instance and can beused to identify a workflow and match the message to it. The correlation ID mustbe set in a preceding activity such as a Database Write activity. Using correlationidentifiers, page 162 provides instructions on using correlation in messages.

9. Type a SQL delete or update statement as the Statement to Postprocess that willmark the records as processed.To create a query using parameters with values that come from package attributes orruntime workflow variables, type a question mark (?) where you want the value tobe substituted. The question mark represents a parameter whose value the activitywill insert at runtime.For example, a query that updates a customer record based on Social SecurityNumber (after processing the record) includes a question mark in place of a specificSSN value:UPDATE from CUSTOMER WHERE ssn=?

The Update statement can include any number of parameters, each representedby a question mark. Each parameter must be mapped to process data on the datamapping page. Do not include quotes around the question mark.

Note: Ensure that row can be uniquely identified during post-processing so thatthe system only processes a single row.

10. For queries that include substitution parameters, identify the alias name/columnname 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 ofparameters corresponding to the number of question marks in the query. Theparameter 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 nameor column alias for the parameter from the list box. The column name or columnalias of the parameter must match the corresponding database column to whichthe 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 driverwhen more rows are needed for processing during each polling cycle.

12. Type the number of seconds used as the Polling Frequency after which the systemchecks the table for new records.

13. Type the Number of Processors to set the number of threads processing the recordsconcurrently.

14. Click Next to map the data from the result set to the process data model.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using



source attributes of a package that do not currently appear in the tree.15. Click OK or Apply to save the configuration settings.

DQL Inbound — Initiate and StepNote: This activity template is only supported for Documentum Process Builder version6.5. If an earlier version of Process Builder is used against a Documentum 6.5 repository,this template will not open.

Use this template to process objects located within a Documentum repository. Whenthe system fetches a new object, it creates a new process instance or uses the object tocomplete a running activity or workitem.

In a DQL Inbound activity, a listener is configured to listen to an inbound process. Whenthe listener starts up, the system creates a poller thread that executes the DQL select querythat you specify in the DQL qualification. The poller queries the repository for any newobjects 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 delegatesthe object to the post processor, which performs the specified option on the object.

To congure a DQL Inbound activity:1. In the Activity Inspector, click the DQL Configuration tab.

2. Select the option to Connect to different Repository if you are accessing informationfrom 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 tothrough the dfc.properties configuration file.

4. If you have chosen to connect to a different repository, type the User Name requiredto connect to the repository.

5. If you have chosen to connect to a different repository, type the Password required toconnect to the repository.

6. Click the Test Connection button to verify that the connection parameters havebeen entered correctly.If the connection is unsuccessful, a red message appears below the text box. Modifythe 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 thatbegins with the keyword FROM. The DQL qualification uniquely identifies an objectin 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 belongingto 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 objectto 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 thearchive folder.

12. If you have selected to update attribute values, type the query to update the objectattributes 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 andfetches 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 thisend-point.

15. Click Next to map the objects to process data attributes.

DQL ReadNote: This activity template is only supported for Documentum Process Builder version6.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 execute DQL queries on the specified repository. Forexample, you can use the DQL Read activity template to select a loan document fromthe repository that was submitted between a range of dates or based on a loan amountor credit score.

To congure a DQL Read activity template:1. In the Activity Inspector, click the DQL Configuration tab.


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 tothrough the dfc.properties configuration file.




7. Type the Query to Run in the text box.To create a query that uses placeholder values, type a question mark (?) where youwant the value to be substituted. The question mark represents a parameter whosevalue the activity will insert at runtime.

8. Click the Set Parameter Type button to select a data type for the parameter youspecify in the DQL query.


10. ClickNext to use the data mapper to map process data to the parameters of the query.

DQL WriteNote: This activity template is only supported for Documentum Process Builder version6.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 execute create, update, or delete object DQL queries onthe specified repository. For example, you can use the DQL Write activity template to seta credit score in a loan document that is in the repository.



To congure a DQL Write activity template:1. In the Activity Inspector, click the DQL Configuration tab.


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 tothrough the dfc.properties configuration file.




7. Type the Query to Run in the text box.To create a query that uses placeholder values, type a question mark (?) where youwant the value to be substituted. The question mark represents a parameter whosevalue the activity will insert at runtime.

8. Click the Set Parameter Type button to select a data type for the parameter youspecify in the DQL query.


10. ClickNext to use the data mapper to map process data to the parameters of the query.

Database Read

Activities based on this template connect to an external database and return the results ofa SQL Select statement. The database read activity also supports exchange of contentfrom BLOB data type in Oracle, and Bytes data type in Microsoft SQL Server, to apackage.

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 andspecify 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 intopackage attributes.

To congure a Database Read activity:1. In the Activity Inspector, click the Database Configuration tab.





6. Type the Select statement in the Query to Run box.The statement must start with the SQL keyword Select. To create a query usingparameters whose values come from package attributes or runtime workflowvariables, type a question mark (?) where you want the value to be substituted. Thequestion 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 Securitynumber 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 aquestion mark. Do not include quotes around the question mark.

7. For queries that include substitution parameters, identify the data type for eachparameter.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 ofparameters corresponding to the number of question marks in the query. Theparameter names are param1, param2, and so on.


c. Click the value in the Data Type column and select the data type for theparameter from the list box. The data type of the parameter must match thedata type of the corresponding database column. For an Oracle database, selectBLOB as the data type. For Microsoft SQL, select Binary as the data type ofthe parameter.





8. Click the Validate Query button.Process Builder checks the validity of the query and displays a message immediatelybelow the text box containing the query.If the query is not valid, the message is the error message from the database. Revisethe query to make it valid.

9. Click Next.The Next button is unavailable until you have typed values for all required fields onthe current page.

10. If the query has substitution parameters, provide values for the parameters usingthe data mapping tool.On the Input Message Mapping screen, the right column of the data mapping toolshows the substitution parameters in the query. The left column shows packageattributes and the workflow substitution variables. See Understanding the datamapping tool, page 147 for details about using the data mapping tool.If the query does not include any substitution parameters, the Input MessageMapping 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 toolshows 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 ofthe package. See Understanding the data mapping tool, page 147 for details aboutusing the data mapping tool.If the query returns more than one row of data, the activity maps the values from thefirst returned row into the associated package attributes.


Database Stored Procedure

Activities based on this template connect to an external database, and run a storedprocedure or function. To define the activity, you identify the JDBC driver to use toconnect to the database, and specify the stored procedure or function to run. You use thedata mapping tool to provide values for any IN and IN/OUT parameters of the storedprocedure. The activity returns the values for OUT and IN/OUT parameters or the resultset 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 congure a Database Stored Procedure activity:1. In the Activity Inspector, click the Database Configuration tab.





6. In the box provided for entering the stored procedure or function name, typethe name of the stored procedure or function. You may optionally type the fullyqualified 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 forthe 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 orfunction. The stored procedure or function name is case-sensitive, and can bea fully qualified name. You may also use the % wildcard to search a storedprocedure or function. For more information on using the % wildcard, clickWhat’s this?.

c. Click Find.Process Builder will search for the stored procedure or function across allschemas and packages in the database, and retrieve the fully qualified procedureor 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 schemaalong with the stored procedure name, such as STANDARD.SYS.CALCULATE_TAX.Refer to Example Search Patterns, page 204 for information on using differentsearch patterns.

d. Select the stored procedure or function from the list box.When you select a stored procedure or function from the list box, additionalinformation, such as the input parameters and return value, of the selectedstored 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 theparameters using the data mapping tool.On the Input Message Mapping screen, the left column displays the packageattributes, and the workflow substitution variables. The right column of the datamapping tool displays all the IN and IN/OUT parameters of the stored procedure, orthe function arguments. If there is more than one input parameter, and you maponly one parameter, the other parameters are set to NULL or as defined in the storedprocedure or function. See Understanding the data mapping tool, page 147 fordetails 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 aspackage attributes.On the Output Message Mapping screen, the left column of the data mapping toolshows the OUT and IN/OUT parameter values or result set returned by the storedprocedure, or the return value of the function. The right column shows the packageattributes. See Understanding the data mapping tool, page 147 for details aboutusing the data mapping tool.


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 storedprocedure or function you type using the following format:

<procedure-name>

For example, if you search for the stored procedure name ADD_EMPLOYEE, thebusiness service retrieves the ADD_EMPLOYEE stored procedure along with the catalogand schema name, such as STANDARD.SYS.ADD_EMPLOYEE. If you search for ADD_,the business service retrieves all stored procedures or functions beginning withthe name ADD_.

• Fully qualified name— finds only occurrences of the stored procedures or functionsthat 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, thebusiness process service retrieves the stored procedure WRITE in the schema ORDSYSfrom the ORDSOURCE catalog. The WRITE stored procedure available in any othercatalog or schema will not be retrieved.

If you search for SCOTT.ADD_EMPLOYEE, the business service retrieves theADD_EMPLOYEE stored procedure from the SCOTT schema.

• % wildcard— searches stored procedures or functions across all catalogs andschemas 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 theschema named "A"

— C.A.B%— retrieves all stored procedures whose name begins with "B" in theschema "A" from the catalog "C"

— A%.B%— retrieves all stored procedures whose name begins with "B" from anyschema 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 ofcontent from a package to database parameters. That is, you can insert or update binaryor 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 databaseand specify the statement to run. You use the data mapping tool to provide values forany substitution variables in the SQL statement. The activity returns the number ofrows created or updated.

To congure a Database Write activity:1. In the Activity Inspector, click the Database Configuration tab.





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 packageattributes or runtime workflow variables, type a question mark (?) where youwant the value to be substituted. The question mark represents a parameter whosevalue the activity will insert at runtime. For example, a statement that updates acustomer’s last name based on a Social Security number includes a question mark inplace of a specific SSN value:Update CUSTOMER Set Lastname='Smith' where ssn=?

The SQL statement can include any number of parameters, each represented by aquestion mark. Do not include quotes around the question mark.

7. For SQL statements that include substitution parameters, identify the data typefor 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 parameterscorresponding to the number of question marks in the query. The parameternames are param1, param2, and so on.




c. Click the value in the Data Type column and select the data type for theparameter from the list box. The data type of the parameter must match thedata type of the corresponding database column. For an Oracle database, selectBLOB as the data type. For Microsoft SQL, select Binary as the data type ofthe parameter.



8. Click Next.The Next button is unavailable until you have entered values for all required fieldson the current page.

9. If the SQL statement has substitution parameters, provide values for the parametersusing the data mapping tool.On the Input Message Mapping screen, the right column of the data mappingtool shows the substitution parameters in the SQL statement. The left columnshows package attributes and the workflow substitution variables. If you use BLOBdata type, you must map the BLOB content as a data attribute of the package. SeeUnderstanding the data mapping tool, page 147 for details about using the datamapping tool.If the SQL statement does not include any substitution parameters, the InputMessage 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 packageattribute value.On the Output Message Mapping screen, the left column of the data mapping toolshows the single values returned by the SQL statement: the number of rows insertedor updated. The right column shows package attributes. See Understanding the datamapping tool, page 147 for details about using the data mapping tool.


Dynamic Web Service

Activities based on this template run a web service operation. Unlike the Web Servicetemplate, this activity template enables you to interactively map data between businessprocess attributes and the web services parameters. This activity template supportsboth 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 208• Invoking secure Web Services, page 209

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 WSDLfile that contains the operation you want to run.

3. Click Read WSDL File.Process Builder reads the specified WSDL file and populates the remaining fieldson 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 validWSDL file. It is also unavailable if you have not yet specified any packages for thebusiness process, or if the selected web service operation has no input parametersor return values.

7. If the selected web service operation has input parameters, provide values for theparameters using the data mapping tool.On the Input Message Mapping screen, the right column of the data mapping toolshows the input parameters for the operation. The left column shows process dataand the workflow substitution variables. See Understanding the data mapping tool,page 147 for details about using the data mapping tool.If the selected web service operation does not have input parameters, the InputMessage Mapping screen does not appear. Skip to step 9.

8. Click Next.If the selected web service operation does not have output values, the Next button isunavailable. Skip the next step.

9. 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 toolshows the output values from the operation. The right column shows package



attributes. See Understanding the data mapping tool, page 147 for details aboutusing the data mapping tool.


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 authenticationBefore configuring a secure web service, you can configure the HTTP proxy server. Referto Configuring the HTTP proxy server, page 211 to configure a HTTP proxy server.

The following procedures describe how to configure web services protected by HTTPbasic authentication and SOAP header-based authentication.

To configure a secure web service activity, click the Web Service Configuration tab in theActivity Inspector.

If the web service being invoked is protected by HTTP basic authentication:1. 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.

2. Click Read WSDL File.Process Builder reads the specified WSDL file and populates the remaining fieldson 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 210.

If the web service being invoked is protected by SOAP header-basedauthentication:1. 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.



For example, if you use Documentum Web Services Framework (WSF), you can usethe following URL for repository credentials service:http://localhost:8080/ws/services/DocbaseCredentials?wsdlwhere,• 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 installed2. Click Read WSDL File.

Process Builder reads the specified WSDL file and populates the remaining fieldson the screen.



Note: Refer to the Documentum Web Services Framework Development Guide for moreinformation 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 210 to map SOAP-basedauthentication 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 stepsto configure the dynamic web service as described in Invoking secure Web Services,page 209.

To map the Web Service parameters:1. Click Next.

The Next button is unavailable until you have selected an operation from a validWSDL file. It is also unavailable if you have not yet specified any packages for thebusiness process, or if the selected web service operation has no input parametersor return values.

2. If the selected web service operation has input parameters, provide values for theparameters using the data mapping tool.On the Input Message Mapping screen, the right column of the data mapping toolshows the input parameters for the operation. The left column shows packageattributes and the workflow substitution variables. See Understanding the datamapping tool, page 147 for details about using the data mapping tool.



If the web service is protected by SOAP-header based authentication, you mustmap the security token and SOAP-secured parameters. If you use DocumentumWSF-based credentials service, you must map the values for the parameters basedon the type and operations of the credentials service.

Note: For more information on the types and operations of credentials service, referto Documentum Web Services Framework Development Guide.

If the selected web service operation does not have input parameters, the InputMessage Mapping screen does not appear. Skip to step 3.

3. Click Next.If the selected web service operation does not have output values, the Next button isunavailable. Skip the next step.

4. 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 toolshows the output values from the operation. The right column shows packageattributes. See Understanding the data mapping tool, page 147 for details aboutusing the data mapping tool.


Conguring 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 theProcess Builder shortcut and the Content Server Java Method Server startup parameter.The following sections describe how to configure the startup parameters on Windowsand UNIX-based systems.• Configuring HTTP proxy parameters in Windows, page 211• Configuring HTTP proxy parameters in UNIX-based systems, page 213

Conguring HTTP proxy parameters in Windows

This section describes how to configure HTTP proxy startup parameters on Windowssystems for the following:• Process Builder shortcut• Content Server Java Method Server

To congure 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 selectStart > Programs > Documentum, and right-click Process Builder and then selectProperties.

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 separatedby ’|’. Any host matching one of these regular expressions will be reachedthrough 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 separatedby ’|’. Any host matching one of these regular expressions will be reachedthrough a direct connection instead of through a proxy

3. Click OK.

To congure 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 theJAVA_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 serverport_number is the port number. The default is 80.



Conguring HTTP proxy parameters in UNIX-based systems

This section describes how to configure the Content Server Java Method Server startupparameter in UNIX-based systems.

To congure 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 theJAVA_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 serverport_number is the port number. The default is 80.

Invoking DFS (Documentum Foundation Services) services fromProcess 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 activitytemplate that performs a single invocation of a DFS web service.

• As a chained service, meaning that a process contains multiple Dynamic Web Serviceactivity templates that invoke DFS web services. The repository identity informationis registered to a token that each activity template uses.

Note: The Dynamic Web Services activity template supports only base64 for contenttransfers.

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 FoundationServices Development Guide.

2. On the Web Service Configuration tab of the Dynamic Web Services activitytemplate, 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.

5. Click Read WSDL File.

6. Click Next.

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

a. Map RepositoryName toSOAPEnvelope/SOAPBody/params/register/arg0/Identities[0}/@repositoryName

b. Map Username toSOAPEnvelope/SOAPBody/params/register/arg0/Identities[0]/@userName

c. Map Password toSOAPEnvelope/SOAPBody/params/register/arg0/Identities[0]/@password

d. Map Domain toSOAPEnvelope/SOAPBody/params/register/arg0/Identities[0]/@domain

Note: Identities is a repeating node. Multiple identities can be registered to asingle token.

8. Click Next.

9. In the Output Message Mapping page, the generated token is available inSOAPEnvelope/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 FoundationServices Development Guide.

2. On the Web Service Configuration tab of the Dynamic Web Services activitytemplate, 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.

5. Click Read WSDL File.

6. Click Next.



7. In the Input Message Mapping page, add the token that needs to be unregistered intoSOAPEnvelope/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 forauthenticating 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. TheDocumentum Foundation Services Development Guide provides more details on DFSfunctionality.

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:BinarySecurityTokenQualificationValueType="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:<ServiceContextxmlns="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 forauthentication.



Email Inbound — Initiate and Step

Email activity templates poll email servers for incoming messages and then process themaccording to the business logic you’ve specified. Within the Email Inbound activitytemplate, you define the connection to the email server, select options for processing themessage after it’s been read, and map data from the incoming message to the processdata that is used in the process.

For example, in a customer complaint business process, you can configure an inboundemail template as the initiate activity in the process. The activity polls the email serverand starts a new workflow when it receives a customer complaint email message. In thefollowing steps of the process, the system routes the email through a manual activity to aperson 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.

5. Click the Test Connection button to verify that the connection parameters havebeen entered correctly.

If the connection is unsuccessful, a red message appears below the text box. Modifythe values and try again.

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 theemail server and select one.

7. For step activities, you can enter an email message header name that includes acorrelation ID in the Correlation Header Name.

A correlation ID is a unique string associated with each process instance and can beused to identify a workflow and match the message to it.

Note: If the system cannot use the information in this field to match the messageto the workflow, it uses the mappings you create in Step 15 to match the responseto 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 EmailMessage.Valid options for IMAP servers are: Mark Email Message as Read,Delete EmailMessage, orMove 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 thearchive folder.

10. Type in the number of seconds that passes before the listener checks for newmessages.

11. Type the number of email sessions available to process email messages.

12. ClickNext to display the data mapping tool, where you can map the message data tothe process data.

You may find that you need to add attributes or elements to some of the data tocomplete the mappings.

• Understanding the data mapping tool, page 147 provides procedures for usingthe data mapping tool.

• Using repeating attributes, page 156 provides details on adding and mappingrepeating-valued attributes.

• Mapping package attributes, page 149 provides instructions for exposing othersource attributes of a package that do not currently appear in the tree.

13. Click Next to display the data mapping tool, where you can specify rules that matchcorrelation set attributes to message attributes.

14. Select the Correlation Set that you are mapping from the list at the top of the page.

Understanding message correlation, page 162 gives more details on using correlationsets to match messages from external sources to process data. Creating correlationsets, page 78 gives more details on defining correlation sets for a process.

FTP Inbound — Initiate and Step

FTP activity templates monitor for files and folders that are transferred to the designatedbase folders. For example, in a workflow that processes incoming purchase orders, youcan use this activity template to monitor the base folder for incoming purchase ordersthat are XML files. Based on the mapping, the system then initiates a process for everymatching 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, verifyconnectivity, 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 fileseither as data or as XML documents, when you provide an XML schema.

To congure 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, ifthe server requires authentication.

Note: The user must have sufficient privileges to perform the mandatory postprocessing operation configured in step 11.

5. In the Base folders field, type the path to the folders on the FTP server that willbe monitored.

6. In theMessage 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 folderpath have been entered correctly.

8. In the Included File/Directory Name Pattern field, type the variables for file typesand 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 filetypes and directory names you want to exclude from monitoringFor example, type sam* to exclude all files that begin with sam.

10. For step activities only, type the Correlation Patterns that provide the filenameformat that determines the correlation ID from the filename.For example, the file sam_956d77f734b6d7fb97771be.xml can be represented (usingdollar 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 placeholdertoken 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 requestand response messages, then the system uses the correlation ID and the mappingthat you define in Step 17.

11. Select one of the following Post Processing Options for managing the file after ithas 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 thename 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 thisend-point. It is based upon the number of supported concurrent connections forthe FTP server.

Note: The number of FTP Processors should be greater than or equal to 1. Thisnumber 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 fourtotal concurrent connections.

14. Type the number of minutes used as the Polling Interval after which the systemchecks for incoming files.For example, if the polling frequency is set to 45, the FTP server is polled every 45minutes 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.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using


repeating-valued attributes.• Adding an XML schema to activity content , page 151 provides instructions for

adding an XML schema to a message mapping.• Mapping package attributes, page 149 provides instructions for exposing other

source attributes of a package that do not currently appear in the tree.16. Click Next to display the data mapping tool, where you can specify rules that match

correlation set attributes to the FTP message attributes.



Understanding message correlation, page 162 gives more details on using correlationsets to match messages from external sources to process data. Creating correlationsets, page 78 gives more details on defining correlation sets for a process.

Note: The message must contain structured data to be able to map the correlationset attributes to the message attributes.

17. Select the Correlation Set that you are mapping from the list box at the top of thepage and configure the mappings for the activity.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.Adding an XML schema to activity content , page 151 provides instructions foradding an XML schema to a message mapping.

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 onfile-based transactions such as financial auditing processes.

To congure the FTP Outbound activity template:1. Select a Protocol for the message.

The supported standard protocols are FTP, SFTP (FTP over SSH), FTPS (FTP overSSL), 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, ifthe server requires authentication.

5. Type the path to the on the Base Foldermachine to which the files are uploaded.

6. Select theMessage 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 atruntime based on the archive name you configure in the data mapper, and thenplaced in the destination directory.



Directory, which places the files into sub-folders based on the destinationdirectory. The sub-folder name is determined at runtime based on the directoryname that you configure in the data mapper.

7. Click the Validate button to verify that the connection parameters have been enteredcorrectly.

Note: The validate button is not available for the Local File option. You mustmanually verify that the base folder exists on the machine where the Inboundactivity template is deployed.

8. To enable the system to overwrite an identical existing file (or sub-folder if you haveselected Directory in step 6), select Overwrite if exists.If left blank, the system gives the file a unique name by adding an incrementalnumber to the filename (or sub-folder) and does not overwrite the existing file (orsub-folder).

9. Click Next to map process data attributes to the FTP attributes.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using



adding an XML schema to a message mapping.• Mapping package attributes, page 149 provides instructions for exposing other

source attributes of a package that do not currently appear in the treeBased on the file types that you have chosen, you must complete the followingmappings:• 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 Dataattributes must be configured, as well.

Note: The Content Type attribute mapping determines the mode in which data istransmitted to the FTP server. If it is mapped to any string text, it is transmitted asASCII text. All other files are transferred in binary mode.



FTP Read

Activities based on this template connect to an FTP server and return files or foldersbased upon criteria that you specify using process data. For example, an incomingXML file may reference an image file that is located on an FTP server and needs to bedownloaded. This activity template retrieves the file and associates it with the activity.

Note: This activity template differs from FTP Inbound in that the FTP Read activitytemplate uses the search criteria to retrieve the file when the work item is created. TheFTP Inbound is triggered when the search criteria is met.

To congure an FTP Read activity:1. Select a Protocol for the connection.

The supported standard protocols are FTP, SFTP (SSH FTP, FTPS (FTP over SSL),and Local File System.

Note: If you select Local File System, skip to step 5.

2. Type the Host name or the IP address of the FTP server.

3. Type the Port number for the connection.The default port for FTP and FTPS is 21.The default port for SFTP is 22.

4. Type the username and the password for the FTP server to which you are connection,if the server requires authentication.

5. In the Base Folder field, type the path to the folders on the FTP server that willbe read.

6. In theMessage Type field, select the option for the file downloads.Valid options are:• File, which enables the system to fetch a file.• Compressed File, which enables the system to fetch multiple files within an archive.• Directory, which enables the system to fetch multiple files within a folder.

7. Click the Validate button to verify that the connection parameters and bold folderpath have been entered correctly.

8. Click Next to provide the pattern or exact file or directory name to be fetched fromthe FTP server.

Required mappingsThe following attribute must be mapped to process data:• Namemust be mapped as the FTP server uses the configuration provided in the

Configuration page to look up the file or folder mapped to this attribute.






source attributes of a package that do not currently appear in the tree.9. Click Next to use the data mapping tool to specify rules to match attributes from

the downloaded file to the process data.

Fax OutboundNote: Captaris RightFax is not included in the Process Suite bundle and must bepurchased and licensed through Captaris. Refer to the Captaris RightFax documentationfor instructions on installing and configuring the RightFax server.

You must perform the following mandatory steps before using Fax Outbound ActivityTemplates:

1. Refer to the RightFax documentation to obtain the path to the RightFax Java API(RFJavaInt.zip).

2. Copy RFJavaInt.zip to the following path in the Method Server deploymentdirectory: bpm.ear\bpm.war\WEB-INF\lib.

3. Rename RFJavaInt.zip to RFJavaInt.jar.

4. Restart the Method Server.

5.Use the Fax Outbound activity template to send unidirectional messages to a CaptarisRightFax facsimile server. These messages can be fax requests sent from a process orthey can be queries that request the status of a single or multiple fax requests. Results ofthe 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 requestto the RightFax server.



Submit sends a fax request to the RightFax server. Query gets the status of a faxrequest 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 isaccessible from the activity template.

6. Click Next to map process data attributes to the fax request attributes.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using



source attributes of a package that do not currently appear in the tree.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 foundon 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 mostcases, the cover pages are located in the following location: C:\ProgramFiles\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:\ProgramFiles\RightFax\FCS.

Note: Facsimile cover pages must be created using specific criteria and must besaved to a designated location on the RightFax server. Refer to the CaptarisRightFax documentation for instructions on creating and saving facsimile coverpages.



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 theRightFax server. Check the RightFax documentation for details on manuallysetting 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 mayneed to adjust the value of theMethod times out in field on the Performer tab.

10. Click Next to map the RightFax server’s response to the process data associatedwith 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. MapMessage to the status message associated with the status code.

To submit a query request to the RightFax server using the Fax Outboundactivity template1. 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 afax 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 isaccessible from the activity template.

5. Click Next to map process data attributes to the Fax request attributes.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using



source attributes of a package that do not currently appear in the tree.



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 SheetFor a complete list of messages, refer to the RightFax documentation.

HTTP Inbound — Initiate and Step

Use the HTTP Inbound activity template to receive and process HTTP messages sent byan external client. You configure the HTTP Listener to listen for a specific URL suffixand then read and process incoming messages. The incoming message can be mappedto process data using the data mapper.

The system then sends a synchronous response back to the client using the response typethat you specify in the activity template.

To congure 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 Authenticationto 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 toaccess the activity. The request is sent again with the username and password inthe HTTP request. If authentication is selected and the username and passwordURL parameters are not sent, the inbound activity template will not allow accessto 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 haveattachments and some do not, selecting POST as the request type will still enableyou to send a GET request.

Note: If you are using the GETmethod, the fields used to specify request informationare 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. Thisattribute appears in the data mapper, located in the URL parameters node of theBody 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 requestto response messages. If there are correlation set values that are mapped, the systemuses 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 toprocess data.• Placeholders are prefixed with a dollar sign $ (for example, ${tokenname}).• 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 firstnon-alphanumeric character.

For example, to send a message indicating that a purchase order was processedsuccessfully, you would use the following template text: Purchase Order $ordernosuccessfully processed. The placeholder orderno appears in the data mapping screenand can be mapped to a package or process variable. The response sent will bea HTML page of consisting of the following message: Purchase Order 0896523successfully processed, where 0896523 is the substituted value from the response datamapping.

Note: All placeholder values must be mapped to process data.

10. Click Next to map the input request message to the process data.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.





• Adding message properties, page 150 provides instructions for adding aservice-specific property to a message in order to complete a mapping.


Depending on the types of protocol you’ve selected, complete the followingmappings:• 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 previousscreen.

• Messages using PUTmethods show mapping attributes for the header and onebody 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 bodyattributes. Any placeholder values appear in the data mapper enabling you to mapvalues to send in the response to the client.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using



adding an XML schema to a message mapping.• Adding message properties, page 150 provides instructions for adding a

service-specific property to a message in order to complete a mapping.• Mapping package attributes, page 149 provides instructions for exposing other

source attributes of a package that do not currently appear in the tree12. Click Next to use the data mapper to associate the request message attributes to the

correlation set you choose in the next step.

13. Select the Correlation Set that you are mapping from the list box at the top of thepage and configure the mappings for the activity.Understanding message correlation, page 162 gives more details on using correlationsets to match messages from external sources to process data. Creating correlationsets, page 78 gives more details on defining correlation sets for a process.





repeating-valued attributes.• Adding message properties, page 150 provides instructions for adding a

service-specific property to a message in order to complete a mapping.

HTTP Outbound

The HTTP Outbound activity template sends an HTTP request to a specified URL andcan receive a response back from the server. The fields in the activity template enableyou to specify data that can be mapped to the process data model.

To congure 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 ausername and a password.

Note: Only Basic authentication is supported in the HTTP Outbound activitytemplate.

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 GETmethod, the fields used to specify request informationare not available.


6. In the Connection Timeout (mins) field, type the number of minutes allowed beforethe system terminates an idle connection.

7. If youwant to include attachments in the request message, selectAllowAttachments.Attachments are only available for POST and PUT request types.

8. Click Next to map the process data to the request message.







source attributes of a package that do not currently appear in the treeMessages using GETmethods have no attachments, so only attributes for URLparameters and headers appear in the mapper.Messages using POST methods show mapping attributes for headers, bodyattributes, or attachments, if attachments have been enabled in the previousscreen.Messages using PUTmethods show mapping attributes for the header and onebody attachment, if attachments have been enabled on the previous screen.

9. Click Next to map the response message to the process data.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using





source attributes of a package that do not currently appear in the tree

JMS Inbound — Initiate and Step

JMS Inbound activity templates are used to receive and process JMS messages sent to aqueue or a topic. For example, in a claims processing workflow, a JMS initiate activitycan be configured to listen to a claims queue. The activity starts the workflow when amessage reaches the queue. The system then routes that data from the message to theintended destination.



You specify connection and processing options within the activity template and map themessage parameters such as JMS headers and other properties to the process data usingthe data mapping tool.

To congure 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. Thecontext factories for WebSphere, TIBCO, and WebLogic are available withProcess 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, ifnecessary.

e. Type an optionalMessage Selector query to use in filtering messages read bythe inbound listener based on the value of a particular property sent in the JMSmessage.For example, you can set up a filter for a particular vendor ID used in themessage and only those messages with that vendor ID will be processed bythis activity template.

f. SelectMessage Type.Valid values are Message, MapMessage, TextMessage, BytesMessage,ObjectMessage, and StreamMessage.

g. Click the Test Connection button to verify that the connection parameters havebeen entered correctly.If the connection is unsuccessful, a red message appears below the text box.Modify the values and try again.

3. Select Validate Schema to have the system check the validity of any XML schemas atruntime.

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. ClickNext to display the data mapping tool, where you can map the message data tothe process data for the input message.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using





source attributes of a package that do not currently appear in the tree6. Click Next to display the data mapping tool, where you can map message data

to the correlation sets.

7. Select the Correlation Set that you are mapping from the list box at the top of thepage and configure the mappings for the activity.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using

the data mapping tool.• Adding an XML schema to activity content , page 151 provides instructions for


service-specific property to a message in order to complete a mapping.• Understanding message correlation, page 162 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 correlationsets for a process.

JMS Outbound

Use the JMS Outbound activity template to enable Process Builder to send messages toan external application and then receive a response from that application. This templatecan send XML messages, binary messages, and messages in other structured formatssuch as .CSV files.



To congure 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. Thecontext factories for WebSphere, TIBCO, and WebLogic are available withProcess 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, ifnecessary.

e. SelectMessage Type.Valid values are Message, MapMessage, TextMessage, BytesMessage,ObjectMessage, and StreamMessage.

f. Click the Test Connection button to verify that the connection parameters havebeen entered correctly.If the connection is unsuccessful, a red message appears below the text box.Modify the values and try again.

3. Click Next to display the data mapping tool, where you can map the process data tothe message data for the input message.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using




source attributes of a package that do not currently appear in the tree4. Click Next to map the message response attributes to the process data for the output

message.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.






Process Data Mapping

Activities based on this template transfer data from one package in the business processto another package, or from one package attribute to another. You can also copy thecontents of a package to another package.

To congure 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 andright columns. The left column also includes the workflow substitution variables.

2. Use the data mapping tool to transfer values from packages or execution data toother packages or package attributes, or to copy the content from the package on theleft column to a package on the right column. You can also map repeating-valuedattributes.Package objects that have content associated with them have the following attributesdisplayed 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 contentTo 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 theformat 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. Inaddition, you may use the String To Byte or Byte To String functions that supportsconversion of content to String data type. See Using data mapping functions, page158 for more information on these functions.



See Understanding the data mapping tool, page 147 for details about using the datamapping tool, and Using repeating attributes, page 156 for details about mappingrepeating-valued attributes.

3. Click OK or Apply to save the configuration settings.At runtime, if the destination package exists, the content and format of the package isreplaced by the content and format of the source package. If the destination packagedoes 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 sourcepackage does not have a format mapping or content-type, then the value for theformat attribute in the destination package is set to crtext and the content-type astext/plain.

SMTP Activity Template

Use the SMTP activity template to send email messages with attachments to lists ofusers. For example, you can add an activity template that sends an email message as aresponse to a customer complaint or send an expense report in the body of the emailmessage for approval.

To congure 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 passwordfor 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 thatcan be mapped to process data.• Placeholders are prefixed with a dollar sign $ (for example, ${tokenname}).• Use two dollar signs $$ to create multi-valued placeholders.



• To use a literal dollar sign in the email body, use \$ (for example, five hundreddollars would be expressed as \$500.00).


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, andplaceholder parameters that can be mapped to process data.If you are including HTML markup in the email body, you must map the constantvalue text/html to the Content-Type in the Body node of the email message. IfContent-Type is not mapped to a value, the content-type is by default text/plain.• Placeholders are prefixed with a dollar sign $ (for example, ${tokenname}).• Use two dollar signs $$ to create multi-valued placeholders.• To use a literal dollar sign in the email body, use \$ (for example, five hundred



8. Click Next to create the input message mapping associating process data to theemail message.The email message structure appears in the right-hand pane and the process data onthe left-hand side. You can set values for email message attributes by mapping themfrom attributes of the process data model. If you have multiple email attachments,you can click Add on the Attachment node to add more attachments.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.Understanding the data mapping tool, page 147 provides procedures for using thedata mapping tool.Using repeating attributes, page 156 provides details on adding and mappingrepeating-valued attributes.Mapping package attributes, page 149 provides instructions for exposing othersource attributes of a package that do not currently appear in the tree

Note: At least one of the recipient nodes (To, Bcc, or Cc) must be mapped fromprocess data or a constant value. Additionally, all placeholder nodes under theSubject and Body nodes must be mapped at this point.

9. Click Next to map the output message.



For example, if you added a process variable emailMsgId, you can map the emailmessage ID attribute from the source message to that process variable.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.Understanding the data mapping tool, page 147 provides procedures for using thedata mapping tool.Using repeating attributes, page 156 provides details on adding and mappingrepeating-valued attributes.Adding an XML schema to activity content , page 151 provides instructions foradding an XML schema to a message mapping.Adding message properties, page 150 provides instructions for adding aservice-specific property to a message in order to complete a mapping.Mapping package attributes, page 149 provides instructions for exposing othersource attributes of a package that do not currently appear in the tree

WS Inbound - Initiate and StepNote: This activity template is only supported for Documentum Process Builder version6.5. If an earlier version of Process Builder is used against a Documentum 6.5 repository,this template will not open.

Use Web Service Inbound to create a new web services end-point for an activity thatneeds 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 loanapplication process to start the process after it receives an incoming application. You canset up the activity with WS-Security to require that the applicant provide a username andpassword 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 andreceive optimized binary data as attachments.

As a step in a process, the Web Service Inbound - Step activity can be used to receiveinformation from an outside source. The activity can also be used to verify income orget other related information from an outside source. You can enable security to ensurethat only authorized individuals can initiate the process.

You can enable correlation of the messages by using a correlation identifier that is aunique ID generated for each workflow. This correlation ID should be added to the SOAPheader 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 createsa 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 withthe activity if they have been selected to be visible for that activity in the ActivityInspector. Changing process data in an activity, page 143 provides instructions onhow to make a process variable visible to an activity.

• In theWSDL First option, you specify an existing WSDL for the system to use in theprocess.

Note: Before adding a Web Service Inbound activity to a process, configure the targetnamespace URI on the Advanced tab of the Process Properties dialog box. The systemcannot validate or save the process without the target namespace.

A structured data type created through importing an XML schema may not have thetarget 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 structureddata type.

• If the structured data type is not in use, edit the schema to define a target namespaceand recreate the data type.

To congure Web Service Inbound1. 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 activitytemplate and after it has been loaded, and the system creates a WSDL from theprocess 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 messagesbased 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 bemapped since the mapping are done implicitly.

3. To use an existing WSDL to define the web service, selectWSDL First.

a. Type theWSDL 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 aWS Security UserName Token authentication, select the checkbox andenter 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 activitymust contain the same credentials in the request header (in structure defined byWS-Security schema for UserTokens) to be granted access to the activity or process.

5. SelectMTOM to enable the system to optimize any attachments while sendingthe response.

Note: MTOM is not available for the Process First option.

6. Click Next to create the input message mapping associating process data to themessage.The SOAP message structure appears in the left-hand pane and the process data onthe right-hand side. You can set values for attributes of the process data model bymapping them from SOAP message attributes.

Required mappingsThe following mappings are required for attachments:• Document content• File formatIf you have multiple attachments, you can click Add on the Attachment node toadd more attachments.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.Understanding the data mapping tool, page 147 provides procedures for using thedata mapping tool.Using repeating attributes, page 156 provides details on adding and mappingrepeating-valued attributes.Mapping package attributes, page 149 provides instructions for exposing othersource attributes of a package that do not currently appear in the tree

7. Click Next to map the output message.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.Using correlation identifiers, page 162 gives more details on defining correlationsets for a process.Understanding the data mapping tool, page 147 provides procedures for using thedata mapping tool.Using repeating attributes, page 156 provides details on adding and mappingrepeating-valued attributes.



Adding an XML schema to activity content , page 151 provides instructions foradding an XML schema to a message mapping.Adding message properties, page 150 provides instructions for adding aservice-specific property to a message in order to complete a mapping.Mapping package attributes, page 149 provides instructions for exposing othersource attributes of a package that do not currently appear in the tree

Web Service

This activity template enables you to invoke document-literal style web services. WebServices 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 isnamespace self-sufficient.

• Web services respond to messages sent to them, so the activity needs to be able tohandle 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 customparameters for Web Service activities identify the WSDL document and the XML contentto send to the service. They also specify how to handle the response from theWeb service.

• WSDL document — This required parameter points to a file containing the WSDLcontent for the Web service. The file must be a well-formed WSDL document storedin the repository. You can navigate to the file by clicking the button next to thetext box.

• Service name — In many cases the WSDL document includes the name of the Webservice for the activity to invoke. If it does not, or if the WSDL document includesmore than one service definition, you need to type the Web service name in thisotherwise optional parameter.

• Operation name — This required parameter specifies the name of the Web serviceoperation to invoke.

• Port name — You must type the port name for the intended service if the WSDLdocument does not provide it or if it includes multiple port names.

• Send content from activity package — This optional parameter identifies whichcontent the activity passes to the Web service. The content must be well-formedXML that is namespace self-sufficient. The parameter value is the name of one of theactivity’s inbound packages. If you do not provide a value, the activity sends thecontent of the first inbound package (the package at index 0).



• Save Web service response — If you set this option to Yes, the activity saves theresponse from the Web service as an XML document. The next two parametersspecify the name of the document and where in the repository it is saved. If you setthis 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 XMLdocument. The default location is /Temp.

• Response document name — If you elected to save the response from the Webservice, this parameter specifies the name given to the XML document. If you do nottype a name, the activity creates a name using the name of the Web service followedby the word "Response" and the date and time of the response.

• Attach response document to package — If you elected to save the response fromthe Web service, this parameter specifies the output package to which the XMLdocument is added. Adding the document to an output package causes the activityto forward it to the next activity in the workflow. If you do not type the name of avalid output package, the XML document is not forwarded.

xPression Publish Document

Use the xPression Publish activity template to generate a new document from aDocument Sciences xPression document template using data from the process and thenmap it to a package or an attachment. The variables are replaced with process datawhen the document is published.

Note: Data validation is not supported in the xPression Publish Document activitytemplate. Ensure that all the runtime data is valid.

To congure an xPression Publish activity template:1. Type the xPression Server URL.

2. Type the Username and Password used to connect to the xPression server.

Note: This user must be assigned to a role with xDesign permissions.

3. Click Connect to connect to the xPression server and retrieve a list of categoriesavailable in the xPression server

4. Select an xPression document Category from the list.The values displayed in the Document and Output profile fields will be basedon this category.

5. Select a Document type that belongs to the category you selected.

6. Select an Output profile for the document.



The system uses this profile to publish the document outputs such as print, email,archive, or web-based formats.

7. Click Next to map the process data to the input document variables.The document variables are based on the document type.

Required mappingsYou must map all variables that the xPression server requires to complete thepublish service. At runtime, the variables are replaced with the process data inthe generated document.With xDesign documents, only variables that are used in the document appear inthe mapper. Ensure that the primary key is mapped.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using



source attributes of a package that do not currently appear in the tree.8. Click Next to map the output document to a package or an attachment, if the

document profile provides an output document.Required mappings

The attributes must be mapped to process data:• format is the format type that was set in the output profile. For example, if the

output profile is defined to publish a PDF file, this attribute must be mapped tothe corresponding package or attachment format.

• data is the generated document and must be mapped to the correspondingattribute in either a package or an attachment.

xPression Publish Document — Advanced

Use the xPression Publish Document - Advanced activity template when there are manyconstant values that must be mapped to process data. Instead of using the data mapperto map each variable, you can type the XML that creates the mappings for constantsand adds placeholders for dynamic data. Then use the data mapper to map only theplaceholder values that are created by the XML.

Note: Data validation is not supported in the xPression Publish Document - Advancedactivity template. Ensure that all the runtime data is valid.



To congure an xPression Publish activity template:1. Type the xPression Server URL.

2. Type the User Name and Password used to connect to the xPression server.

Note: This user must be assigned to a role with xDesign permissions.

3. Click Connect to connect to the xPression server and retrieve a list of categoriesavailable in the xPression server

4. Select an xPression document category from the list.The values displayed in the Document and Output profile fields will be basedon this category.

5. Select a Document type that belongs to the category you selected.

6. Select an Output profile for the document.The system uses this profile to publish the document outputs such as print, email,archive, or web-based formats.

7. Type the Customer Data XML that creates the mappings for constants and adds theplaceholders for dynamic values.This XML contains customer information which will be used by the xPressiondocument to personalize the document during the publish process. The XML in thistext box should consist of static text as well as placeholder values for the dynamiccontent that you will map.• Placeholders are prefixed with a dollar sign $ (for example, $streetaddress).• 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 firstnon-alphanumeric character.

The following sample code shows the Customer Data XML for a medical recordsrelease request. The request number, request date, and the telephone number areall variables that must be mapped in the data mapper.

<dataroot xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><CUSTOMER_DATA><MedicalRecordReleaseRequest><reqNo>$RequestNo</reqNo><requestDate>$ReqDate</requestDate><patientName>John Doe</patientName>

<patientAddress_street1>1234 Cherry Circle</patientAddress_street1><patientAddress_street2></patientAddress_street2><patientAddress_city>San Jose</patientAddress_city><patientAddress_state>California</patientAddress_state><patientAddress_zipCode>95131</patientAddress_zipCode>



<patientDOB>1976-01-01</patientDOB><patientSSN>123-12-1234</patientSSN><patientHospitalName>Mercy Hospital</patientHospitalName><orgName>Mercy Medical Foundation</orgName><orgTelNo>$$TelephoneNo</orgTelNo></MedicalRecordReleaseRequest></CUSTOMER_DATA>

</dataroot>

Note: Variables must be string types, so date and time values may have to beconverted using the DateToString data mapper function. (The date format thatcomes from the process data and the XSD date format that is expected by xPressionserver may be different.)

In the previous example, if requestDate is of type XSD dateTime, use the followingformat string:yyyy-MM-dd'T'HH:mm:ss.SSSZ

The system requires the following formats for date and time conversions:

Table 12. Required formats

XSD Type Format

date yyyy-MM-dd

dateTime yyyy-MM-dd’T’HH:mm:ss.SSSZ

time HH:mm:ss.SSS

8. Click Next to map the process data to the input document variables that wereplaceholder values in the XML.

Note: The constant values that you add using the Customer Data XML text box donot appear in the data mapper.

Required mappingsYou must map the values for variables provided in the Customer Data XML text box.You may find that you need to add attributes or elements to some of the data tocomplete the mappings.• Understanding the data mapping tool, page 147 provides procedures for using



source attributes of a package that do not currently appear in the tree.



9. Click Next to map the output document to a package or an attachment, if thedocument profile provides an output document.

Required mappingsThe following attributes must be mapped to process data:• name is comprised of the document name and the time in milliseconds.• format is the format type that was set in the output profile• data is the generated content.

SampleThe Sample window contains a sample activity template that shows the various types ofuser interface controls available for custom activity data-entry panels. In addition to thesample activity template, the Sample window includes two activity templates relatedto queue management:

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

Queue Task Rework Decision

Queue Task Rework Decision is a sample activity template for creating activities thatperform periodic quality checks on documents processed through a work queue. Thedefinition of a work queue includes a policy that specifies a percentage of documentsthat should be routed to another processor for a quality assurance check.

Like the Decision Split activity template, the Queue Task Rework Decision templatecreates activities whose only action is to evaluate branching logic and forward packagesas appropriate. An activity based on the Queue Task Rework Decision template routespackages to either the Next Rework Activity or the Next No Rework Activity. Itdetermines which activity to route each package to based on two factors: (a) the PercentQuality 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 theinitial document processing. The performer type for this activity should be category10 (Work Queue). Enter the activity name.



• Required Skill Level — The skill level of the performers whose work should bechecked. The range of valid values is from 0 (Trainee) to 10 (Advanced).

• Next Rework Activity Name — This required parameter specifies the activity thatperforms the quality check. Enter the activity name.

• Next No Rework Activity Name — This required parameter specifies the activity towhich documents not requiring a quality check are routed next. Enter the activityname.

The routing logic for each package is:

1. If the Percent Quality Check value from the Activity to Check is zero, route thepackage to the Next No Rework Activity.

2. If the performer who handled this package in the Activity to Check has a skill levelless than the Required Skill Level parameter value, route the package to the NextRework Activity.

3. Route all remaining packages to the Next Rework and Next No Rework activitiesin the percentage specified by the Percent Quality Check value. For example, if thePercent Quality Check is 20 percent, route one out of every five documents to theNext Rework activity.

Sample Activity Template

Process Builder also includes a Sample Activity Template that illustrates the format ofthe activity template XML file to help you create custom activity templates and it appearsin the Sample activity template folder. Documentum Process Builder Development Guideprovides 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 levelrequired to process a given package. This skill level value overrides any previous skilllevel requirement for the package.

In a typical scenario, the activity that precedes the Set Queue Task Skill activity has atransition condition that checks the attributes of the package to determine whether itrequires special treatment. Packages requiring special treatment are routed to the SetQueue Task Skill activity while all other packages skip this activity.

• Package Name — The name of the package for which the activity sets the requiredperformer skill level.



• Skill Level — The skill level to apply to the package. The valid values appear in alist box.

Deprecated activity templatesThe activity templates in the following section are no longer delivered with ProcessBuilder. They have been replaced with activity templates that have increasedfunctionality. The new activity templates provide a wizard-like interface for defining thedata transfer, including a graphical data mapping tool to specify how data is exchangedbetween the data sources. These delivered activity templates enable seamless use ofProcess Integrator messaging functionality from within Process Builder, and requireminimal configuration without custom development or processing.

This section exists for customers who are still using processes from older releases (5.3x orearlier) that contain the older activity templates.

Note: These templates are installed as part of the BPM.dar file and requires you to installProcess Integrator. TheProcess Integrator Activity Template 6.5 Migration Guide providesmore details on backwards compatibility for deprecated activity templates.

BAM

The Observation Point activity template in the BAM folder provides a means ofpublishing business data contained in packages from Process Builder to the ProActivitydatabase. This data becomes available to the Report Manager, where report designerscan create BAM reports based on package data.

Observation Point

This activity template enables you to select packages associated with a specific activityand publish the business data to Process Analyzer to be used in reports. Activities thatare followed by an Observation Point activity template can publish package data toProcess Analyzer.

At runtime, the Observation Point activity inserts some standard attributes and allcustom attributes into the audit trail table where the Workflow Publish Events job picksup the data and publishes it to the Process Analyzer. The following list shows thestandard 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 bepublished by the Workflow Publish Events job.

See Setting process template properties, page 66 for more information on enabling theaudit trail.

To congure 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 processand insert it immediately after the activity that you want to monitor.There is a one-to-one correspondence between the activity and the Observation Pointthat follows it. If an activity is followed by an Observation Point, the activity cannothave 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 Packagestab.

4. Select the packages that will have data published to the ProActivity database atthis point in the process.

a. Click Select. A selection dialog box appears, showing the packages associatedwith the process template.

b. Highlight the package name in the list on the left and click Add to add it tothe 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 formonitoring.

Note: Observation Point activity templates are not visible when imported into ProcessAnalyzer. Instead, the activity that precedes the activity template is flagged as amonitored activity and contains information detailing which packages are identifiedfor reporting. When the business process is imported back into Process Builder, theObservation Point activity template is restored in the process flow.



Workow Publish Events job

The Workflow Publish Events job publishes the events captured in the audit trail to theProActivity database at regular intervals. This job is delivered as part of the ProcessEngine install. For more information on configuring the dm_WFPublishEvents job, seeProcess Builder Installation Guide.

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 ofthe content and places it in the specified Remote Directory. When you select CreateSub Directory, the activity creates a unique subdirectory in the specified RemoteDirectory and places all of the content in the subdirectory. When you select AllPackages in Base Directory, the content is placed in the specified Remote Directory.

• Attach content from activity packages — This optional parameter identifies whichcontent the activity posts to the specified location. The value is the name of one ormore of the activity’s inbound packages. If you do not provide a value, the activityposts the content of the first inbound package (the package at index 0).

• Archive/Directory Name — If you chose Archive or Create Sub Directory as theTransfer Mode, the activity uses the value in this field to name the ZIP file orsubdirectory. When providing a directory name, you typically want to include asubstitution variable in the name, such as the workflow ID, so that the activitycreates a unique subdirectory for each workflow.

• Overwrite folder contents — Select whether or not to overwrite the existing files orfolders 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 theintegration activity templates. It has one required custom parameter and two optionalparameters.

• URL — This required parameter is the complete URL of the site to which the activityposts content, starting with the protocol prefix http://.

• Timeout (sec) — This optional parameter sets the timeout value for the HTTPconnection, in seconds. If you do not include a timeout value or set it to 0, theconnection will not timeout.

• Send content from activity package — This optional parameter identifies whichcontent the activity posts to the specified URL. The value is the name of one of theactivity’s inbound packages. If you do not provide a value, the activity sends thecontent of the first inbound package (the package at index 0). You can only postthe content from one package.

Lifecycle Apply (5.3x and earlier)

Activities based on this template apply a document lifecycle to one or more packages inthe business process. A lifecycle defines an ordered series of states that correspond tothe stages of a document’s life.

To configure a Lifecycle Apply activity, you choose the lifecycle to apply and thepackage(s) to apply it to. You also specify the initial state of the lifecycle and the scopeto use when resolving any aliases associated with the lifecycle. See the DocumentumComposer User Guide for details about creating and using lifecycles

• Package(s) To Apply Lifecycle — Click the ... button to display a dialog box fromwhich you can select the process packages to which the lifecycle will be applied. Foreach package to which you want to apply the lifecycle, highlight its name in the liston the left and click the Add button to move it to the list of selected packages on theright. When you click OK in the dialog box, the names of the selected packagesappear 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 theassociated lifecycle. You can choose to demote the package(s) to the base state (the firststate 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 youcan select the process packages that you want to demote to a previous lifecyclestate. For each package you want to demote, highlight its name in the list on the leftand 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 inthe data field.

• Demote To State — To demote the selected packages to a specific state, type the nameof the state in this field. If you leave this blank, it is demoted back to the previousstate.

• Demote To Base State — To demote the selected packages to the base state of thelifecycle, select the Yes option.

Lifecycle Promote

Activities based on this template promote one or more packages to a subsequent state inthe associated lifecycle.

• Package(s) To Promote — Click the ... button to display a dialog box from which youcan select the process packages that you want to promote to a subsequent lifecyclestate. For each package you want to promote, highlight its name in the list on theleft 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 inthe data field.

• Promote To State — Enter the name of the lifecycle state to which you want topromote the selected packages. If left blank, the package is demoted to the previousstate.

• Force Promotion — Each lifecycle state has a set of entry criteria that a documentnormally must meet in order to be promoted to that state. However, the LifecyclePromote activity template enables you to "force" promotion of a package even if itdoes not meet the entry criteria for the state. Select the Yes option to promote theselected packages regardless of whether they meet the entry criteria for the state.



Publish to JMS Topic

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

• JNDI initial context factory class — This required parameter provides the fullyqualified class name of the JNDI initial context factory class.

• JMS provider URL — This required parameter provides the complete URL forconnecting to the JMS provider.

• Topic connection factory JNDI name— This required parameter gives the JNDI nameof the topic connection factory for the specified JMS provider.

• Topic name — This required parameter gives the name of the topic to which youwant to publish the content.

• Publish content from activity package — This optional parameter identifies whichcontent the activity posts to the specified URL. The value is the name of one of theactivity’s inbound packages. If you do not provide a value, the activity sends thecontent of the first inbound package (the package at index 0). You can post thecontent from only one package.

SMTP

You use this activity template to deliver content using email. Its parameters definethe content of the message, the address to which it is delivered, and the SMTP serverused to send the mail.

When you send content using email, the content files are delivered as attachments tothe message.

• To — This required parameter is the email address of the recipient, including boththe username and domain name (user@domain). You can include multiple recipientsseparated by commas.

Click the ellipsis button (...) to display the Substitution Variable Dialog and chooseruntime variables.

• Cc and Bcc — These optional parameters list additional recipients of the emailmessage, in the same format as the To parameter.

• From — This required parameter is the email address of the sender, which displaysin the From field of the delivered message.



• Reply to — The address to which responses to this message are sent. Use thisparameter to format the reply address so that it properly addresses a ProcessIntegrator message handler. Typically, the Reply to address will include variablesfor the server to replace at runtime, such as the workflow ID of the currentworkflow. Appendix B, Substitution Variables for Custom Activity TemplateProperties provides more details on this subject.

• Subject — The text you enter for this parameter displays as the subject line of thedelivered message. If you leave it blank, the message is delivered with an emptysubject line.

• SMTP Server hostname or IP — This required parameter identifies the SMTP serverused to send the message. You can type the name of the host machine or its IPaddress.

• SMTP Server port number — This optional parameter identifies the port numberfor the SMTP server. If you do not provide a value, the activity uses the standardSMTP port 25.

• SMTP Server authentication user name and SMTP Server authentication password— If the SMTP server requires a username and password, provide the name andpassword.

• Attach content from activity packages — This optional parameter identifies whichcontent the activity includes as attachments to the email message. The value is thenames 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 inboundpackage (the package at index 0).

• Attach all content in folder packages — If any of the packages are sending containfolder objects, the activity can send all documents in the folder (Yes) or it can skipover the folder (No). If you click Yes, the activity attaches only those documentsdirectly inside the folder. It does not recursively attach documents from anysub-folders.

• Attach URL to the documents in message — Enables the URL to be shown as part ofthe email message body.

• Attach URL to activity packages in message — Enables a user to add packages anddisplay the corresponding URL in the email message body.

• Attach URL to workflow attachments in message — Enables a user to add an ad hocattachment’s URL in the email message body.

• Use default URL to Webtop — Select No to enable users to use a URL other thanthe default Webtop URL.

• Provide your URL prefix if not using default — If you are not using the defaultWebtop 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 defaultWebtop URL, type the URL suffix to be used in the email message body.



Send to JMS Queue

You can send content using Java Message Service (JMS) in two ways: by sending itto a JMS queue or by publishing it to a JMS topic. Use this activity template to createactivities that send to JMS queues. Publish to JMS Topic, page 252 provides informationabout publishing to JMS topics.

Note: Use Send to MQ JMS, page 254 to send messages to a queue when IBM MQ seriesis the JMS provider.

• JNDI initial context factory class — This required parameter provides the fullyqualified class name of the JNDI initial context factory class.

• JMS provider URL — This required parameter provides the complete URL forconnecting to the JMS provider.

• Queue connection factory JNDI name — This required parameter gives the JNDIname of the queue connection factory for the specified JMS provider.

• Queue name — This required parameter gives the name of the queue to which youwant to send the content.

• Reply to Queue name — This optional parameter provides the name of the JMSqueue to which any response message is sent.

• Message correlation ID — Process Integrator enables you to specify how inboundmessages are handled. The message correlation ID is the ID that Process Integratorwill use to identify messages as coming in response to this outgoing message.

• Send content from activity package — This optional parameter identifies whichcontent the activity posts to the specified URL. The value is the name of one of theactivity’s inbound packages. If you do not provide a value, the activity sends thecontent of the first inbound package (the package at index 0). You can post thecontent from only one package.

Send to MQ JMS

Use this activity template to send content using Java Message Service (JMS) with IBMMQ series as the JMS provider. All parameters are required.

Note: Use Send to JMS Queue, page 254 to send messages to a JMS queue when using aJMS provider other than IBM MQ series.

• Server — The IP address or fully qualified name of the machine on which WebSphereMQ 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. Thequeue must be managed by the specified Queue Manager. The queue name hasthe form WQ_queuename. You can locate the queuename queuename by selectingServers > Application Servers > servername > Server Component > Queue namesin WebSphere MQ.

• Channel Name — The name of the server connection changed created in WebSphereMQ for connecting to MQ.

• Request Package — This parameter identifies which content the activity posts to thespecified queue. The value is the name of one of the activity’s inbound packages.You can only post the content from one package.

Start Sub-Process

An Invoke Process activity launches a new workflow. All packages from the currentworkflow whose names and types match packages in the process template for the newworkflow are passed to the new workflow. The activity is complete when the newworkflow is started.

While the new workflow is logically a subprocess of the workflow that launches it, thereis no formal relationship between the workflow objects — they are independent. Topause the current workflow until the subprocess completes, define the next activity sothat it triggers in response to an event (on the Trigger tab) and include in the subprocessan activity, based on the Post Event to Parent Process activity template, that posts theevent 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 mustmatch packages from the current workflow in both name and type. The matchingapplies to all defined packages, not just visible packages.

• Sub-Process supervisor — Select the user to serve as the workflow supervisor forthe new workflow.




Appendix B

Substitution Variables for CustomActivity Template Properties

When typing values into the fields on a custom tab in the Activity Inspector, a user can includevariables that are replaced at runtime with values from the current environment, such as the nameof the workflow or the task performer. The variable can be the complete value of the field, or it canappear 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 isone of the variables listed in the table below. Each variable is composed of two parts, separated bya 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, thevariable <dmp:param>workflow.creator</dmp:param> will be replaced at runtime with the value ofthe creator attribute of the workflow object. If the selected attribute can have multiple values, thesubstitution 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 ratherthan typing it. When you close the dialog box, Process Builder inserts the selected variable at thecurrent 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 packagethat contains the intended value.The Attribute list displays the available attributes for the selected item. Or, if youselect 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 listbox, 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 theattribute 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 touse by selecting FIRST or LAST from the Index list.To use the value from a specific index position other than FIRST or LAST, edit thevariable 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 13. Supported Substitution Variables for Activity Conguration Fields

Variable Description

workflow.creator The username of the person who createdthe workflow

workflow.instructions The text from theWorkflow Instructionstext box in the Process Properties dialogbox.

workflow.id The ID of the workflow

workflow.name The name of the workflow

workflow.process_id The ID of the process template from whichthe workflow was generated

workflow.start_date The date when the workflow was started

workflow.supervisor The username of the person identified asthe workflow supervisor (the workflowcreator by default)

workflow.supervisor_address The workflow supervisor’s email address

task.act_id The ID of the activity that generated thecurrent task

task.number The sequence number within the workflowof the activity that generated the task

task.auto_method_id The ID of the method definition for anautomatic activity. If the task is not anautomatic activity, the value of the variableis "0000000000000000".

task.creation_date The date format is determined by thedefault time pattern set in DFC.




task.due_date The date format is determined by thedefault time pattern set in DFC. If the taskhas no due date, the value of the variableis "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, representedas an integer

packagename.attribute The value of any single-value attribute ofthe package specified by packagename.When selecting the variable from theSubstitution Variable Dialog box, the dialogbox displays all custom attributes and acommonly used subset of the standarddm_document attributes. However, youcan use any attribute.

packagename.attribute[index] The value of any multi-value attribute ofthe package specified by packagename. Theindex identifies which value to use: FIRST,LAST, or an integer indicating a position inthe list of values.When selecting the variable from theSubstitution Variable Dialog box, the dialogbox displays all custom attributes and acommonly used subset of the standarddm_document attributes. However, youcan use any attribute.

doc.id The ID of the first document in the firstpackage processed by the activity

doc.name The name of the first document in the firstpackage processed by the activity

note.id The ID of the first note attached to thedocument, if any exists

note.writer The name of the person who created thenote

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 identifiesthe alias you want to resolve. If you includethe optional alias_set, the server uses thealias from the specified alias set

VarName or VarName.<attribute value> The value of the process variable


Appendix C

Process Builder Conguration File

Process Builder has a configuration file that controls certain aspects of its user interface. Thebpmconfig 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 FilemenuThe table below describes the parameters in the configuration file. To change a value, edit the file witha text editor, changing the values as necessary.

Table 14. bpmcong Parameters

Parameter Description Default Value

unique-template-name Set to true to require that process template namesbe unique across the repository

false

show-package-version Specifies whether Process Builder enables users toselect the version of a package. If set to false, theprocess always uses the CURRENT version

true

show-package-type Specifies whether Process Builder enables usersto explicitly set the object type of a package. Ifset to false, Process Builder uses the object typeassociated with the selected form template, ordm_sysobject if no form template is selected

true


Process Builder Conguration File

Parameter Description Default Value

max-recent-file Sets the maximum number of filenames thatappear in the Recent Files list

5

template-save-path If this parameter exists, Process Builder requiresusers to save process templates in the specifiedfolder or a sub-folder. If the parameter does notexist, users can save process templates in anyfolder to which they have appropriate securityaccess

None


Index

AAccess Control Lists, see ACLsACL template, 192ACLs

assigning to a variable, 73minimum permissions, 75selecting, 76setting, 75system, 76user, 76

activitiesaligning, 57changing display settings, 145connecting, 95copying, 56described, 17enabling delegation, 115fault handler, 19initiate, 18moving, 56overriding, 74pasting, 56performer roles, 24performers, 24planning, 23repeatable, 129replacing, 58retry intervals, 115selecting conditionally, 41setting triggers, 128snap to grid, 58task subjects, 28transition types, 40trigger condition, 37wait for messages, 18

Activity Inspector, 111activity template folders

adding, 47removing, 48removing activity templates, 107

Activity Template Inspectorconfiguring, 107creating a new template, 106Definition tab, 108

activity template windowadding templates, 107copying custom templates, 107overview, 50

activity templatesconfiguring, 107copying, 106 to 107creating, 23, 106installing, 109 to 110location within system, 50setting preferences, 47showing prompt messages, 48showing validation and install

prompts, 48states, 51uninstalling, 109 to 110validating, 109

Add Business Day function, 158Add Days function, 159Add function, 158adding categories, 51Advanced tab, 75aging tasks, 30alias sets

default, 121specific, 121

aliasescreating alias sets, 27performers alias, 132using in workflow, 27

aligning activities, 57all users in a group, 25all versions, 64Apply to all selected option, 95, 112assign performers now, 119assigning performers, 118asynchronous messages, 18


Index

attributes, 149audit trail

configuring, 67enabling, 20observation points, 247sub-processes, 99Workflow Publish Events job, 249

auto-launch package, 144automatic activities

attributes, 17execution parameters, 115priority values, 30valid performers, 127

automatic performerschoosing, 114, 127tasks, 114

automatic workflow methods, 174

BBAM reporting

configuring audit trail, 67enabling, 20exposing packages, 72, 144exposing structured data types, 54sub-processes, 99updating BAM definitions, 54updating process data, 49

BAM updates, 49BOF Module activity template, 179breakpoints, 172Business Activity Monitor, see BAMByte to String function, 159

Ccalendar events, 194calendars, see process calendarscategories, 51checking out processes, 64choosing

automatic performers, 127manual performers, 116

complex data types, 35, 52, 55Concat function, 159conditional nodes, 154conditional performers, 118, 123content services templates

Create Folder, 181ECIS activity template, 182

Lifecycle Apply, 186, 250Lifecycle Demote, 184, 251Lifecycle Promote, 251Link to Folder, 186

content-type, 149continue execution option, 116Copy function, 159copying activities, 56correlation ID, 162correlation sets

creating, 78defined, 162using, 163

Count function, 159Create ACL activity template, 192Create Folder activity template, 181Create iCalendar Event activity

template, 194current versions, 64

Ddata, 149data definitions, 49data mapping

functions, 158input context, 157procedure, 155repeating attributes, 156single-valued attributes, 157using correlation sets, 162using functions, 158

data mapping tooladding an XML schema, 151adding conditional nodes, 154adding message properties, 150editing process data, 149function editor, 158mapping data, 155overview, 147package attributes, 149using repeating attributes, 156

Data tab, 69, 111Database Inbound activity template, 195Database Read activity template, 200Database Stored Procedure activity

template, 202Database Write activity template, 205Date to String function, 159debugging processes


Index

adding breakpoints, 169automatic tasks, 173automatic workflow methods, 174continue to next breakpoint, 172environment, 167, 174exiting, 172force complete task, 173graphical elements, 168inbound initiate activity, 170manual initiate activity, 170manual tasks, 172overview, 165rerunning a debug session, 172setting port number, 47starting a workflow, 169stepping into an automatic

activity, 171stepping over an activity, 171stopping, 172Task Manager tab, 172

Decision Split activity template, 188default alias set, 67, 121define performer alias, 121defining performers, 118delegation, 28, 115deleting objects, 56determining performers, 118digital signatures, 29display settings

changing, 145flows, 96

Display tab, 96, 102, 111, 145Display toolbar, 45Divide function, 159dm_changedactivityinstancestate, 68, 141dm_delegatedworkitem, 68, 141dm_QmPriorityAging job, 32dm_startedworkitem, 68, 140dm_WfmsTimer job, 39dm_workflow, 29dmi_package, 29dmi_queue_item, 29dmi_workitem, 29DQL Inbound activity template, 197DQL Read activity template, 198DQL Write activity template, 199draft state, 64, 105dynamic priority, 32, 113Dynamic Web Service activity

template, 207

EECIS activity template, 182Edit menu, 44element data types, 55Email Inbound activity template, 216email notifications, 39email templates

creating, 68, 130, 141for timers, 68, 130selecting, 69

end activities, 17enumeration, 151execution data, 20execution log, 115exporting process templates, 91extension, 28

Ffailover

execution options, 116retry options, 115setting method timeouts, 115

fault handler activities, 17, 19, 66, 95FAX Outbound activity template, 223File menu, 44Flow Inspector, 95flow templates

Decision Split, 188Join, 189Post Event to Parent Process, 190Start Sub-Process, 255XSL Transformation, 190

flowsadding fault handlers, 95described, 95display settings, 96fault handler, 21Flow Inspector, 95forward, 21reject, 21

folderscreating from template, 187managing, 107process sharing, 46

Force Complete Task button, 173format, 149forms

adding, 70adding to a package, 37


Index

adding to an activity, 144adding to process, 151creating high fidelity forms, 152populating with XML, 152properties, 71schemas, 152selecting, 77, 114

Forms Builder, 18, 37, 71, 78, 114FTP activity template, 249FTP Inbound activity template, 217FTP Outbound activity template, 220FTP Read activity template, 222functions, 158, 202

GGeneral tab, 66Get Day function, 160Get Month function, 160Get Value function, 160Get Year function, 160GetEmailAddress function, 160getInitialPriority method, 31

HHTTP Inbound activity template, 226HTTP Outbound activity template, 229HTTP Post activity template, 250HTTP/WebService Inbound Port

Number, 47

IiCalendar, 194icons, 45ICS calendar events, 194IDfModule interface, 32importing, process templates, 88inbound activities

correlation sets, 78debugging, 170enabling web services, 79port number, 47

initiate activities, 17 to 18installed state, 64, 105installing

activity templates, 110process templates, 81, 83

installing activity templates, 109integration templates

BOF Module, 179Database Inbound, 195Database Read, 200Database Stored Procedure, 202Database Write, 205Dynamic Web Service, 207Email Inbound, 216Fax Outbound, 223FTP, 249FTP Inbound, 217FTP Outbound, 220HTTP Inbound, 226HTTP Outbound, 229HTTP Post, 250Invoke Process, 183JMS Inbound, 230JMS Outbound, 232Process Data Mapping, 234Publish to JMS Topic, 252Send to JMS Queue, 254Send to MQ JMS, 254SMTP, 252SMTP Activity, 235Web Service, 240

Invoke Process activity template, 183IWQTaskPriority interface, 32

JJMS Inbound activity template, 230JMS Outbound activity template, 232Join activity template, 189Join function, 160

LLifecycle Apply activity template, 186,

250Lifecycle Demote activity template, 184,

251Lifecycle Promote activity template, 251Link to Folder activity template, 186

Mmanual activities

aliases as performer, 27attributes, 17delegation, 28extension, 28valid performers, 24


Index

manual performersall members in a group, 117choosing, 114, 116defining performers, 118multiple sequential performers, 117 to

118previous activity’s performer, 117 to

118repository owner, 117selecting based on conditions, 118selecting based on process data, 118single user from a group, 117single user from group, 118some users from a group, 117specific user, 117tasks, 114work queue, 117workflow supervisor, 117

mapping dataoverview, 155to work queue skill set, 126work queue skill sets, 126

message correlationconfiguration fields, 162correlation identifiers, 162correlation sets, 163defined, 162

messagesadding XML schemas, 151properties, 150

moving activities, 56Multi-segment flows, 95multiple sequential performers, 25multiple tabs view, 61Multiply function, 160

NNavigator, 62New Case from Template activity

template, 187nodes

adding conditions, 154mapping, 142, 236process data tree, 125

Note Inspector, 59Notification tab, 38, 111, 139Notification Template Wizard, 140notification templates, 140notifications

creating, 39, 139defaults, 130email templates, 68from timers, 131

notifying supervisor, 38, 139

Oobjects

deleting, 56selecting, 56

overriding activities, 74

Ppackage data, 20packages

adding to template, 69attributes, 149automatically launch, 144defining, 35exposing for reporting, 72mandatory, 71showing additional attributes, 150storing document names, 67

page setup, 92parameter type, 257pasting activities, 56Performer tab, 111, 114, 116, 127performers

aliases, 121, 132automatic, 114, 127choosing, 24determining at runtime, 26manual, 114, 116roles, 24selecting based on conditions, 123selecting based on process data, 125using aliases, 27using delegation and extension, 28

permissions, 75placeholders, 235Post Event to Parent Process activity

template, 190Post Timer Expires, 68post-timer, 38, 101, 129Pre Timer Expires, 68pre-timer, 38, 101, 129Preferences dialog box, 47 to 48, 50previous activity’s performer, 25


Index

print preview, 92 to 93printing process templates, 91priority

activities, 30how system increases, 31implementing, 32resolving, 31selecting levels, 113setting dynamic priority, 32setting initial, 30setting static priority, 32

priority modulesassociating with an activity, 116defined, 31example, 33

Process Analyzersharing processes, 45XPDL files, 47

process calendars, 77, 129process data

defining, 34defining packages, 34defining process parameters, 36defining process variables, 35described, 19managing, 143mapping to work queue skill set, 126

Process Data Mapping activitytemplate, 234

process debugger, see debugging processesprocess parameters

administering, 36defining, 36managing, 73overview, 36types, 74

Process Properties, see process templatesprocess sharing folders, 46process template editor pane

adding text notes, 56described, 56

Process Template owner, 67process templates

adding a form, 70adding aliases, 67adding email messages, 68adding notes, 59adding process data, 69adding process parameters, 74adding process variables, 72

Advanced tab, 75architecture, 16canceling check out, 88changing properties, 66checking in, 85, 87checking out, 85, 87creating, 56, 64Data tab, 69deleting, 88described, 17displaying multiple tabs, 61exporting, 91importing, 88installing, 83modifying, 85opening, 64printing, 91re-importing, 89saving, 79setting ACLs, 75setting zoom level, 58sharing with Process Analyzer, 45states, 63uninstalling, 83using the navigator, 62validating, 81versioning, 70, 85

process variablesaccess control lists, 73adding to a flow, 69defined, 20defining, 35permission requirements, 76types, 73

promptsshowing install and validate

prompts, 48showing warning messages, 48

propertiesadding, 29adding to a message, 150

Properties tab, 111 to 112Publish to JMS Topic activity

template, 252

QQueue Task Rework Decision activity

template, 245


Index

Rre-importing process templates, 89Reject flows, 95repeating attributes

mapping, 156task subjects, 29transition conditions, 138

reportingconfiguring audit trail, 67configuring audit trail settings, 67enabling, 20exposing packages, 72, 144exposing process variables, 36exposing structured data types, 54sub-processes, 99updating BAM definitions, 54updating process data, 49

repository explorer, 106repository owner, 24Rerun debug button, 172Resource Navigator, 43retry intervals, 115

Ssample templates

Queue Task Rework Decision, 245Set Queue Task Skill, 246

saving process templates, 79Select Performer, 116, 127selecting objects, 56Send to JMS Queue activity template, 254Send to MQ JMS activity template, 254server validations, 109Set Queue Task Skill activity template, 246sharing process templates, 45sign-off requirements, 29, 115simple data types, 35, 52Single Segment Flows, 95single user from group, 25skill set, 126SMTP Activity activity template, 235SMTP activity template, 252snap to grid, 58some users from a group, 25specific user, 25Split function, 160start activities, 17Start Sub-Process activity template, 255step activities, 17

Step into button, 171Step over to next activity button, 171stop execution option, 116stored procedure, 202storing document names, 67String to Byte function, 160String to Date function, 161structured data types

attributes, 53categories, 51complex types, 52, 55editing, 54element types, 55groups, 52managing, 72repeatable option, 54, 56report option, 56reporting option, 54searchable option, 54, 56simple, 35simple data types, 52using an XML schema, 55wizard, 51

Structured Data Types window, 51Structured Data Types Wizard, 51 to 52Sub-Process Inspector, 100 to 101sub-processes

bottom-up modeling, 100collapsing, 102deleting, 103display options, 102expanding, 102notes, 103overview, 99removing activities, 103setting properties, 101Sub-Process Inspector, 100timers, 101top-down modeling, 99

substitution variables, 257Substring function, 161Subtract function, 161supervisor notifications, 38, 139

Ttabs

Activity Inspector, 107suppressing the display of, 109viewing, 61


Index

Task Manager tab, 172task name, 113task_subject attribute, 28 to 29tasks

aging, 30automatic performers, 114manual performers, 114

TaskSpace, 36terminate execution option, 116timers

associating with a calendar, 129complete task, 38completing a task, 134delegate task, 38delegating a task, 133notification, 38run Java method, 38running a Java method, 133sending notifications, 131starring a process, 132start process, 38

Timers tab, 101, 111, 129ToLower function, 161toolbar, 44toolbar icons, 45ToUpper function, 161Transition Condition Wizard, 137transition conditions, 39 to 41, 134 to 135,

137, 139transition rules, 135Transition tab, 111, 135transition types, 40Trigger tab, 111triggers

events, 38setting, 37, 128

Uuninstalling

activity templates, 109 to 110process templates, 83

Update BAM Data Definitions option, 49Use Form for Properties, 71

Vvalidated state, 64, 105validating

activity templates, 109

process templates, 81validation

server, 109showing prompt messages, 48

variablesediting, 145substitution, 180 to 181, 186, 196, 201,

207, 257versions, 70View menu, 44viewing processes, 64

Wwait for message activities, 17 to 18warning messages, 48warning timers, 38, 101, 129Web Service activity template, 240Web Service Inbound activity

template, 237web services

Dynamic Web Service activitytemplate, 207

enabling, 79Web Service Inbound activity

template, 237work items, 17work queue, 26work queue priority module, 116work queue skill set, 126workflow availability, 28workflow instructions, 67workflow supervisor, 24Workflow toolbar, 45workflows

overview, 13packages, 34planning, 22process variables, 36

XXML schemas

adding to messages, 151in Activity Template Inspector, 108using in structured data types, 55

XPDLexporting, 91importing, 88re-importing, 89


Index

XPDL files, 46xPression Publish Documen—Advanced t

activity template, 242xPression Publish Document activity

template, 241XSD file, 55

XSL Transformation activity template, 190

Zzoom options, 58
