Manage and Model Processes
ProcessMaker API Documentation
Script Central

Add and Configure Manual Task Elements

Add and configure Manual Task elements in your Process model.

Add a Manual Task Element

Don't Know What a Manual Task Element Is?

See Process Modeling Element Descriptions for a description of the Manual Task element.

Permissions Required

Your ProcessMaker user account or group membership must have the following permissions to add a Manual Task element to the Process model unless your user account has the Make this user a Super Admin setting selected:

  • Processes: Edit Processes

  • Processes: View Processes

See the Process permissions or ask your ProcessMaker Administrator for assistance.

Follow these steps to add a Manual Task element to the Process model:

  1. View your Processes. The Processes page displays.

  2. Create a new Process or click the Open Modeler iconto edit the selected Process model. Process Modeler displays.

  3. Locate the Task element in the Elements and Connectors palette that is to the left of the Process Modeler canvas. If the Hide Menus buttonis enabled, the Elements and Connectors palette displays the Task element's icon.

  4. Drag the element into the Process model canvas where you want to place it. If a Pool element is in your Process model, the Manual Task element cannot be placed outside of the Pool element.

  5. From the Elements drop-down menu, select the Manual Task option. The Manual Task element displays.

Manual Task element

After adding the Manual Task element, consider adding either of the following Boundary-type Process model elements to design business solutions when your best-case scenarios don't happen:

After the element is placed into the Process model, you may move it by dragging it to the new location.

Moving a Manual Task element has the following limitations in regards to the following Process model elements:

  • Pool element: If the Manual Task element is inside of a Pool element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Manual Task element inside the Pool element closest to where you attempt to move it.

  • Lane element: If the Manual Task element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Manual Task element cannot be moved outside of the Pool element.

Settings

Your ProcessMaker user account or group membership must have the following permissions to configure a Manual Task element unless your user account has the Make this user a Super Admin setting selected:

  • Processes: Edit Processes

  • Processes: View Processes

See the Process permissions or ask your ProcessMaker Administrator for assistance.

The Manual Task element has the following panels that contain settings:

Configuration Panel Settings

Edit the Element Name

An element name is a human-readable reference for a Process element. Process Modeler automatically assigns the name of a Process element with its element type. However, an element's name can be changed.

Follow these steps to edit the name for a Task element:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Manual Task element from the Process model in which to edit its name. Panels to configure this element display.

  3. Expand the Configuration panel if it is not presently expanded. The Name setting displays.

  4. In the Name setting, edit the selected element's name and then press Enter.

Select the ProcessMaker Screen for the Manual Task

When a Manual Task element triggers, a ProcessMaker Screen can display instructions or information in its Task summary so its Task assignee can perform the manual task. The ProcessMaker Screen must be of Display type.

When a Manual Task element is placed into a Process model, it is not configured to display a ProcessMaker Screen when it triggers. Therefore, it must be configured.

Follow these steps to select the ProcessMaker Screen that displays when a Manual Task element triggers:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Manual Task element from the Process model in which to select the ProcessMaker Screen that displays when that Manual Task element is triggered, thereby providing instructions or information to the Task assignee. Panels to configure this element display.

  3. Expand the Configuration panel if it is not presently expanded, and then locate the Screen for Input setting.

  4. From the Screen for Input drop-down menu, select the ProcessMaker Screen that has been designed to display when that Manual Task element triggers. This drop-down menu displays only Display types to display a message to the Task assignee in the Task summary. After a ProcessMaker Screen is selected, the Open Screen link displays.

  5. Optionally, click the Open Screen link to view and/or edit your selected ProcessMaker Screen. Note that your ProcessMaker user account must have appropriate Screen category permissions to view and/or edit the selected Screen.

Specify When the Manual Task is Due

Specify when a Manual Task element is due from when that activity is assigned to a Request participant. The default period of time for a task to be due is 72 hours (three days).

The Task due date displays for each pending assigned Task. After the specified time has expired for a manual task, an overdue indicator displays for that task to the assigned task recipient.

Specify due time for a Manual Task element in total number of hours. This includes hours not normally associated with business hours, including overnight hours, weekends, and holidays.

Follow these steps to specify when a Manual Task element is due:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Manual Task element from the Process model in which to specify how many hours the activity is due. Panels to configure this element display.

  3. Expand the Configuration panel if it is not presently expanded, and then locate the

    Due In setting.

  4. In the Due In setting, enter the total number of hours the activity is due in one of the following ways:

    • Enter the number in the Due In setting and then press Enter.

    • Hover your cursor over the Due In setting, and then use the spin arrows to increase or decrease the total number of hours by one.

Display the Next Assigned Task to the Task Assignee

When the Display the Next Assigned Task to the Task Assignee setting is used in a Manual Task element, the Task assignee receives a waiting message after that Task assignee submits that Task. This is different than the default functionality, whereby the To Do Tasks page displays after each Task is submitted.

Use this setting when you understand that this Task assignee will be assigned multiple Tasks during the same Request, regardless of whomever that Task assignee is. This becomes convenient for that Task assignee to display a next Task immediately after submitting the initial Task during that Request, especially if Script Task elements are between Task elements so that Tasks are assigned quickly.

The Display the Next Assigned Task to the Task Assignee setting applies only during the same Request.

The following message displays to the Task assignee after that Request participant submits the Task that uses the Display the Next Assigned Task to the Task Assignee setting: Please Wait: We're getting the next task for you....

Message that displays when the Display the Next Assigned Task to the Task Assignee setting is used

Follow these steps to configure a Manual Task element to display the next assigned Task to the Task assignee:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Manual Task element from the Process model in which to configure it to display the next assigned Task to the Task assignee. Panels to configure this element display.

  3. Expand the Configuration panel if it is not presently expanded, and then locate the Display Next Assigned Task to Task Assignee setting.

  4. Select the Display Next Assigned Task to Task Assignee setting.

Assignment Rules Panel Settings

Specify whom to assign the Task or to use assignment rules to assign the Task.

Select to Whom to Assign the Task

Instead of assign the Task's assignee using one or more rules, select to whom to assign a Task:

  • Requester: Assign that Task to the person who started the Request, also known as the requester.

  • User: Assign that Task to a specified ProcessMaker user.

  • Group: Assign that Task to any member of a specified ProcessMaker group. When a Task is assigned to a ProcessMaker group, round robin assignment rules determine which group member is the assignee without manually assigning the Task.

  • Previous Task assignee: Assign that Task to the previous Task assignee in that Request's workflow.

  • By User ID: Assign that Task to a ProcessMaker user based on a Variable Name value as entered into a ProcessMaker Screen during a previous Task in that Request. For example, if a Line Input control in a ProcessMaker Screen has the Variable Name value of Name, to contain a user's name, then use that value to thereby assign the Task to that ProcessMaker user.

  • Self Service: Assign that Task to allow any member in a specified ProcessMaker group to voluntarily self-assign any Task from a queue.

Follow these steps to select to whom to assign the Task that is referenced in a Manual Task element:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Manual Task element from the Process model in which to select the Task assignee. Panels to configure this element display.

  3. Expand the Assignment Rules panel if it is not presently expanded. The Task Assignment setting displays.

  4. From the Task Assignment drop-down menu, select one of the following options:

    • Requester: Select Requester to assign the Task to the requester. This is the default option.

    • User: Select User to assign the Task to a specified ProcessMaker user. When this option is selected, the Assigned User drop-down menu displays below the Task Assignment drop-down menu.

      From the Assigned User drop-down menu, select the person's full name as the Task element's assignee.

    • Group: Select Group to assign the Task to a specified ProcessMaker group via round robin rules, whereby each member of the group has an equal chance to be assigned the Task without manually assigning the Task to a group member using a rotation. When this option is selected, the Assigned Group drop-down menu displays below the Task Assignment drop-down menu.

      From the Assigned Group drop-down menu, select the group from which to assign the Task via round robin rules.

    • Previous Task Assignee: Select Previous Task Assignee to assign the Task to who was assigned the previous Task in this Request.

    • By User ID: Select By User ID to assign the Task to a ProcessMaker user based on a Variable Name value as entered into a ProcessMaker Screen during a previous Task in that Request. For example, if a Line Input control in a ProcessMaker Screen has the Variable Name value of Name, to contain a user's name, then use that value to thereby assign the Task to that ProcessMaker user. When this option is selected, the Variable Name of User ID Value setting displays.

      In the Variable Name of User ID Value setting, enter the Variable Name value from which to reference the ProcessMaker user to whom to assign the Task.

    • Self Service: Select Self Service to allow any member in a specified ProcessMaker group to voluntarily self-assign any Task from a queue. When this option is selected, the Assigned Group drop-down menu displays below the Task Assignment drop-down menu.

      From the Assigned Group drop-down menu, select the group from which any of its members can self-assign Tasks from a queue.

  5. Enable the Lock task assignment to user option to assign this Task to the same Task assignee if workflow in the Request returns to this Manual Task. If the initial Task assignee was a member of a ProcessMaker group, the Task is reassigned to the same ProcessMaker group member. This option is useful if the initial Task assignee in the Request might need to provide clarification regarding information that Request participant initially submitted in that Task.

  6. Enable the Allow Reassignment option to allow the Task assignee to reassign the Task if necessary. If the Allow Reassignment option is enabled, the Reassign button displays in the Task summary to allow that Task assignee to reassign that Task. See View a Task Summary.

Assign the Task Using Rules

Instead of selecting to whom to assign a Task that is referenced in a Manual Task element, assign the Task's assignee using one or more rules:

  • Requester: Assign that Task to the person who started the Request, also known as the requester.

  • User: Assign that Task to a specified ProcessMaker user.

  • Group: Assign that Task to any member of a specified ProcessMaker group. When a Task is assigned to a ProcessMaker group, round robin assignment rules determine which group member is the assignee without manually assigning the Task.

  • Previous Task assignee: Assign that Task to the previous Task assignee in that Request's workflow.

  • By User ID: Assign that Task to a ProcessMaker user based on a Variable Name value as entered into a ProcessMaker Screen during a previous Task in that Request. For example, if a Line Input control in a ProcessMaker Screen has the Variable Name value of Name, to contain a user's name, then use that value to thereby assign the Task to that ProcessMaker user.

  • Self Service: Assign that Task to allow any member in a specified ProcessMaker group to voluntarily self-assign any Task from a queue.

The rule that determines the Task assignee uses an expression syntax described in Expression Syntax Components. Each rule can only have one expression, but by using logical operators multiple conditions can be specified in that expression. You may use multiple rules to better confine the condition(s) to whom to assign the Task. You may use Magic Variables in your expression syntax.

Follow these steps to select to whom to assign the Task that is referenced in a Manual Task element using a rule:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Task element from the Process model in which to assign the Task via a rule. Panels to configure this element display.

  3. Expand the Assignment Rules panel if it is not presently expanded, and then locate the +Rule button.

  4. Click the +Rule button.

    The Expression and Task Assignment settings display.

  5. In the Expression setting, enter or edit the expression that determines that Task element's Task assignee using the syntax components described in Expression Syntax Components, and then press Enter.

  6. From the Select the Task Assignee drop-down menu, select that Task's assignee from the following options:

    • Requester: Select the Requester option to assign that Task element's Task to the requester if the expression in the Expression setting evaluates as True.

    • User: Select the User option to assign that Task element's Task to a ProcessMaker user if the expression in the Expression setting evaluates as True. When this option is selected, the Assigned User drop-down menu displays below the Select the Task assignee drop-down menu.

      From the Assigned User drop-down menu, select which ProcessMaker user to assign that Task.

    • Group: Select the Group option to assign that Task element's Task to a ProcessMaker group if the expression in the Expression setting evaluates as True. When this option is selected, the Assigned Group drop-down menu displays below the Select the Task assignee drop-down menu.

      From the Assigned Group drop-down menu, select which ProcessMaker group to assign that Task.

    • Previous Task Assignee: Select Previous Task Assignee to assign the Task to who was assigned the previous Task in this Request.

    • By User ID: Select By User ID to assign the Task to a ProcessMaker user based on a Variable Name value as entered into a ProcessMaker Screen during a previous Task in that Request. For example, if a Line Input control in a ProcessMaker Screen has the Variable Name value of Name, to contain a user's name, then use that value to thereby assign the Task to that ProcessMaker user. When this option is selected, the Variable Name of User ID Value setting displays.

      In the Variable Name of User ID Value setting, enter the Variable Name value from which to reference the ProcessMaker user to whom to assign the Task.

    • Self Service: Select Self Service to allow any member in a specified ProcessMaker group to voluntarily self-assign any Task from a queue. When this option is selected, the Assigned Group drop-down menu displays below the Select the Task Assignee drop-down menu.

      From the Assigned Group drop-down menu, select the group from which any of its members can self-assign Tasks from a queue.

  7. Click Save.

Expression Syntax Components

Use the following expression syntax components to compose the expression that describes to whom is assigned a Task referenced in a Task element.

Spaces are allowed before and after expression components, such as arithmetic and comparison operators, to more easily read the expression.

Combine expressions using logical operators. Example: (not approved) or (cost > 500).

Magic Variables can be used in when composing expressions.

Literals

Component

Syntax

Example

string

"hello world" or 'hello world'

FullNameInput == "Louis Canera"

number

100

cost > 500

array

[value1, value2]

myFruit not in ["apples", "oranges"]

Boolean

true and false

directorSigned

Arithmetic Operations

Component

Syntax

addition

+

subtraction

-

multiplication

*

division

/

Logical Operators

Component

Syntax

not

not

and

and

or

or

Comparison Operators

Component

Syntax

equal to

==

not equal to

!=

less than

<

greater than

>

less than or equal to

<=

greater than or equal to

>=

String Operator

Component

Syntax

concatenate matches

~

Array Operators

Component

Syntax

contains

in

does not contain

not in

Range

Component

Syntax

Example

range

..

foo in 1..10

Notifications Panel Settings

Set Task Notifications

Set email notifications for Tasks separately. Settings in the Notifications panel configure Task notifications only within the ProcessMaker application.

Set when notifications regarding Tasks are sent to the following:

  • Requester: Send notifications to the Request initiator (referred to as the requester) when the Task associated with this Task element is assigned and/or completed.

  • Task assignee: Send notifications to Task assignees associated with this Task element when that Task is assigned and/or completed.

  • Request participants: Send notifications to all Request participants of this Process when the Task associated with this Task element is assigned or completed.

Follow these steps to set Task notifications in a Task element:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Task element from the Process model in which to set Task notifications. Panels to configure this element display.

  3. Expand the Notifications panel if it is not presently expanded. Settings display to set Task notifications.

  4. From the Requester settings, set Task notifications for the Requester following these guidelines:

    • Enable the Assigned setting to notify the Requester when the Task associated with this Manual Task element is assigned. Otherwise, disable this setting to not send this notification.

    • Enable the Completed setting to notify the Requester when the Task associated with this Manual Task element is completed. Otherwise, disable this setting to not send this notification.

    • Enable the Due setting to notify the Requester when the Task associated with this Manual Task element is due to be completed. Otherwise, disable this setting to not send this notification.

  5. From the Assignee settings, set Task notifications for assignees of this Manual Task element following these guidelines:

    • Enable the Assigned setting to notify Task assignees associated with this Manual Task element when they are assigned this Task. Otherwise, disable this setting to not send this notification.

    • Enable the Completed setting to notify Task assignees associated with this Manual Task element when they complete this Task. Otherwise, disable this setting to not send this notification.

    • Enable the Due setting to notify Task assignees associated with this Manual Task element is due to be completed. Otherwise, disable this setting to not send this notification.

  6. From the Participants settings, set Task notifications to all Request participants of this Process following these guidelines:

    • Enable the Assigned setting to notify all Request participants of this Process when the Task associated with this Manual Task element is assigned. Otherwise, disable this setting to not send this notification.

    • Enable the Completed setting to notify all Request participants of this Process when the Task associated with this Manual Task element is completed. Otherwise, disable this setting to not send this notification.

    • Enable the Due setting to notify all Request participants of this Process when the Task associated with this Manual Task element is due to be completed. Otherwise, disable this setting to not send this notification.

Email Notifications Panel Settings

Overview

Looking for ProcessMaker Notifications?

Set ProcessMaker application notifications for Tasks separately. Settings in the Email Notifications panel configure only email notifications for Tasks.

ProcessMaker Package Required

The Email Notification panel is available only when the Send Email package is installed in your ProcessMaker instance. The Send Email package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Send Email package can be installed in your ProcessMaker instance.

The following may be email Task notification recipients:

  • ProcessMaker users and/or group members.

  • Specific email addresses for individuals who are not ProcessMaker users in your ProcessMaker instance.

The email body for the Task notification may be plain text or referenced from a Email-type ProcessMaker Screen. If referencing the email body from a Display-type ProcessMaker Screen, you may use the value from a Screen's Variable Name setting as a variable in this setting. For example, if your Process model references a ProcessMaker Screen that contains a Line Input control with the Variable Name setting value of EmailAddress into which the Request participant enters an email address, use mustache syntax {{EmailAddress}} to use that Line Input control's value in the ProcessMaker Screen.

Set when email Task notifications are sent to email recipients:

  • Task trigger: Send email notifications when the Manual Task triggers.

  • Task completion: Send email notifications when the Manual Task completes.

  • Conditionally when a Request data object or Magic Variable meets a specific setting or condition: Specify an expression to conditionally send the email notification when a Request data object or Magic Variable meets a specific setting or condition. Specify this condition using an expression syntax described in Expression Syntax Components.

An email notification is an aggregate of multiple settings in the Email Notifications panel:

After setting an email notification, the following settings are available:

Set the Email Notification's Subject and Body Content

Follow these steps to set the email Task notification's subject and body content in a Manual Task element:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Task element from the Process model in which to set email Task notifications. Panels to configure this element display.

  3. Expand the Email Notifications panel if it is not presently expanded. The Notifications setting displays.

  4. Click the iconto add an email notification. The Add Notification settings display.

  5. From the Subject setting, revise the default text if necessary that displays as the email subject. By default, ProcessMaker displays the current Task element's Name setting as part of the Subject setting.

  6. From the Body setting, select one of the following options:

    • Plain Text:

      Select the Plain Text option to enter plain text to display as the email body. This is the default option. Follow these steps:

      1. From the Body setting, ensure that the Plain Text option is selected.

      2. In the setting below the Plain Text option, revise the default text if necessary that displays as the email body. By default, ProcessMaker displays the current Task element's Name setting as part of the Plain Text option.

    • Display Screen:

      Select the Display Screen option to select a Email-type ProcessMaker Screen from which to display its content as the email body. Follow these steps:

      1. From the Body setting, ensure that the Display Screen option is selected.

      2. From the drop-down menu below the Display Screen option, select from which ProcessMaker Screen to display its content as the email body. Only Email-type ProcessMaker Screens display from this drop-down menu.

      3. Optionally, click the Open Screen link to view and/or edit your selected ProcessMaker Screen. Note that your ProcessMaker user account must have appropriate Screen category permissions to view and/or edit the selected Screen.

Set Recipients for This Email Notification

These instructions continue from the Set the Email Notification's Subject and Body Content section. An email notification is an aggregate of multiple settings in the Email Notifications panel for a selected Manual Task element.

Use the Recipients setting to set which ProcessMaker users, groups, and/or non-ProcessMaker users to send this email notification. Follow these steps:

  1. From the Recipients setting, select which ProcessMaker users and/or groups to send this email notification. To remove an email recipient that is currently selected, click the icon for that selection or press Enter when the drop-down is visible.

  2. Optionally, specify email addresses for individuals who are not ProcessMaker users in your ProcessMaker instance. Follow these steps:

    1. Select the Add additional emails option. The enter email setting displays.

    2. In the enter email setting, enter the email address for the non-ProcessMaker user to receive this email notification.

    3. Click the Add icon. The non-ProcessMaker user's email address is added.

    4. Click the Delete iconto delete the non-ProcessMaker user's email address if necessary.

    5. Repeat Steps 2 through 4 as necessary for each non-ProcessMaker user's email address to receive this email notification.

Set When This Email Notification Sends

These instructions continue from the Set Recipients for This Email Notification section. An email notification is an aggregate of multiple settings in the Email Notifications panel for a selected Manual Task element.

Use the Send At or Expression settings to set when this email notification is sent. Follow these steps:

  1. Do one of the following based on when you need the email notification sent:

    • After this Task triggers or completes: From the Send At setting, select one of the following options:

      • Task Start: Select the Task Start option to send this email notification when this Manual Task triggers. This is the default option.

      • Task Completion: Select the Task Completion option to send this email notification when this Manual Task completes (when the Task assignee submits the ProcessMaker Screen associated with this manual Task).

    • Conditionally when a Request data object or Magic Variable meets a specific setting or condition: In the Expression setting, enter the expression to conditionally send the email notification when a Request data object or Magic Variable meets a specific setting or condition, and then press Enter. Specify this condition using an expression syntax described in Expression Syntax Components. Use logical operators to specify multiple conditions in that expression if necessary. If the Expression setting does not contain a value, then the Send At setting determines when to send email notifications for this Task.

  2. Click Close. This email notification is saved and displays below the Notifications setting using the Subject setting as the email notification label. Optionally do any of the following with this email notification:

Expression Syntax Components

Use the following expression syntax components to compose the expression that describes under which condition(s) an email notification sends.

Spaces are allowed before and after expression components, such as arithmetic and comparison operators, to more easily read the expression.

Combine expressions using logical operators. Example: (not approved) or (cost > 500).

Magic Variables can be used in when composing expressions.

Literals

Component

Syntax

Expression Example

string

"hello world" or 'hello world'

FullNameInput == "Louis Canera"

number

100

cost > 500

array

[value1, value2]

myFruit not in ["apples", "oranges"]

Boolean

true and false

directorSigned

Arithmetic Operations

Component

Syntax

addition

+

subtraction

-

multiplication

*

division

/

Logical Operators

Component

Syntax

not

not

and

and

or

or

Comparison Operators

Component

Syntax

equal to

==

not equal to

!=

less than

<

greater than

>

less than or equal to

<=

greater than or equal to

>=

String Operator

Component

Syntax

concatenate matches

~

Array Operators

Component

Syntax

contains

in

does not contain

not in

Range

Component

Syntax

Example

range

..

foo in 1..10

Edit an Email Notification

Follow these steps to edit an email notification:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Manual Task element from the Process model in which to edit an email notification. Panels to configure this element display.

  3. Expand the Email Notifications panel if it is not presently expanded. Email notifications display below the Notifications setting.

  4. Click the Edit iconbeside the email notification to edit.

  5. Edit the email notification settings as described in the following sections:

Copy an Email Notification

Follow these steps to copy an email notification:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Manual Task element from the Process model in which to copy an email notification. Panels to configure this element display.

  3. Expand the Email Notifications panel if it is not presently expanded. Email notifications display below the Notifications setting.

  4. Click the Duplicate iconbeside the email notification to copy. The email notification is copied.

  5. Edit the copied email notification settings as described in the following sections:

Delete an Email Notification

Consider carefully when deleting an email notification. Deleting a configured email notification cannot be undone.

Follow these steps to delete an email notification:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Manual Task element from the Process model in which to delete an email notification. Panels to configure this element display.

  3. Expand the Email Notifications panel if it is not presently expanded. Email notifications display below the Notifications setting.

  4. Click the Delete iconbeside the email notification to delete. The following message displays to confirm deletion of this email notification: Are you sure you want to delete this notification?

  5. Click Delete. The email notification deletes.

Vocabularies Panel Settings

Assign ProcessMaker Vocabularies That Validate Request Data from This Element

ProcessMaker Package Required

Your ProcessMaker instance must have the Vocabularies package installed to assign which ProcessMaker Vocabularies validate Request data at a Manual Task element. Use the Vocabularies package to maintain uniform JSON schemas across all assets in your organization. These assets include Processes, ProcessMaker Screens, and ProcessMaker Scripts.

A ProcessMaker Vocabulary is a JSON schema. The JSON schema describes the data objects, types, and structure that you want in both a machine and human readable format. Apply one or more ProcessMaker Vocabularies to your Processes and/or specific BPMN 2.0 elements in your Process models to ensure the JSON data model in Request data complies with the data structure outlined in the JSON schema that you need to meet regulatory specifications or ensure Request data contains required information.

The Vocabularies package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Vocabularies package can be installed in your ProcessMaker instance.

Permissions Required

Your ProcessMaker user account or group membership must have the following permissions to set which ProcessMaker user or group can start a Request for a Process unless your user account has the Make this user a Super Admin setting selected:

  • Processes: View Processes

  • Processes: Edit Processes

See the Process permissions or ask your ProcessMaker Administrator for assistance.

Assign ProcessMaker Vocabularies that validate Request data complies with a specific JSON schema. This is often mandatory for many types of business sectors including banking and healthcare. Ensure the quality and compliance of Request data. For example, during a Loan Application process, ensure that personal information has been included in the Request to that moment in that in-progress Request. The Vocabularies package must be installed in your ProcessMaker instance to make this configuration.

Use a ProcessMaker Vocabulary on a Manual Task element to validate Request data complies with the Vocabulary's JSON schema after the Task assignee submits the Task but prior to when the Request continues workflow. See What is a Vocabulary? for more information.

Each moment ProcessMaker evaluates workflow routing for an in-progress Request, ProcessMaker also evaluates the Request data's conformity to the ProcessMaker Vocabularies applied to the Process and/or a specific BPMN 2.0 element in the Process model. The Request's JSON data model must conform to the ProcessMaker Vocabulary's JSON schema.

During an in-progress Request, if ProcessMaker evaluates that the Request data no longer complies with all ProcessMaker Vocabularies to that moment, the Request status changes from In Progress to Error. The error displays in the Request summary. ProcessMaker Vocabularies are cumulative in an in-progress Request: as the Request progresses, if Request data does not conform with any Vocabulary's JSON schema to that moment in the Request, the Request errors.

If no ProcessMaker Vocabularies are assigned, ProcessMaker does not validate Request data complies with a specific JSON schema prior to continuing workflow for that Request.

One or more ProcessMaker Vocabularies must be created to your ProcessMaker instance before assigning a Vocabulary. See Create a New Vocabulary. Multiple ProcessMaker Vocabularies can be assigned to a Manual Task element.

Follow these steps to assign ProcessMaker Vocabularies that validate Request data from a Manual Task element:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Manual Task element from the Process model in which to assign ProcessMaker Vocabularies that validate Request data prior to when this element completes. Panels to configure this element display.

  3. Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.

  4. Click theicon to add a ProcessMaker Vocabulary. The Assign Vocabulary option displays.

  5. From the Select Vocabulary drop-down menu, select a ProcessMaker Vocabulary from which to validate Request data complies with its JSON schema.

    If no ProcessMaker Vocabularies are configured in your ProcessMaker instance, then the following message displays: List is empty. Create at least one ProcessMaker Vocabulary. See Create a New Vocabulary.

  6. Click Save.

  7. Repeat Steps 3 through 6 as necessary for each ProcessMaker Vocabulary required to validate Request data complies with its JSON schema.

Click the Remove iconfrom the Vocabularies setting to remove a ProcessMaker Vocabulary from assignment to this element.

After one or more ProcessMaker Vocabularies are assigned to a Manual Task element, the Vocabulary icon displays above that element.

Manual Task element with an assigned ProcessMaker Vocabulary

Advanced Panel Settings

Edit the Element's Identifier Value

Process Modeler automatically assigns a unique value to each Process element added to a Process model. However, an element's identifier value can be changed if it is unique to all other elements in the Process model, including the Process model's identifier value.

All identifier values for all elements in the Process model must be unique.

Follow these steps to edit the identifier value for a Manual Task element:

  1. Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.

  2. Select the Manual Task element from the Process model in which to edit its identifier value. Panels to configure this element display.

  3. Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required field.

  4. In the Node Identifier setting, edit the Task element's identifier to a unique value from all elements in the Process model and then press Enter.

Related Topics