Related Topics
Process Custom Tasks
These Custom Tasks are used to initiate processes or process steps.


This Custom Task changes the duration and due date of a specified Timeline activity.
Configuration Options
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
Activity Instance ID |
|
The GUID of the activity instance you wish to edit. |
Due Date |
|
The desired due date in MM/DD/YYYY format. |
Duration | The duration of activity. You can set the duration by specifying the number of duration units, then use the drop down to select the desired duration unit (Days, weeks, etc.) |


The E-Mail Action Custom Task will parse an email message and extract values to use in a Form or process. You can determine the appropriate value by finding it using one of three methods:
- Line: On a specific line of the email.
- Keyword: Identified by a following a Keyword in the format "Keyword: KeywordName".
- Value: A static value manually entered into the field on the Custom task, i.e., specifying a value on receipt of an email, without parsing the email itself.
Configuration Options
Data From message
The message values you wish to extract.
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
Validate that email was sent from an email address belonging to a user to whom the task was assigned | This option will validate the email address of the user who sent the email against the email address of the user to whom the user task was assigned. This ensures that a person who possesses the user task notification email but was not assigned to the task cannot complete the task. | |
Results |
Line, Keyword, Value |
The Result of the task, which corresponds to the Workflow branch or Process Timeline Activity result. |
Comments |
Line, Keyword, Value |
Comments that can be added to a Workflow Task or Process Timeline Activity. |
[A Mapped Form field] |
Line, Keyword, Value |
a Form field that can be mapped to the Line, Value, or Keyword. You can click the Add Mappings button to map additional Form fields. |
Ignore Text part of multipart message | Sometimes, retrieving information from a message formatted in Rich Text can be difficult. Checking this option may resolve the issue. | |
Append Data to an Array | This checkbox can only be selected if the mapped field is in an array. If checked, this option will add a new row to the array, setting the specified field to the value retrieved. If not checked, but the mapped field is in an array, the entire specified column (that is, the specified field in every row of the array) will be set to the value returned. | |
Append Data to Form Field | If checked, this option will add the retrieved data to the existing contents of the specified form field with a comma separator. If not checked, the existing contents of that form field will be replaced. |
Email Attachments
For any of the options chosen for email/attachment handling, a Group Name text box will appear to enable you assign group name for the object when it is attached.
OPTION |
DESCRIPTION |
---|---|
Attach email to process |
This will attach the email object as a process attachment. |
Attach email to form |
This will attach the email object as a Form attachment. |
Attach email attachments to process |
This will attach all of the email's attachments as a process attachment. |
Attach email attachments to form | This will attach all of the email's attachments as a Form attachment. |
Reply on Error
Used to send a generic response when an error occurs when processing the email.
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
Subject |
|
The subject of the email response sent to the user who sent the email. |
Body |
|
The body text of the email response sent to the user who sent the email. |
Reply on Successful Task Completion
Used to notify the email sender when a task has been successfully completed after the email is received and parsed.
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
Subject |
|
The subject of the email response sent to the user who sent the email. |
Body |
|
The body text of the email response sent to the user who sent the email. |


This Custom Task will cause a Workflow to jump from the current Step to a different Step in the Workflow.
Configuration Options
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
Jump to step name |
|
The name of the process step to which you want to jump. |
[Post-jump actions] |
Do not close Form, Save and close Form, Close Form only (no save) |
Directs what to happen to the open Form when the task is run. |


The Manage Task Users Custom Task will Add, Cancel or Reassign users from a specific task, or all tasks in a process. This Custom Task is a Form Custom Task, and is generally designed for use by process administrators to use a Form to specify user task assignments.
Configuration Options
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
User Action | Add User to task Cancel user in task Reassign User in Task |
This option specifies the user action you'd like to take. |
Tasks to Manage | All Selected |
You can manage all tasks, or a selected task. If you choose the Selected option, then you will be presented with a Process chooser to select the process, and a Tasks list that shows the tasks that are available from the selected process. |
Process | A Content Picker control that enables you to select the process to manage if you choose the Selected option from the Tasks to Manage property. | |
Tasks |
|
The list of available tasks from the process you selected in the Process property. |
Error Message If No Eligible task is Found |
|
The error message you'd like to display if the specified task cannot be found. |
Reassign user in Task Options
When the Reassign User in Task property is selected, additional options are made available to configure the task reassignment.
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
Reassign from User |
List of Form controls OR Text box |
The user who should be removed from the task. You can select the user from a UserPicker control that exists on the form, OR You can enter the UserID into the available text box. |
Reassign to User |
List of Form controls OR Text box |
The user who should be added to the task to replace the original user. You can select the user from a UserPicker control that exists on the form, OR You can enter the UserID into the available text box. |
Error Message if Original User is not Found | An error message you can configure to display if the original user cannot be found in the system. | |
Error Message if Reassigned User is not Found | An error message you can configure to display if the reassigned user cannot be found in the system. | |
Error Message if Original User is Not In Task | An error message you can configure to display if the original user is not a task participant in the specified task. | |
Error Message if Reassigned User is Already In Task | An error message you can configure to display if the reassigned user is already a task participant in the specified task. |
An SDK method, GetProcessTasksByPRID, adds additional scripting support for this Custom Task.


This Custom Task will post a value to a Wait task in a process to complete the Wait task and wake the process.
Configuration Options
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
Process Instance ID: |
|
The Instance ID of the process instance that is stopped on a Wait task that you wish to complete. |
Post String: |
|
The string value that will complete the wait task. |


This Process Timeline Custom Task calls a Windows batch script or PowerShell command to run on a local computer.
Configuration Options
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
Choose Script File Location |
Content Picker |
The location of the script to run. |
Script File to Run |
|
If Content Picker is chosen as the Choose Script File Location Property, this property will display a Object picker from which you can select a script that resides in the Content List. Otherwise, it will display a text box into which you can type the fully qualified file path of the script's location. The location must be accessible from the client machine from which Process Director is being accessed. |
Script Arguments | A comma-separated list, in the correct order, of parameter arguments that the script requires. | |
Wait for Script to Complete | A check box that enables you to require that the script be completed before the Activity that calls the Custom Task can be completed. If unchecked, the script will run asynchronously with the Process Timeline. |
A Run Script button will, when clicked, run the configured script immediately from the Configuration window.


This Custom Task launches a new, asynchronous process or processes. You can either specify the process within the Custom Task configuration, or have the process specified by a form field or an array of form fields. The Launch Data tab enables you to configure a form control that will specify the process to be launched. Alternatively, you can specify the process to be launched right in that tab.
Additionally, this Custom Task can be bound to an Array on a form to launch a new process for each row in the array, via the Array Binding tab.
Launch Data/New Form/Attachments Tabs
Array Binding Tab
Advanced Tabs
Configuration Options
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
LAUNCH DATA TAB |
||
Launch Process |
|
Picker control to choose the process to launch. |
NEW FORM TAB |
||
New Form |
|
Picker control to select the new form to attach to the process. Multiple forms can be added by clicking the Add Mapping button. |
ATTACHMENTS TAB |
||
Reference Type(s) |
None |
The reference types for new attachments associated with this process. |
Attach Items To | Newly Launched Process New Form |
This selection is available only when the Reference Type(s) field is set to a value other than "None". It enables you to attach items to either the new process or the new Form. |
ARRAY BINDING TAB |
||
Array Field |
List of Form arrays |
Launch a process for each row in an array |
For each row, launch new Process only under the following condition. |
|
When checked, a list of fields, list of operators, and a text box appear to allow you to set a condition that must apply for each row in the array before that row initiates the process. |
ADVANCED TABS |
||
Launch as Sub-Process of Current Process |
|
|
Launch Process as Current User (instead of Object Creator) |
|
|
Save current Form data before starting Process |
|
Saves the form data before the process is initiated. Using this option on a new form instance that has not yet started a workflow will save the Form, but will not start the default workflow for that Form. |
After Process Starts |
List of form handling options |
Determines what should happen with the parent Form after the process started by the Custom Task is initiated. |
After Successful Launch |
List of actions |
Enables you to make changes to form fields to reflect the start of the process. |
Copy the data from all fields which the Source Form and the New Form share (all Fields with the same name) |
|
Copies form data to the new form. |
Save new forms when they are created (WARNING: this will prevent default data from being set for those forms) | Enables you to automatically save a form instance after the Run Process Custom Task creates it. Use with care: this option is disabled by default, as enabling it will prevent default data from being set on that form instance. | |
Set Form as Default Form Instance for Process |
|
|
Group name for the new Form in the new Process |
|
Sets a group name for the new form. |
Attach new Form to parent Process |
|
|
Group name for the new Form in the parent Process |
|
Sets a group name for the new form. |
Attach source Form to new Process |
|
|
Group name for the source Form in the new Process |
|
Sets a group name for the source form. |
Item Type |
All, Documents, Forms |
Types of attachments |
Group Name |
All, Objects with no Group only, Specify |
Group name for attachments, optionally limiting which are attached by group. |


This Custom Task invokes processes that can link data on multiple, pre-existing Forms, in cases where the Synchronize Data flag on the primary form field does not suffice.
For example, having one Form "A", and a Knowledge View that returns Form instances "1", "2", and "3" (potentially as a result of some data in "A"), the Custom task can start three processes, one for each pair of Forms (["A", "1"], ["A", "2"], ["A", "3"]) by using a Business Value that has the Knowledge View as a data source. The Business Value must return an Object ID.
The purpose of the Custom Task is to create new Processes that operate on existing Forms. As such, this Custom task is generally relevant only for very advanced implementations.
Configuration Options
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
Process Section |
||
Process Definition |
|
An Object Picker from you can select the desired process to start. |
References to Copy | Current Form Only Process References Form References None |
When choosing Process or Form References, a Group name text box enables you to specify the Group name for references to attach to the new process. Current Form Only will attach only the current default Form of the running Process. |
Default Form | Do Not Set Current Default Form Object From Business Value |
Enables you to choose the default form for the new process. In most cases, you would choose the Form returned by the Business Value, using the Object ID returned from the underlying Knowledge View. |
Business Value Section | ||
Business Value | An Object Picker from you can select the desired Business Value to use. | |
Parameters | If the selected Business Value property has required parameters, selection fields will appear that enable you to: Choose the parameter from the Container form specified in the Process Timeline activity from a dropdown OR Type the Parameter in a text box, to include the use of System Variables. |
|
Property for Object ID |
A dropdown control enables you to select the Business Value property to use to retrieve the Object ID OR A text box enables you to enter the Object ID or appropriate system variable. |


For most use cases, this feature has been replaced by the use of the Goal object in Process Director.
The Custom Task extracts information from a Form to start processes at specific instances as defined in a Form. The Custom task depends on the Scheduler module, and a more complete explanation of the functionality of the module and Custom task can be found in the Scheduler Module documentation.
Configuration Options
OPTION |
ATTRIBUTES |
DESCRIPTION |
---|---|---|
Schedule Form |
|
The Form that contains the scheduling information. |
Process Field |
|
The Form field that identifies the process to start. |
Schedule Field |
|
The Form Schedule field that identifies the schedule or interval for the process to run. |
Next Run Time Field |
|
The Form field that identifies the next time when the process will run, according to the schedule defined in the previous field. Generally this does not need to be edited by the user. |
Audit Form |
|
a Form that contains auditing data. |
Audit Field Prefix |
|
The prefix used to identify the fields, usually columns in an array, containing the audit data. |
Document Feedback
If you notice some way that this document can be improved, we're happy to hear your suggestions. Click on the button below to provide us with your feedback. Please remember, though, that not every issue can be addressed through documentation. So, if you have a specific technical question, please open a support ticket.