Loading...
Loading...
Configure Event elements in your Process model.
Configure Start-type Event elements in your Process model.
Loading...
Loading...
Loading...
Loading...
Loading...
Configure Intermediate-type Event elements in your Process model.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Configure End-type Event elements in your Process model.
Loading...
Loading...
Loading...
Loading...
Loading...
Configure Boundary-type Event elements in your Process model.
Loading...
Loading...
Loading...
Loading...
Loading...
Configure Task elements in your Process model.
Loading...
Loading...
Loading...
Loading...
Configure Gateway elements in your Process model.
Loading...
Loading...
Loading...
Loading...
Loading...
Configure annotation-type elements that describe and visually depict information in your Process model. These elements do not affect workflow routing.
Loading...
Loading...
Loading...
Loading...
Configure flow indicator elements that affect workflow routing in your Process model.
Loading...
Loading...
Add, copy, delete, change the color, align, and configure Start Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Start Event element.
Your user account or group membership must have the following permissions to configure a Start Event element in 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 Administrator for assistance.
Add a Start Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Start Event element from the Explorer panel to the Process model:
Locate the Start Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The Start Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Start Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Follow these steps to add a Start Event element from the Objects bar to the Process model:
Click the Start Event object category's icon. This object's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Start Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Start Event 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 Start Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Start Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Start Event element cannot be moved outside of the Pool element.
After a Start Event element is added to a Process model, you may replace it with a different starting Request event element:
Start Timer Event element
Signal Start Event element
Message Start Event element
Conditional Start Event element
The selected Start Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Start Event element with a different Start-type event element:
Select the Start Event element to change to another Start-type event. Available options display above the selected element.
Click Confirm. The new element replaces the Start Event element with its default settings and color.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Start Event element has the following panels that contain settings:
Configuration panel
Documentation panel (available when the Documentation package is installed)
Start Permissions panel
Web Entry panel (available when the Web Entry package is installed)
Vocabularies panel (available when the Vocabularies package is installed)
Advanced panel
The Start Event element has multiple settings in the Configuration panel:
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 Start Event element:
Select the Start Event element from the Process model in which to edit its name.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
In the Name setting, edit the selected element's name and then press Enter.
When the Display the Next Assigned Task to the Task Assignee setting is used in a Start Event element, a selected Display-type Screen displays after the initial Task for this Request completes. An interstitial Screen displays while the Request resumes routing. Non-assigned automated actions run as part of that Request while the interstitial Screen displays. The interstitial Screen displays indefinitely until one of the following occurs:
The Request assigns another Task to the same Task assignee, at which time the new Task displays.
The Request completes, at which time the Request summary displays.
The user clicks a link to leave that page to display another location.
Use the Display the Next Assigned Task to the Task Assignee setting in the following ways:
Initial Task in the Request uses a Conversational-type Screen: During an automated chat-style conversation with the Request participant using the Conversational Forms package, link Conversational Screens together while the Request resumes routing based on previous conversational responses by the participant. After the Request participant responds to the conversation designed in the initial Screen, use the Display the Next Assigned Task to the Task Assignee setting to display a message and/or image while the Request routes to the next Conversational Screen. See What is a Conversational Screen? for information how to design modern-style chat experiences with Conversational Screens and the Conversational Forms package. Use this setting regardless of configuring this Start Event element to use Web Entry to start a Request. While the Web Entry panel configures which Conversational- or Form-type Screen the initial Task uses, the Display the Next Assigned Task to the Task Assignee setting indicates that a Screen displays after that initial Task completes. Web Entry is configured from the Web Entry panel, which is available if the Web Entry package is installed.
Initial Task in the Request uses a Form-type Screen: After the initial Task in the Request completes, display a message with a Display-type Screen that reads Loading your next Task. While this Screen displays, the Request routes to the next Form Task or Manual Task element's Task.
See the tabs below for more information how to use the Display the Next Assigned Task to the Task Assignee setting with Conversational- and Form-type Screens.
After selecting the Display the Next Assigned Task to the Task Assignee setting, the Screen Interstitial setting displays to select which Screen displays after the initial Task in that Request completes. This behavior is different than the default functionality, whereby the To Do Tasks page displays after each Task completes.
The Display the Next Assigned Task to the Task Assignee setting applies only for that Start Event element.
If the next Task is assigned to a different user or group, then the interstitial Screen displays until that Request completes or another Task is assigned that user.
The Display the Next Assigned Task to the Task Assignee setting has two purposes depending on whether the initial Task in that Request uses a Conversational- or Form-type Screen.
Use the Display the Next Assigned Task to the Task Assignee setting to link Conversational Screens together while the Request resumes routing based on previous conversational responses by the participant. Multiple elements and connectors may perform automatic tasks after the initial Conversational Screen's Task before the next Conversational Screen's Task triggers in that Request. However, the Request participant experiences a seamless conversation between the two Conversational Screens' Tasks while the interstitial Screen displays in the chat box. For example, use a Screen that uses an Image or Rich Text control that displays an animated GIF to imply that the other conversational participant is typing.
Non-assigned automated actions run as part of that Request while the interstitial Screen displays. When the Request assigns the next Task to that Task assignee, the new Task displays in the chat box as continued conversation in a seamless chat experience to the Request participant.
Use the Display the Next Assigned Task to the Task Assignee 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 the next Task immediately after submitting the current Task in that Request, especially if other elements and connectors are between Form Task and/or Manual Task elements so that Tasks are assigned quickly.
Follow these steps to configure a Start Event element to display an interstitial Screen after the initial Task in that Request completes:
Select the Start Event element from the Process model in which to configure it to display an interstitial Screen after the first Task completes.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Screen Interstitial drop-down menu, select which Display-type Screen to display after the initial Task in that Request completes. This is a required setting.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Select whether a user or any member of a group may start a Request:
When a Start Event element is placed into a Process model, it is not configured to indicate how a Request can start via that Start Event element. Therefore, it must be configured.
If this Start Event element is configured to start Requests anonymously via Web Entry, the settings described below are disabled because these Start Event element settings only configure which authenticated user(s) may start a Request from this element. Therefore, to configure these settings, either disable Web Entry or select that authenticated users may start Requests from this element via Web Entry. See Web Entry Panel Settings.
To allow anonymous or authenticated users to start or participate in Requests via a published URL do not configure who may start Requests from the Start Permissions panel. Configure those persons from the Web Entry panel.
Follow these steps to select which user can start a Request via this Start Event element:
Select the Start Event element from the Process model in which to select the user that may start a Request.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Start Permissions panel if it is not presently expanded. The Type setting displays.
From the Type drop-down menu, select the User option. The User drop-down menu displays below the Start Permission drop-down menu.
From the User drop-down menu, select which user can start a Request via the Start Event element. That user may start a Request.
When a Start Event element is placed into a Process model, it is not configured to indicate how a Request can start via that Start Event element. Therefore, it must be configured.
Follow these steps to select which group members can start a Request via this Start Event element:
Select the Start Event element from the Process model in which to select the group that may start a Request.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Start Permissions panel if it is not presently expanded. The Type setting displays.
From the Type drop-down menu, select the Group option. The Group drop-down menu displays below the Start Permission drop-down menu.
From the Group drop-down menu, select which group can start a Request via the Start Event element. Any member of that group may start a Request.
When a Start Event element is placed into a Process model, Web Entry settings for that element are disabled. Therefore, even if the Web Entry package is installed, it must be configured for use.
In overview, configuring Web Entry involves making the following decisions:
Who may start the Request: Decide to allow any person to start the Request via Web Entry anonymously or only the authenticated user(s) specified from the Start Permissions panel. In conjunction, decide the following based on who may start the Request:
Anonymously: Decide one or both of the following:
Password-protect access to the Web Entry.
Read query string parameters suffixed as JSON key name and value pairs to the Web Entry's base URL to be included in that Request's data. This setting is useful to suffix metadata for email campaigns. For example, if the Web Entry's base URL is http://pm/webentry/7/node_24
, add parameters to the URL that represent the JSON key name and value pairs to add to that Request such as http://pm/webentry/7/node_24?data1=123&data2=456
. Parameters are interpreted as strings.
Authenticated user: Read query string parameters as described above.
Screen for the chat or Task: Select from which Screen the Request starter interacts with this Request. This may be one of the following types of Screens:
Conversational-type: The Request starter interacts in an automated chat-style correspondence by responding to questions and responses, and then either submits the chat or the Screen submits itself if it times out from interaction. The Conversational-type Screen is available only if the Conversational Forms package is installed.
Form-type: The Request starter enters information into an interactive form, and then submits it to start the Request.
Completed action after Screen submission: Decide whether to display a separate Screen when the initial Screen submits or to route that person to a URL. If to display a Screen, select that Screen.
Embed the Web Entry into a third-party site: If embedding the Web Entry into a third-party site, decide one or both of the following:
Embed the Web Entry if using a Form-type Screen: Copy the JavaScript that contains the Web Entry URL, and then embed that JavaScript into your Web server's or blog's HTML header.
Embed the Web Entry if using a Conversational-type Screen: Copy the JavaScript that contains the Web Entry URL, configure options how the chat-style presentation displays in your site, and then embed that JavaScript into your Web server's or blog's HTML header.
The Web Entry package must be installed to select who can start a Request via Web Entry. The Web Entry package allows anonymous or authenticated users to start or participate in Requests via a published URL.
Follow these steps to select who can start a Request via a Web Entry URL from this Start Event element:
Select the Start Event element from the Process model in which to select who may start a Request via a Web Entry URL.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Web Entry panel if it is not presently expanded. The Web Entry setting displays.
From the Mode drop-down menu, select one of the following options:
Disabled: Select the Disabled setting to disable Web Entry for this Start Event element when this element currently is configured to do so. This is the default setting.
Anonymous: Select the Anonymous option to allow any person who has access to the Web Entry's URL to start a Request. This person is not authenticated as a user. As a best practice, use Anonymous Web Entry URLs when an active session will not be used in the same Web browser. Note that if an anonymous person starts a Request and a later Form Task element or Manual Task element is assigned to the Request starter, ensure that the anonymous person enters an email address for that Task or chat-style interaction. Otherwise, that person cannot receive notifications for the subsequent Task. If this happens, the following Request error occurs: This process was started by an anonymous user so this task can not be assigned to the requester. Therefore, use this option cautiously.
If selecting the Anonymous option, consider selecting the Enable Password Protect setting below the Completed Action setting (described below) to require a password to access the Web Entry.
If selecting the Authenticated option, consider selecting the Allow query string data setting below the Completed Action setting (described below) to read JSON key name and value pairs from the Web Entry's base URL to be included in that Request's data.
From the Screen Associated drop-down menu, select the Screen that displays when the Web Entry URL is accessed. This drop-down menu displays only Conversational and Form types so the Request starter can interact with information in the Screen. This is a required setting.
Optionally, click the Open Screen link to open the selected Screen in a separate Web browser window.
From the Completed Action drop-down menu, select one of the following options:
Screen: Select the Screen option to indicate that a Screen displays after the Requester submits the Screen selected from the Screen Associated drop-down menu described above. Screen is the default setting.
After the Screen option is selected, the Screen For Completed setting displays below the Completed Action option. From the Screen For Completed drop-down menu, select the Screen that displays after submitting the Screen selected from the Screen Associated drop-down menu. This drop-down menu displays only Display types to display a message to the request starter. This is a required setting.
Optionally, click the Open Screen link to open the selected Screen in a separate Web browser window.
URL: Select the URL option to indicate that the Request starter is redirected to a URL after the Request starter submits the Screen selected from the Screen Associated drop-down menu.
In the Password Protect setting, enter the password that the anonymous Request starter must enter to access the Web Entry.
Select the Allow query string data setting to read JSON key name and value pairs from the Web Entry's base URL to be included in that Request's data. This setting is useful to suffix metadata for email campaigns. For example, if the Web Entry's base URL is http://pm/webentry/7/node_24
, add parameters to the URL that represent the JSON key name and value pairs to add to that Request such as http://pm/webentry/7/node_24?data=123&data2=456
. Parameters are interpreted as strings.
The Web Entry URL displays the Web Entry URL from which the Request starter accesses the Web Entry. ProcessMaker Platform generates this URL using the following structure: ProcessMaker Platform instance domain
/webentry/
Web Entry numerical instance
/
Identifier Value of this Start Event element
. If necessary, click the Copy button below the Web Entry URL setting to copy the Web Entry URL so that it is available in your clipboard.
Optionally, customize the Web Entry URL using Request variable values as URL parameters. Reference these Request variable values using single curly brackets surrounding each Request variable name, such as {variableName}
, in the custom URL.
Follow these steps to customize the Web Entry URL:
Click the Options button below the Web Entry URL setting. The URL Options screen displays. By default the Standard URL option is enabled, indicating that the automatically generated URL is used for this Web Entry.
Enter as many parameters as necessary. Use the following icons to remove or sort the order of added URL parameters:
Click Save to exit the URL Options screen with the saved custom Web Entry URL settings.
Configure how the chat box displays in the embedded container from the following options:
From the Position setting, select one of the following options:
Fill Container: The chat box displays the width of the container to which the Web Entry's JavaScript code is applied. This is the default setting. When the Fill Container setting is selected, all other settings in the Embed Options screen are disabled.
Top Left: The chat box displays in the top left corner of the container to which the Web Entry's JavaScript code was applied.
Top Right: The chat box displays in the top right corner of the container to which the Web Entry's JavaScript code was applied.
Bottom Left: The chat box displays in the bottom left corner of the container to which the Web Entry's JavaScript code was applied.
Bottom Right: The chat box displays in the bottom right corner of the container to which the Web Entry's JavaScript code was applied.
In the Title setting, enter the title that displays in the chat box. Form is the default setting. This setting does not apply when the Fill Container option is selected from the Position setting.
From the Color setting, select the color that displays for button to show the chat box and for the chat box frame itself. The left-most color option is the default. This setting does not apply when the Fill Container option is selected from the Position setting.
From the Icon setting, select an icon that displays to show the chat box. The Question Circle is the default option. This setting does not apply when the Fill Container option is selected from the Position setting.
Click Save.
The Start Event element's icon changes to indicate that this element uses Web Entry to trigger.
Assign 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 to make this configuration.
Use a Vocabulary on a Start Event element when using the Web Entry package. After the Request data is submitted from the Web Entry, Vocabularies assigned to the Start Event element validate the Request data complies with the Vocabulary's JSON schema. See What is a Vocabulary? for more information. See Select Who Can Start a Request via a Web Entry for information how to use the Web Entry package on a Start Event element.
Each moment ProcessMaker Platform evaluates workflow routing for an in-progress Request, ProcessMaker Platform also evaluates the Request data's conformity to the 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 Vocabulary's JSON schema.
During an in-progress Request, if ProcessMaker Platform evaluates that the Request data no longer complies with all Vocabularies to that moment, the Request status changes from In Progress to Error. The error displays in the Request summary. 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 Vocabularies are assigned, ProcessMaker Platform does not validate Request data complies with a specific JSON schema prior to continuing workflow for that Request.
One or more Vocabularies must be created before assigning a Vocabulary. See Create a New Vocabulary. Multiple Vocabularies can be assigned to a Start Event element.
The Vocabularies package must be installed to assign which Vocabularies validate Request data at a Start Event element. Use the Vocabularies package to maintain uniform JSON schemas across all assets in your organization. These assets include Processes, Screens, and Scripts.
A 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 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.
Follow these steps to assign Vocabularies that validate Request data from a Start Event element:
Select the Start Event element from the Process model in which to assign Vocabularies that validate Request data prior to when this element completes.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.
From the Select Vocabulary drop-down menu, select a Vocabulary from which to validate Request data complies with its JSON schema.
If no Vocabularies are configured, then the following message displays: List is empty. Create at least one Vocabulary. See Create a New Vocabulary.
Click Save.
Repeat Steps 3 through 6 as necessary for each Vocabulary required to validate Request data complies with its JSON schema.
After one or more Vocabularies are assigned to a Start Event element, the Vocabulary icon displays above that element.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Start Event element:
Select the Start Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the Start Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Signal Start Event elements in your Process model.
Your user account or group membership must have the following permissions to configure a Signal Start Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add a Signal Start Event element from one of the following locations in Process Modeler:
Follow these steps to add a Signal Start Event element from the Explorer panel to the Process model:
Locate the Start Event object category from one of the following locations in the Explorer panel:
Object Category: The Start Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Timer Event element cannot be placed outside of the Pool element.
Follow these steps to add a Signal Start Event element from the Objects bar to the Process model:
Click the Start Event object category's icon, and then click the Signal Start Event element. This element's icon's displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving a Signal Start Event element has the following limitations in regards to the following Process model elements:
Lane element: If the Signal Start Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Signal Start Event element cannot be moved outside of the Pool element.
The selected Signal Start Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Signal Start Event element with a different Start-type event element:
Select the Signal Start Event element to change to another Start-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Signal Start Event element with its default settings and color.
The Signal Start Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 Signal Start Event element:
Select the Signal Start Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to select the Signal that triggers the Signal Start Event element:
Select the Signal Start Event element from the Process model in which to select the Signal that triggers it.
When the Signal Start Event element receives a broadcasting Signal for which it is listening, enter the Request variable that stores the Request data in the broadcasting Signal's payload. The Request data within the broadcasting Signal may then be used in the new Request that the Signal Start Event element starts.
Follow these steps to enter the Request variable to store the broadcasting Signal's payload:
Select the Signal Start Event element from the Process model in which to enter the Request variable.
In the Request Variable setting, enter the name of the Request Variable to store the broadcasting Signal's payload and then press Enter.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Signal Start Event element:
Select the Signal Start Event element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Signal Start Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Start Event object category.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Event element cannot be placed outside of the Pool element.
Ensure that the Start Event object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Event element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays Start-type event elements.
Select the element to replace the Start Event element. The Change Type screen displays to confirm replacing the currently selected element.
Following the Start Event element is a Script Task element: If a Script Task element immediately follows the Start Event element (see below), use the Display the Next Assigned Task to the Task Assignee setting to trigger any Form Task element or Manual Task element that follows the Script Task element.
Locate the Display Next Assigned Task to Task Assignee setting.
Select the Display Next Assigned Task to Task Assignee setting. The Screen Interstitial setting displays.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Authenticated: Select the Authenticated option to require an authenticated user or group member to start a Request via the Web Entry's URL. If an authenticated user or group member is already selected from the Start Permissions panel, then only those user(s) may start a Request via Web Entry from this Start Event element.
After the URL option is selected, the Redirect URL setting display below the Completed Action option. From the Redirect URL setting, enter the URL to which the Request starter redirects after submitting the Screen selected from the Screen Associated drop-down menu, and then press Enter. The redirect URL supports mustache syntax to reference the value of a Request variable as the URL. This is a required setting.
If the Anonymous option is selected from the Mode setting, the Enable Password Protect setting displays.
Select the Enable Password Protect setting to require a password to access the Web Entry. If the Enable Password Project setting is selected, the Password Protect setting displays below it.
Select the Custom URL setting. Settings enable below the Custom URL setting. The Web Entry URL Preview setting displays the currently customized Web Entry URL. If necessary, click the Copy button below the Web Entry URL Preview setting to copy this custom URL.
In the First URL segment setting, enter the base segment that displays after your base ProcessMaker Platform instance component of the Web Entry URL. A forward slash (/
) precedes the first URL segment. The first URL segment must be unique to other Web Entry URLs from other Start Event elements in this Process, and may only use alphanumeric characters. This setting is required. In the example below, baseurl
is the first URL segment.
Use the URL parameters setting to enter custom parameters in the Web Entry URL based on Request variable name values. In the Name... setting, enter the Request variable name from which to reference its value for the Web Entry URL, and then click the Add Parameter button. That parameter displays within the URL parameters setting with single curly brackets ({
}
) surrounding it. In the example below, city
is a Request variable name from which to reference its value for the custom Web Entry URL.
Delete: Click the Delete iconto delete the selected parameter from the Web Entry URL.
Sort order: Hold and drag theicon to sort the order of parameters in the Web Entry URL. Sort parameters in the URL parameters setting from top to bottom as they are to display left to right in the custom URL.
The Embed Code setting displays the JavaScript that contains the Web Entry URL to embed into your Web server's or blog's HTML header. If necessary, click the Copy button below the Embed Code setting to copy the Web Entry URL so that it is available in your clipboard.
If this Start Event element's Web Entry uses a Conversational-type Screen to provide a chat-style interaction with the Request starter, optionally click the Options button below the Embed Code setting to configure how the chat box displays in the embedded container to which the Web Entry's JavaScript code is applied. When the Options button is clicked, the Embed Options screen displays.
Click theicon to add a Vocabulary. The Assign Vocabulary option displays.
Click the Remove iconfrom the Vocabularies setting to remove a Vocabulary from assignment to this element.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Start Event object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the Start Event object category.
Click the Elements drop-down menu, and then select the Signal Start Event option.
The Signal Start Event element displays.
Ensure that the Start Event object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Signal Start Event element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Signal Start Event element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Signal Start Event element inside the Pool element closest to where you attempt to move it.
After a Signal Start Event element is , you may replace it with a different starting event element:
element
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the Start-type event elements.
Select the element to replace the Signal Start Event element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
.
A Signal Start Event element starts a Request for a Process when it triggers by receiving a specific from a broadcasting element in any other Request. The element that broadcasts the Signal does not need to be in the same Process model as the Signal Start Event element to receive the broadcast. Select the Signal that triggers this element.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting.
From the Signal drop-down menu, select the Signal that triggers this element. This setting is required. To know more about Signals, see .
.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Request Variable setting.
.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Add, copy, delete, change the color, align, and configure Message Start Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Message Start Event element.
Your user account or group membership must have the following permissions to configure a Message Start Event element in 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 Administrator for assistance.
Add a Message Start Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Message Start Event element from the Explorer panel to the Process model:
Locate the Start Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The Start Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Start Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Timer Event element cannot be placed outside of the Pool element.
Follow these steps to add a Message Start Event element from the Objects bar to the Process model:
Click the Start Event object category's icon, and then click the Message Start Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Message Start Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Message Start Event 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 Message Start Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Message Start Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Message Start Event element cannot be moved outside of the Pool element.
After a Message Start Event element is added to a Process model, you may replace it with a different starting Request event element:
Start Event element
Start Timer Event element
Signal Start Event element
Conditional Start Event element
The selected Message Start Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Message Start Event element with a different Start-type event element:
Select the Message Start Event element to change to another Start-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Message Start Event element with its default settings and color.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Message Start Event element has the following panels that contain settings:
Configuration panel
Documentation panel (available when the Documentation package is installed)
Advanced panel
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 Message Start Event element:
Select the Message Start Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
An Message Start Event element starts a Request when that element receives a message from either an Intermediate Message Throw Event element or a Message End Event element (but not both) located in a different Pool element than the Message Start Event element receiving the message. After the Message Start Event element receives its message, that element triggers. Select from which element to listen for a message based on the Intermediate Message Throw Event or Message End Event element's Message Name setting value.
Follow these steps to select from which element to listen for a message to trigger the Message Start Event element:
Select the Message Start Event element from the Process model in which to select the Process model element from which to listen for a message.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Listen For Message drop-down menu, select from which element to listen for a message based on its Message Name setting value.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Message Start Event element:
Select the Message Start Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Message Start Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Intermediate Timer Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Intermediate Timer Event element.
Your user account or group membership must have the following permissions to configure an Intermediate Timer Event element in 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 Administrator for assistance.
Add an Intermediate Timer Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add an Intermediate Timer Event element from the Explorer panel to the Process model:
Locate the Intermediate Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The Intermediate Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Intermediate Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Follow these steps to add an Intermediate Timer Event element from the Objects bar to the Process model:
object category
Click the Intermediate Event object category's icon. This object's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving an Intermediate Timer Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Intermediate Timer Event 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 Intermediate Timer Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Intermediate Timer Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Intermediate Timer Event element cannot be moved outside of the Pool element.
After an Intermediate Timer Event element is added to a Process model, you may replace it with a different intermediate Request event element:
Intermediate Signal Catch Event element
Intermediate Signal Throw Event element
Intermediate Message Catch Event element
Intermediate Message Throw Event element
The selected Intermediate Timer Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Intermediate Timer Event element with a different Intermediate-type event element:
Select the Intermediate Timer Event element to change to another Intermediate-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Intermediate Timer Event element with its default settings and color.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Intermediate Timer Event element has the following panels that contain settings:
Configuration panel
Timing Control panel
Documentation panel (available when the Documentation package is installed)
Advanced panel
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 an Intermediate Timer Event element:
Select the Intermediate Timer Event element from the Process model in which to edit its name.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
In the Name setting, edit the selected element's name and then press Enter.
When an Intermediate Timer Event element is placed into a Process model, it is set to delay one (1) hour before it triggers. If this is not the timing control setting you want, the Intermediate Timer Event element must be configured. Set the timer controls for an Intermediate Timer Event element using one of the following methods:
Set an interval in which to delay triggering the Intermediate Time Event element in a specified number of days, weeks, months, or years.
Set the date and hour when the trigger the Intermediate Timer Event element.
Configure a cycle in which to trigger the Intermediate Timer Event element at repeated intervals.
Follow these steps to set the timer controls for an Intermediate Timer Event element:
Select the Intermediate Timer Event element from the Process model in which to set its timer controls.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Timing Control panel if it is not presently expanded. The Type setting displays.
Do one of the following to set the timer control:
Delay the timer: From the Type drop-down menu, select the Delay option. Delay is the default setting. From the Delay setting, select at which interval of time to trigger the Intermediate Timer Event element. 1 hour is the default setting. Then select one of the following time periods for that element to trigger:
Minute
Hour (default setting)
Day
Month
Set date and time to trigger the Intermediate Timer Event element: From the Type drop-down menu, select the Date/Time option. The Wait until specific date/time setting displays.
From the Wait until specific date/time setting, use the date control to select the date and time to trigger the Intermediate Timer Event element. If this setting has not been previously set, the current date is the default.
From the Recurring loop repeats at time interval set below setting, select at which interval of time to trigger the Intermediate Timer Event element. 1 hour is the default setting. Then select one of the following time periods for that element to trigger:
Minute
Hour (default setting)
Day
Month
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Intermediate Timer Event element:
Select the Intermediate Timer Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the Intermediate Timer Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Start Timer Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Start Timer Event element.
Your user account or group membership must have the following permissions to configure a Start Timer Event element in 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 Administrator for assistance.
Add a Start Timer Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Start Timer Event element from the Explorer panel to the Process model:
Locate the Start Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The Start Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Start Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Timer Event element cannot be placed outside of the Pool element.
Follow these steps to add a Start Timer Event element from the Objects bar to the Process model:
Click the Start Event object category's icon, and then click the Start Timer Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Start Timer Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Start Timer Event 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 Start Timer Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Start Timer Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Start Timer Event element cannot be moved outside of the Pool element.
After a Start Timer Event element is added to a Process model, you may replace it with a different starting Request event element:
Start Event element
Signal Start Event element
Message Start Event element
Conditional Start Event element
The selected Start Timer Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Start Timer Event element with a different Start-type event element:
Select the Start Timer Event element to change to another Start-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Start Timer Event element with its default settings and color.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Start Timer Event element has the following panels that contain settings:
Configuration panel
Timing Control panel
Documentation panel (available when the Documentation package is installed)
Advanced panel
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 Start Timer Event element:
Select the Start Timer Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
When a Start Timer Event element is placed into a Process model, it has the following settings by default before it triggers:
The timing control is set to midnight of the current date.
The timing control is set to repeat weekly on the current day.
If these are not the timing control settings you want, the Start Timer Event element must be configured. Set the timer controls for a Start Timer Event element using the following parameters:
Set the date and hour when the trigger the Start Timer Event element, thereby starting a Request.
Optionally, set an interval from which to periodically trigger the Start Time Event element, thereby staring a Request at that interval. This may be done in any of the following intervals:
Set the timer to periodically trigger on a specified number of days, weeks, months, or years.
Set the timer to periodically trigger on specific days of the week.
Set when the timer control ends from any of the following options, thereby limiting when to start a Request:
The timer never ends.
The timer ends on a specified date.
The timer ends after a number of occurrences.
Follow these steps to set the timer controls for a Start Timer Event element:
Select the Start Timer Event element from the Process model in which to set its timer controls.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Timing Control panel if it is not presently expanded. The Start date setting displays.
From the Start date setting, use the date control to select the date to initially trigger the Start Timer Event element. If this setting has not been previously set, the current date is the default.
Set the periodic interval to trigger the Start Timer Event element again, thereby starting a new Request. Follow these guidelines:
From the Repeat every setting, select at how many intervals of a set time period to trigger the Start Timer Event element. 1 week is the default setting. Then select one of the following time periods for that element to trigger:
Day
Week (default setting)
Month
Year
Alternatively, select from the Repeat on setting the day(s) of the week in which to trigger the Start Timer Event element. Selected days display with a blue-colored circle around each.
Set when to end the timer control from the following options:
Select Never to never end the timer control. Never is the default setting.
Select On to select a specific date in which to end the timer control. If this setting has not been previously set, the current date is the default.
Select After and then enter how many occurrences to end the timer control after the Start Timer Event element has triggered that may times. If this setting has not been previously set, 1 is the default setting.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Start Timer Event element:
Select the Start Timer Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the Start Timer Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Intermediate Signal Catch Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Intermediate Signal Catch Event element.
Your user account or group membership must have the following permissions to configure an Intermediate Signal Catch Event element in 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 Administrator for assistance.
Add an Intermediate Signal Catch Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add an Intermediate Signal Catch Event element from the Explorer panel to the Process model:
Locate the Intermediate Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The Intermediate Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Intermediate Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Signal Catch Event element cannot be placed outside of the Pool element.
Follow these steps to add an Intermediate Signal Catch Event element from the Objects bar to the Process model:
Click the Intermediate Event object category's icon, and then click the Intermediate Signal Catch Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving an Intermediate Signal Catch Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Intermediate Signal Catch Event 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 Intermediate Signal Catch Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Intermediate Signal Catch Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Intermediate Signal Catch Event element cannot be moved outside of the Pool element.
After an Intermediate Signal Catch Event element is added to a Process model, you may replace it with a different intermediate Request event element:
Intermediate Timer Event element
Intermediate Signal Throw Event element
Intermediate Message Catch Event element
Intermediate Message Throw Event element
The selected Intermediate Signal Catch Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Intermediate Signal Catch Event element with a different Intermediate-type event element:
Select the Intermediate Signal Catch Event element to change to another Intermediate-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Intermediate Signal Catch Event element with its default settings and color.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Intermediate Signal Catch Event element has the following panels that contain settings:
Documentation panel (available when the Documentation package is installed)
Advanced panel
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 an Intermediate Signal Catch Event element:
Select the Intermediate Signal Catch Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
An Intermediate Signal Catch Event element pauses a Request until that element receives a specific broadcast from a broadcasting element in any other Request in that ProcessMaker Platform instance. The element that broadcasts the Signal does not need to be in the same Process model as the Intermediate Signal Catch Event element that receives the broadcast. Select the Signal that triggers this element.
Follow these steps to select the Signal that triggers the Intermediate Signal Catch Event element:
Select the Intermediate Signal Catch Event element from the Process model in which to select the Signal that triggers it.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Do one of the following:
The Signal to trigger this element exists:
From the Signal drop-down menu, select the Signal that triggers this element. This setting is required.
The Signal to trigger this element does not exist:
In the ID setting, enter the unique ID of this Signal. The Signal ID may only contain non-special characters and without spaces. This Signal ID must be unique from all other signal IDs. If the entered Signal ID already exists, the following text displays below the setting: Signal ID is duplicated. Note that the Signal ID cannot be edited after the Signal is created.
Consider the following when entering the Signal ID value:
Signal IDs must be unique and accept alphanumeric characters only.
A Signal that corresponds with a User Signal must have the Signal ID value that corresponds with that User Signal's event. See What is a User Signal?. Ensure that the User Signal is enabled for use.
This is a required setting.
In the Name setting, enter the unique alphanumeric name of this Signal. This Signal name must be unique from all other Signal names. This Signal name displays when selecting a Signal from other elements that can broadcast or listen for a Signal. If the entered Signal name already exists, the following text displays below the setting: Signal Name is duplicated. This is a required setting.
Click Save. The Signal is created.
From the Signal drop-down menu, select the new Signal that triggers this element. This setting is required.
Save your Process model. The new Signal is added to Signal Manager.
Editing the name of a Signal changes that signal's name. This Signal name displays when selecting a Signal from other elements that can broadcast or listen for a Signal.
Follow these steps to edit the name of a Signal:
Select any element from the Process model that broadcasts or listens for a Signal.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Name setting, edit the name of the Signal as necessary.
Click Save.
Save your Process model. The name of the Signal also changes in Signal Manager.
A Signal cannot be delete if any other Signal subscribes to it. When attempting to delete a Signal with any subscribing element, a message displays with which element(s) subscribes to that Signal.
Carefully consider whether to delete a Signal. Deleting a Signal makes that Signal unavailable when configuring all elements that broadcast or listen to Signals throughout your ProcessMaker Platform instance.
Deleting a Signal cannot be undone.
Follow these steps to delete a Signal:
Select any element from the Process model that broadcasts or listens for a Signal.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
If the Signal is subscribed to by another element anywhere in your ProcessMaker Platform instance, that Signal cannot be deleted. A message displays by which element(s) subscribes to this Signal.
Click Delete.
When the Intermediate Signal Catch Event element receives a broadcasting Signal for which it is listening, enter the Request variable that stores the Request data in the broadcasting Signal's payload. The Request data within the broadcasting Signal may then be used in the paused Request when the Intermediate Signal Catch Event element resumes that Request.
Follow these steps to enter the Request variable to store the broadcasting Signal's payload:
Select the Intermediate Signal Catch Event element from the Process model in which to enter the Request variable.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Request Variable setting, enter the name of the Request Variable to store the broadcasting Signal's payload and then press Enter.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Intermediate Signal Catch Event element:
Select the Intermediate Signal Catch Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Intermediate Signal Catch Event element's identifier to a unique value from all node in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Intermediate Message Throw Event elements in your Process model.
Your user account or group membership must have the following permissions to configure an Intermediate Message Throw Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add an Intermediate Message Throw Event element from one of the following locations in Process Modeler:
Follow these steps to add an Intermediate Message Throw Event element from the Explorer panel to the Process model:
Locate the Intermediate Event object category from one of the following locations in the Explorer panel:
Object Category: The Intermediate Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Message Throw Event element cannot be placed outside of the Pool element.
Follow these steps to add an Intermediate Message Throw Event element from the Objects bar to the Process model:
Click the Intermediate Event object category's icon, and then click the Intermediate Message Throw Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving an Intermediate Message Throw Event element has the following limitations in regards to the following Process model elements:
Lane element: If the Intermediate Message Throw Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Intermediate Message Throw Event element cannot be moved outside of the Pool element.
The selected Intermediate Message Throw Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Intermediate Message Throw Event element with a different intermediate Request event element:
Select the Intermediate Message Throw Event element to change to another intermediate Request event element. Available options display above the selected element.
Click Confirm. The new element replaces the Intermediate Message Throw Event element with its default settings and color.
The Intermediate Message Throw Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 an Intermediate Message Throw Event element:
Select the Intermediate Message Throw Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to configure the message name for an Intermediate Message Throw Event element:
Select the Intermediate Message Throw Event element from the Process model in which to configure its message name.
In the Message Name setting, edit the message name that a catching element references to listen for the Intermediate Message Throw Event's message.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Intermediate Message Throw Event element:
Select the Intermediate Message Throw Event element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Intermediate Message Throw Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Intermediate Conditional Catch Event elements in your Process model.
Your user account or group membership must have the following permissions to configure an Intermediate Conditional Catch Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add an Intermediate Conditional Catch Event element from one of the following locations in Process Modeler:
Follow these steps to add an Intermediate Conditional Catch Event element from the Explorer panel to the Process model:
Locate the Intermediate Event object category from one of the following locations in the Explorer panel:
Object Category: The Intermediate Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Conditional Catch Event element cannot be placed outside of the Pool element.
Follow these steps to add an Intermediate Conditional Catch Event element from the Objects bar to the Process model:
Click the Intermediate Event object category's icon, and then click the Intermediate Conditional Catch Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving an Intermediate Conditional Catch Event element has the following limitations in regards to the following Process model elements:
Lane element: If the Intermediate Conditional Catch Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Intermediate Conditional Catch Event element cannot be moved outside of the Pool element.
The selected Intermediate Conditional Catch Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Intermediate Conditional Catch Event element with a different intermediate Request event element:
Select the Intermediate Conditional Catch Event element to change to another intermediate Request event element. Available options display above the selected element.
Click Confirm. The new element replaces the Intermediate Conditional Catch Event element with its default settings and color.
The Intermediate Conditional Catch Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 an Intermediate Conditional Catch Event element:
Select the Intermediate Signal Catch Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to enter the Request conditions that trigger an Intermediate Conditional Catch Event element:
Select the Intermediate Conditional Catch Event element from the Process model in which to edit its name.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Intermediate Signal Catch Event element:
Select the Intermediate Conditional Catch Event element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Intermediate Conditional Catch Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Intermediate Message Catch Event elements in your Process model.
Your user account or group membership must have the following permissions to configure an Intermediate Message Catch Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add an Intermediate Message Catch Event element from one of the following locations in Process Modeler:
Follow these steps to add an Intermediate Message Catch Event element from the Explorer panel to the Process model:
Locate the Intermediate Event object category from one of the following locations in the Explorer panel:
Object Category: The Intermediate Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Message Catch Event element cannot be placed outside of the Pool element.
Follow these steps to add an Intermediate Message Catch Event element from the Objects bar to the Process model:
Click the Intermediate Event object category's icon, and then click the Intermediate Message Catch Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving an Intermediate Message Catch Event element has the following limitations in regards to the following Process model elements:
Lane element: If the Intermediate Message Catch Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Intermediate Message Catch Event element cannot be moved outside of the Pool element.
The selected Intermediate Message Catch Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Intermediate Message Catch Event element with a different intermediate Request event element:
Select the Intermediate Message Catch Event element to change to another intermediate Request event element. Available options display above the selected element.
Click Confirm. The new element replaces the Intermediate Message Catch Event element with its default settings and color.
The Intermediate Message Catch Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 an Intermediate Message Catch Event element:
Select the Intermediate Message Catch Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to select the element from which to listen for a message:
Select the Intermediate Message Catch Event element from the Process model in which to configure how it is triggered.
From the Listen For Message drop-down menu, select from which Intermediate Message Throw Event element or End Event element triggers the Intermediate Message Catch Event element.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Each moment ProcessMaker evaluates workflow routing for an in-progress Request, ProcessMaker Platform also evaluates the Request data's conformity to the 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.
If no Vocabularies are assigned, ProcessMaker Platform does not validate Request data complies with a specific JSON schema prior to continuing workflow for that Request.
A 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 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.
Follow these steps to assign Vocabularies that validate Request data from an Intermediate Message Catch Event element:
Select the Intermediate Message Catch Event element from the Process model in which to assign Vocabularies that validate Request data prior to when this element completes.
Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.
From the Select Vocabulary drop-down menu, select a Vocabulary from which to validate Request data complies with its JSON schema.
Click Save.
Repeat Steps 3 through 6 as necessary for each Vocabulary required to validate Request data complies with its JSON schema.
After one or more Vocabularies are assigned to an Intermediate Message Catch Event element, the Vocabulary icon displays above that element.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Intermediate Message Catch Event element:
Select the Intermediate Message Catch Event element from the Process model in which to edit its identifier value.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the Intermediate Message Catch Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Intermediate Signal Throw Event elements in your Process model.
Your user account or group membership must have the following permissions to configure an Intermediate Signal Throw Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add an Intermediate Signal Throw Event element from one of the following locations in Process Modeler:
Follow these steps to add an Intermediate Signal Throw Event element from the Explorer panel to the Process model:
Locate the Intermediate Event object category from one of the following locations in the Explorer panel:
Object Category: The Intermediate Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Signal Throw Event element cannot be placed outside of the Pool element.
Follow these steps to add an Intermediate Signal Throw Event element from the Objects bar to the Process model:
Click the Intermediate Event object category's icon, and then click the Intermediate Signal Throw Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving an Intermediate Signal Throw Event element has the following limitations in regards to the following Process model elements:
Lane element: If the Intermediate Signal Throw Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Intermediate Signal Throw Event element cannot be moved outside of the Pool element.
The selected Intermediate Signal Throw Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Intermediate Signal Throw Event element with a different Intermediate-type event element:
Select the Intermediate Signal Throw Event element to change to another Intermediate-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Intermediate Signal Throw Event element with its default settings and color.
The Intermediate Signal Throw Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 an Intermediate Signal Throw Event element:
Select the Intermediate Signal Throw Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
An Intermediate Signal Throw Event element broadcasts a specific Signal that contains part or all of its current Request data when it triggers to all elements throughout that ProcessMaker Platform instance listening for that Signal. The element that listens for the broadcast Signal does not need to be in the same Process model as the Intermediate Signal Throw Event element. Select the Signal that this element broadcasts.
Follow these steps to select the Signal that the Intermediate Signal Throw Event element broadcasts:
Select the Intermediate Signal Throw Event element from the Process model in which to select the Signal that it broadcasts.
Do one of the following:
The Signal to trigger this element exists:
From the Signal drop-down menu, select the Signal that triggers this element. This setting is required.
The Signal to trigger this element does not exist:
In the ID setting, enter the unique ID of this Signal. The Signal ID may only contain non-special characters and without spaces. This Signal ID must be unique from all other signal IDs. If the entered Signal ID already exists, the following text displays below the setting: Signal ID is duplicated. Note that the Signal ID cannot be edited after the Signal is created. Consider the following when entering the Signal ID value:
Signal IDs must be unique and accept alphanumeric characters only.
This is a required setting.
In the Name setting, enter the unique alphanumeric name of this Signal. This Signal name must be unique from all other Signal names. This Signal name displays when selecting a Signal from other elements that can broadcast or listen for a Signal. If the entered Signal name already exists, the following text displays below the setting: Signal Name is duplicated. This is a required setting.
Click Save. The Signal is created.
From the Signal drop-down menu, select the new Signal that triggers this element. This setting is required.
Editing the name of a Signal changes that signal's name. This Signal name displays when selecting a Signal from other elements that can broadcast or listen for a Signal.
Follow these steps to edit the name of a Signal:
Select any element from the Process model that broadcasts or listens for a Signal.
In the Name setting, edit the name of the Signal as necessary.
Click Save.
A Signal cannot be delete if any other Signal subscribes to it. When attempting to delete a Signal with any subscribing element, a message displays with which element(s) subscribes to that Signal.
Carefully consider whether to delete a Signal. Deleting a Signal makes that Signal unavailable when configuring all elements that broadcast or listen to Signals throughout your ProcessMaker Platform instance.
Deleting a Signal cannot be undone.
Follow these steps to delete a Signal:
Select any element from the Process model that broadcasts or listens for a Signal.
If the Signal is subscribed to by another element anywhere in your ProcessMaker Platform instance, that Signal cannot be deleted. A message displays by which element(s) subscribes to this Signal.
Click Delete.
Configure the contents of the broadcasting Signal's payload when the Intermediate Signal Throw Event element triggers:
Send no Request data in the Signal's payload, thereby sending no data. All elements configured to listen for the broadcasting Signal trigger, but no data from the Intermediate Signal Throw Event element's Request can be referenced from the receiving element.
Send all current Request data in the Signal's payload.
Follow these steps to select the contents of the Signal's payload that the Intermediate Signal Throw Event element broadcasts:
Select the Intermediate Signal Throw Event element from the Process model in which to select contents of the Signal's payload.
From the Signal Payload drop-down menu, select one of the following options:
No Request Data: Select No Request Data to send no Request data in the Signal's payload.
All Request Data: Select All Request Data to send all current Request data in the Signal's payload.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Intermediate Signal Throw Event element:
Select the Intermediate Signal Throw Event element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Intermediate Signal Throw Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Message End Event elements in your Process model.
Your user account or group membership must have the following permissions to configure a Message End Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add a Message End Event element from one of the following locations in Process Modeler:
Follow these steps to add a Message End Event element from the Explorer panel to the Process model:
Locate the End Event object category from one of the following locations in the Explorer panel:
Object Category: The End Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Message End Event element cannot be placed outside of the Pool element.
Follow these steps to add a Message End Event element from the Objects bar to the Process model:
Click the End Event object category's icon, and then click the Message End Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving a Message End Event element has the following limitations in regards to the following Process model elements:
Lane element: If the Message End Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Message End Event element cannot be moved outside of the Pool element.
The selected Message End Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Message End Event element with a different ending Request event element:
Select the Message End Event element to change to another ending Request event element. Available options display above the selected element.
Click Confirm. The new element replaces the Message End Event element with its default settings and color.
The Message End Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 Message End Event element:
Select the Message End Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to configure how to trigger a Message End Event element:
Select the Message End Event element from the Process model in which to configure its message name.
In the Message Name setting, edit the message name that a catching element references to listen for the Message End Event's message.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Message End Event element:
Select the Message End Event element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Message End Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure End Event elements in your Process model.
Your user account or group membership must have the following permissions to configure an End Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add an End Event element from one of the following locations in Process Modeler:
Follow these steps to add an End Event element from the Explorer panel to the Process model:
Locate the End Event object category from one of the following locations in the Explorer panel:
Object Category: The End Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Follow these steps to add an End Event element from the Objects bar to the Process model:
Click the End Event object category's icon. This object's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving an End Event element has the following limitations in regards to the following Process model elements:
Lane element: If the End Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the End Event element cannot be moved outside of the Pool element.
The selected End Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an End Event element with a different ending Request event element:
Select the End Event element to change to another ending Request event element. Available options display above the selected element.
Click Confirm. The new element replaces the End Event element with its default settings and color.
The End Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 an End Event element:
Select the End Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
For example, if an End Event element triggers from Lane 1 of a Pool element, then use a different Screen to display the Request summary than an End Event element that triggers from Lane 2.
When an End Event element is placed into a Process model, it is not configured to display a summary Screen when it triggers. Therefore, it must be configured.
Follow these steps to select the Screen that displays when an End element triggers:
Select the End Event element from the Process model in which to select the Screen that displays when that End Event element is triggered, thereby completing that Request.
Expand the Configuration panel if it is not presently expanded, and then locate the Summary screen setting.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an End Event element:
Select the End Event element from the Process model in which to edit its identifier value.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the End Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Start Event object category.
Click the Elements drop-down menu, and then select the Message Start Event option.
The Message Start Event element displays.
Ensure that the Start Event object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Message Start Event element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the Start-type event elements.
Select the element to replace the Message Start Event element. The Change Type screen displays to confirm replacing the currently selected element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
Expand the Configuration panel if it is not presently expanded and then locate the Listen For Message setting.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Intermediate Event object category.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Timer Event element cannot be placed outside of the Pool element.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Timer Event element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the Intermediate-type event elements.
Select the element to replace the Intermediate Timer Event element. The Change Type screen displays to confirm replacing the currently selected element.
Set a recurring interval of time in which the Intermediate Timer Event element triggers: From the Type drop-down menu, select the Cycle option. The Recurring loop repeats at time interval set below setting displays.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Start Event object category.
Click the Elements drop-down menu, and then select the Start Timer Event option.
The Start Timer Event element displays.
Ensure that the Start Event object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Timer Event element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the Start-type event elements.
Select the element to replace the Start Timer Event element. The Change Type screen displays to confirm replacing the currently selected element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Intermediate Event object category.
Click the Elements drop-down menu, and then select the Intermediate Signal Catch Event option.
The Intermediate Signal Catch Event element displays.
Ensure that the Intermediate Event object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Signal Catch Event element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the Intermediate-type event elements.
Select the element to replace the Intermediate Signal Catch Event element. The Change Type screen displays to confirm replacing the currently selected element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting.
Click the menu iconbeside the Signal drop-down menu. The +Signal button displays.
Click the +Signal button. The ID and Name settings display to configure the new Signal's ID and name, respectively.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting. The Signal setting may have a selection unlike the image below indicates.
Click the menu iconbeside the Signal drop-down menu. All Signals configured in your ProcessMaker instance display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.
Click the Edit iconthat displays beside each Signal to edit that signal. The Name setting displays the name of that Signal.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting. The Signal setting may have a selection unlike the image below indicates.
Click the menu iconbeside the Signal drop-down menu. All Signals configured in your ProcessMaker Platform instance display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.
Click the Delete iconthat displays beside each Signal to delete that Signal. A message displays to confirm deletion of this Signal.
Expand the Configuration panel if it is not presently expanded, and then locate the Request Variable setting.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Intermediate Event object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the Intermediate Event object category.
Click the Elements drop-down menu, and then select the Intermediate Message Throw Event option.
The Intermediate Message Throw Event element displays.
Ensure that the Intermediate Event object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Message Throw Event element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Intermediate Message Throw Event element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Intermediate Message Throw Event element inside the Pool element closest to where you attempt to move it.
After an Intermediate Message Throw Event element is , you may replace it with a different intermediate event element:
element
element
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the intermediate Request event elements.
Select the element to replace the Intermediate Message Throw Event element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
The Intermediate Message Throw Event element uses a message name as a placeholder for the Request data that this element sends to a catching element. When a element or an element listens for a message, it references the Intermediate Message Throw Event element's message name.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Message Name setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Intermediate Event object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the Intermediate Event object category.
Click the Elements drop-down menu, and then select the Intermediate Conditional Catch Event option.
The Intermediate Conditional Catch Event element displays.
Ensure that the Intermediate Event object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Conditional Catch Event element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Intermediate Conditional Catch Event element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Intermediate Conditional Catch Event element inside the Pool element closest to where you attempt to move it.
See .
After an Intermediate Signal Catch Event element is , you may replace it with a different intermediate event element:
element
element
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the intermediate Request event elements.
Select the element to replace the Intermediate Conditional Catch Event element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
Enter the Request condition(s) that triggers the Intermediate Conditional Catch Event element, thereby thereby allowing workflow to route through that element. An Intermediate Conditional Catch Event element only triggers when the specified condition(s) in that Request are met, thereby allowing workflow to route through its outgoing element(s). Otherwise, that Request remains paused indefinitely unless the Process model provides an alternative for workflow routing.
.
See to Specify Request Conditions That Trigger a Conditional Start Event Element.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Condition setting. This is a required setting.
Enter the Request condition(s) that trigger this Intermediate Conditional Catch Event element and then press Enter, thereby allowing workflow to route through its outgoing Sequence Flow element(s). See .
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Intermediate Event object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the Intermediate Event object category.
Click the Elements drop-down menu, and then select the Intermediate Message Catch Event option.
The Intermediate Message Catch Event element displays.
Ensure that the Intermediate Event object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Message Catch Event element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Intermediate Message Catch Event element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Intermediate Message Catch Event element inside the Pool element closest to where you attempt to move it.
After an Intermediate Message Catch Event element is , you may replace it with a different intermediate event element:
element
element
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the intermediate Request event elements.
Select the element to replace the Intermediate Message Catch Event element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
Vocabularies panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
An Intermediate Message Catch Event element pauses a until that element receives a message from either an element or a element (but not both) located in a different element than the Intermediate Message Catch Event element receiving the message. After the Intermediate Message Catch Event element receives its message, that element triggers. Select from which element to listen for a message based on the Intermediate Message Throw Event or Message End Event element's Message Name setting value.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Listen For Message setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Assign 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 to make this configuration.
Use a Vocabulary on an Intermediate Message Catch Event element to validate Request data complies with the Vocabulary's JSON schema. See for more information.
During an in-progress Request, if ProcessMaker Platform evaluates that the Request data no longer complies with all Vocabularies to that moment, the Request status changes from In Progress to Error. The error displays in the . 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.
One or more Vocabularies must be created to your ProcessMaker Platform instance before assigning a Vocabulary. See . Multiple Vocabularies can be assigned to a Start Event element.
The must be installed to assign which Vocabularies validate Request data at an Intermediate Message Catch Event element. Use the Vocabularies to maintain uniform JSON schemas across all assets in your organization. These assets include , , and .
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Click theicon to add a Vocabulary. The Assign Vocabulary option displays.
If no Vocabularies are configured in your ProcessMaker Platform instance, then the following message displays: List is empty. Create at least one Vocabulary. See .
Click the Remove iconfrom the Vocabularies setting to remove a Vocabulary from assignment to this element.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Intermediate Event object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the Intermediate Event object category.
Click the Elements drop-down menu, and then select the Intermediate Signal Throw Event option.
The Intermediate Signal Throw Event element displays.
Ensure that the Intermediate Event object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Intermediate Signal Throw Event element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Intermediate Signal Throw Event element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Intermediate Signal Throw Event element inside the Pool element closest to where you attempt to move it.
After an Intermediate Signal Throw Event element is , you may replace it with a different intermediate event element:
element
element
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the Intermediate-type event elements.
Select the element to replace the Intermediate Signal Throw Event element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting.
Click the menu iconbeside the Signal drop-down menu. The +Signal button displays.
Click the +Signal button. The ID and Name settings display to configure the new Signal's ID and name, respectively.
A Signal that corresponds with a must have the Signal ID value that corresponds with that User Signal's event. See . .
. The new Signal is added to .
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting. The Signal setting may have a selection unlike the image below indicates.
Click the menu iconbeside the Signal drop-down menu. All Signals configured in your ProcessMaker Platform instance display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.
Click the Edit iconthat displays beside each Signal to edit that signal. The Name setting displays the name of that Signal.
. The name of the Signal also changes in .
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting. The Signal setting may have a selection unlike the image below indicates.
Click the menu iconbeside the Signal drop-down menu. All Signals configured in your ProcessMaker Platform instance display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.
Click the Delete iconthat displays beside each Signal to delete that Signal. A message displays to confirm deletion of this Signal.
. The Signal is also deleted from .
Send the current value of a specified in the Signal's payload.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal Payload setting.
Specify Data Variable: Select Specify Data Variable to specify a Request variable's current value as the Signal's payload. The Request Variable setting displays. In the Request Variable setting, enter or edit the name of the Request variable to use its current value as the Signal's payload. To send the entirety of that Request's payload, leave the Request Variable setting empty.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The End Event object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the End Event object category.
Click the Elements drop-down menu, and then select the Message End Event option.
The Message End Event element displays.
Ensure that the End Event object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Message End Event element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Message End Event element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Message End Event element inside the Pool element closest to where you attempt to move it.
After a Message End Event element is , you may replace it with a different ending event element:
element
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the ending Request event elements.
Select the element to replace the Message End Event element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
The Message End Event element uses a message name as a placeholder for the Request data that this element sends to a catching element. When a element or an element listens for a message, it references the Message End Event element's message name.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Message Name setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The End Event object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the End Event object category.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the End Event element cannot be placed outside of the Pool element.
Ensure that the End Event object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the End Event element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the End Event element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the End Event element inside the Pool element closest to where you attempt to move it.
After an End Event element is , you may replace it with a different ending event element:
element
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the ending Request event elements.
Select the element to replace the End Event element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
After a completes when an End Event element triggers, a can display a summary of the completed Request. If a Process model has multiple End Event elements, then each End Event element can reference a different Screen to display a different summary.
.
If a element immediately precedes the End Event element, place a element preceding the End Event element, and then use the Display the Next Assigned Task to the Task Assignee setting to trigger the End Event element after the Form Task element.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
From the Summary screen drop-down menu, select the Screen that has been designed to display Request summaries if that End Event element triggers. This drop-down menu displays only -type Screens to display a message to the Request participant. Note that another End Event element located elsewhere in the Process model, such as another or element, may reference a different Screen to display Request summaries when it triggers.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Add, copy, delete, change the color, align, and configure Terminate End Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Terminate End Event element.
Your user account or group membership must have the following permissions to configure a Terminate End Event element in 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 Administrator for assistance.
Add a Terminate End Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Terminate End Event element from the Explorer panel to the Process model:
Locate the End Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The End Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The End Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Terminate End Event element cannot be placed outside of the Pool element.
Follow these steps to add a Terminate End Event element from the Objects bar to the Process model:
Click the End Event object category's icon, and then click the Terminate End Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Terminate End Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Terminate End Event 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 Terminate End Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Terminate End Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Terminate End Event element cannot be moved outside of the Pool element.
After a Terminate End Event element is added to a Process model, you may replace it with a different ending Request event element:
End Event element
Message End Event element
Error End Event element
Signal End Event element
The selected Terminate End Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Terminate End Event element with a different ending Request event element:
Select the Terminate End Event element to change to another ending Request event element. Available options display above the selected element.
Click Confirm. The new element replaces the Terminate End Event element with its default settings and color.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Terminate End Event element has the following panels that contain settings:
Configuration panel
Documentation panel (available when the Documentation package is installed)
Advanced panel
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 Terminate End Event element:
Select the Terminate End Event element from the Process model in which to edit its name. Panels to configure this element display.
In the Name setting, edit the selected element's name and then press Enter.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Terminate End Event element:
Select the Terminate End Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Terminate End Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Error End Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Error End Event element.
Your user account or group membership must have the following permissions to configure an Error End Event element in 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 Administrator for assistance.
Add an Error End Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add an Error End Event element from the Explorer panel to the Process model:
Locate the End Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The End Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The End Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Error End Event element cannot be placed outside of the Pool element.
Follow these steps to add an Error End Event element from the Objects bar to the Process model:
Click the End Event object category's icon, and then click the Error End Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving an Error End Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Error End Event 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 Error End Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Error End Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Error End Event element cannot be moved outside of the Pool element.
The Error End Event element and label have a default red color to indicate that this element is an ending Request event. After an Error Event element is added to a Process model, its shape and label color can be changed. Element and connector colors may only be changed individually.
Follow these steps to change the color and label for an Error End Event element:
View your Processes. The Processes page displays.
Do one of the following to change the color:
Select a color swatch: Select one of the color swatches from the color palette. The Error End Event element and label change to that color.
After an Error End Event element is added to a Process model, you may replace it with a different ending Request event element:
End Event element
Message End Event element
Signal End Event element
Terminate End Event element
The selected Error End Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Error End Event element with a different ending Request event element:
Select the Error End Event element to change to another ending Request event element. Available options display above the selected element.
Click Confirm. The new element replaces the Error End Event element with its default settings and color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Error End Event element has the following panels that contain settings:
Configuration panel
Documentation panel (available when the Documentation package is installed)
Advanced panel
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 an Error End Event element:
Select the Error End Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
The Error End Event element uses an error name as a placeholder to record the Request error if an error occurs during the Request.
Follow these steps to edit the error name for an Error End Event element:
Select the Error End Event element from the Process model in which to configure its error name.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Error Name setting, edit the error name that the Error End Event element uses to record a Request error if one occurs during the Request.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Error End Event element:
Select the Error End Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Error End Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Signal End Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Signal End Event element.
Your user account or group membership must have the following permissions to configure a Signal End Event element in 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 Administrator for assistance.
Add a Signal End Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Signal End Event element from the Explorer panel to the Process model:
Locate the End Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The End Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The End Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Signal End Event element cannot be placed outside of the Pool element.
Follow these steps to add a Signal End Event element from the Objects bar to the Process model:
Click the End Event object category's icon, and then click the Signal End Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Signal End Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Signal End Event 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 Signal End Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Signal End Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Signal End Event element cannot be moved outside of the Pool element.
After a Signal End Event element is added to a Process model, you may replace it with a different ending Request event element:
End Event element
Message End Event element
Error End Event element
Terminate End Event element
The selected Signal End Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Signal End Event element with a different ending Request event element:
Select the Signal End Event element to change to another ending Request event element. Available options display above the selected element.
Click Confirm. The new element replaces the Signal End Event element with its default settings and color.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Signal End Event element has the following panels that contain settings:
Documentation panel (available when the Documentation package is installed)
Advanced panel
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 Signal End Event element:
Select the Signal End Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
A Signal End Event element broadcasts a specific Signal that contains part or all of its current Request data when it triggers to all elements throughout that ProcessMaker Platform instance listening for that Signal. The Signal End Event element triggers when its Request completes. The element that listens for the broadcast Signal does not need to be in the same Process model as the Signal End Event element. Select the Signal that this element broadcasts.
Follow these steps to select the Signal that the Signal End Event element broadcasts:
Select the Signal End Event element from the Process model in which to select the signal that it broadcasts.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Do one of the following:
The Signal to trigger this element exists:
From the Signal drop-down menu, select the Signal that triggers this element. This setting is required.
The Signal to trigger this element does not exist:
In the ID setting, enter the unique ID of this Signal. The Signal ID may only contain non-special characters and without spaces. This Signal ID must be unique from all other signal IDs. If the entered Signal ID already exists, the following text displays below the setting: Signal ID is duplicated. Note that the Signal ID cannot be edited after the Signal is created. Consider the following when entering the Signal ID value:
Signal IDs must be unique and accept alphanumeric characters only.
A Signal that corresponds with a User Signal must have the Signal ID value that corresponds with that User Signal's event. See What is a User Signal?. Ensure that the User Signal is enabled for use.
This is a required setting.
In the Name setting, enter the unique alphanumeric name of this Signal. This Signal name must be unique from all other Signal names. This Signal name displays when selecting a Signal from other elements that can broadcast or listen for a Signal. If the entered Signal name already exists, the following text displays below the setting: Signal Name is duplicated. This is a required setting.
Click Save. The Signal is created.
From the Signal drop-down menu, select the new Signal that triggers this element. This setting is required.
Save your Process model. The new Signal is added to Signal Manager.
Editing the name of a Signal changes that signal's name. This Signal name displays when selecting a Signal from other elements that can broadcast or listen for a Signal.
Follow these steps to edit the name of a Signal:
Select any element from the Process model that broadcasts or listens for a Signal.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Name setting, edit the name of the Signal as necessary.
Click Save.
Save your Process model. The name of the Signal also changes in Signal Manager.
A Signal cannot be delete if any other Signal subscribes to it. When attempting to delete a Signal with any subscribing element, a message displays with which element(s) subscribes to that Signal.
Carefully consider whether to delete a Signal. Deleting a Signal makes that Signal unavailable when configuring all elements that broadcast or listen to Signals throughout your ProcessMaker Platform instance.
Deleting a Signal cannot be undone.
Follow these steps to delete a Signal:
Select any element from the Process model that broadcasts or listens for a Signal.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
If the Signal is subscribed to by another element anywhere in your ProcessMaker Platform instance, that Signal cannot be deleted. A message displays by which element(s) subscribes to this Signal.
Click Delete.
Save your Process model. The Signal is also deleted from Signal Manager.
Configure the contents of the broadcasting Signal's payload when the Signal End Event element triggers:
Send no Request data in the Signal's payload, thereby sending no data. All elements configured to listen for the broadcasting Signal trigger, but no data from the Signal End Event element's Request can be referenced from the receiving element.
Send all current Request data in the Signal's payload.
Send the current value of a specified Request variable in the Signal's payload.
Follow these steps to select the contents of the Signal's payload that the Signal End Event element broadcasts:
Select the Signal End Event element from the Process model in which to select contents of the Signal's payload.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Signal Payload drop-down menu, select one of the following options:
No Request Data: Select No Request Data to send no Request data in the Signal's payload.
All Request Data: Select All Request Data to send all current Request data in the Signal's payload.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Signal End Event element:
Select the Signal End Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Signal End Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, delete, change the color, and configure Boundary Error Event elements in your Process model.
Your user account or group membership must have the following permissions to configure a Boundary Error Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Follow these steps to add a Boundary Error Event element to the Process model:
After placing the Boundary Error Event element, you may drag it to an adjacent side of its associating element/connector. Since Process Modeler displays labels at the bottom of Process model elements and connectors, the Boundary Error Event element displays best at the bottom of its associating element.
The Boundary Error Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 Boundary Timer Event element:
Select the Boundary Error Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Boundary Error Event element:
Select the Boundary Error Event element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Boundary Error Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, delete, change the color, and configure Boundary Signal Event elements in your Process model.
Your user account or group membership must have the following permissions to configure a Boundary Signal Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Follow these steps to add a Boundary Signal Event element to the Process model:
After placing the Boundary Signal Event element, you may drag it to an adjacent side of its associating element/connector. Since Process Modeler displays labels at the bottom of Process model elements and connectors, the Boundary Signal Event element displays best at the bottom of its associating element.
The Boundary Signal Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 Boundary Signal Event element:
Select the Boundary Signal Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Indicate whether the Boundary Signal Event element interrupts the best-case scenario workflow:
Follow these steps to indicate if this Boundary Signal Event element interrupts the best-case scenario workflow when it triggers:
Select the Boundary Signal Event element from the Process model in which to indicate if it interrupts the best-case scenario workflow.
From the Interrupting checkbox, indicate whether this Boundary Signal Event element interrupts the best-case scenario workflow when it triggers. When the Interrupting checkbox is selected, which is the default setting, this element interrupts the best-case scenario workflow.
A Boundary Signal Event element represents alternate workflow routing when that element receives a specific broadcasting Signal. The element that broadcasts the Signal does not need to be in the same Process model as the Boundary Signal Event element to receive the broadcasting Signal. Use a Boundary Signal Event element to design business solutions when alternate workflow must occur simultaneously across multiple Process Requests when a separate element in a separate Request broadcasts a Signal for which any or all Boundary Signal Event elements is listening. Select the Signal that triggers this element.
Follow these steps to select the Signal that triggers the Boundary Signal Event element:
Select the Boundary Signal Event element from the Process model in which to select the Signal that triggers it.
Do one of the following:
The Signal to trigger this element exists:
From the Signal drop-down menu, select the Signal that triggers this element. This setting is required.
The Signal to trigger this element does not exist:
In the ID setting, enter the unique ID of this Signal. The Signal ID may only contain non-special characters and without spaces. This Signal ID must be unique from all other signal IDs. If the entered Signal ID already exists, the following text displays below the setting: Signal ID is duplicated. Note that the Signal ID cannot be edited after the Signal is created. Consider the following when entering the Signal ID value:
Signal IDs must be unique and accept alphanumeric characters only.
This is a required setting.
In the Name setting, enter the unique alphanumeric name of this Signal. This Signal name must be unique from all other Signal names. This Signal name displays when selecting a Signal from other elements that can broadcast or listen for a Signal. If the entered Signal name already exists, the following text displays below the setting: Signal Name is duplicated. This is a required setting.
Click Save. The Signal is created.
From the Signal drop-down menu, select the new Signal that triggers this element. This setting is required.
Editing the name of a Signal changes that signal's name. This Signal name displays when selecting a Signal from other elements that can broadcast or listen for a Signal.
Follow these steps to edit the name of a Signal:
Select any element from the Process model that broadcasts or listens for a Signal.
In the Name setting, edit the name of the Signal as necessary.
Click Save.
A Signal cannot be delete if any other Signal subscribes to it. When attempting to delete a Signal with any subscribing element, a message displays with which element(s) subscribes to that Signal.
Carefully consider whether to delete a Signal. Deleting a Signal makes that Signal unavailable when configuring all elements that broadcast or listen to Signals throughout your ProcessMaker Platform instance.
Deleting a Signal cannot be undone.
Follow these steps to delete a Signal:
Select any element from the Process model that broadcasts or listens for a Signal.
If the Signal is subscribed to by another element anywhere in your ProcessMaker Platform instance, that Signal cannot be deleted. A message displays by which element(s) subscribes to this Signal.
Click Delete.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Boundary Signal Event element:
Select the Boundary Signal Event element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Boundary Signal Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the End Event object category.
Click the Elements drop-down menu, and then select the Terminate End Event option.
The Terminate End Event element displays.
Ensure that the End Event object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Terminate End Event element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the ending Request event elements.
Select the element to replace the Terminate End Event element. The Change Type screen displays to confirm replacing the currently selected element.
Expand the Configuration panel if it is not presently expanded. The Name setting displays. This is a required setting.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the End Event object category.
Click the Elements drop-down menu, and then select the Error End Event option.
The Error End Event element displays.
Ensure that the End Event object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Error End Event element cannot be placed outside of the Pool element.
Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.
Select the Error End Event element to change its color. Available options display above the selected element.
Click the Open Color Palette icon. The color palette displays.
Specify a custom color: Click theicon to display the color selector, and then select a color, enter the Hex color code, or enter the red, green, blue, and alpha color values for the custom color. The Error End Event element and label change to that color.
Reset to the default color: Click theicon to reset the Error End Event element and label to its default color.
Click the Elements icon. The Elements drop-down menu displays the ending Request event elements.
Select the element to replace the Error End Event element. The Change Type screen displays to confirm replacing the currently selected element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
Expand the Configuration panel if it is not presently expanded, and then locate the Error Name setting.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the End Event object category.
Click the Elements drop-down menu, and then select the Signal End Event option.
The Signal End Event element displays.
Ensure that the End Event object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Signal End Event element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the ending Request event elements.
Select the element to replace the Signal End Event element. The Change Type screen displays to confirm replacing the currently selected element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting.
Click the menu iconbeside the Signal drop-down menu. The +Signal button displays.
Click the +Signal button. The ID and Name settings display to configure the new Signal's ID and name, respectively.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting. The Signal setting may have a selection unlike the image below indicates.
Click the menu iconbeside the Signal drop-down menu. All Signals configured in your ProcessMaker instance display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.
Click the Edit iconthat displays beside each Signal to edit that signal. The Name setting displays the name of that Signal.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting. The Signal setting may have a selection unlike the image below indicates.
Click the menu iconbeside the Signal drop-down menu. All Signals configured in your ProcessMaker Platform instance display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.
Click the Delete iconthat displays beside each Signal to delete that Signal. A message displays to confirm deletion of this Signal.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal Payload setting.
Specify Data Variable: Select Specify Data Variable to specify a Request variable's current value as the Signal's payload. The Request Variable setting displays. In the Request Variable setting, enter or edit the name of the Request variable to use its current value as the Signal's payload.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
.
. The Processes page displays.
or click the Open Modeler iconto edit the selected Process model. Process Modeler displays.
Add one of the following Process model elements or to your Process model in which to associate with the Boundary Error Event element:
element
element
element
element
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
From the Boundary Events drop-down menu, select the Boundary Error Event option. The Boundary Error Event element displays on the top of its associating element/connector.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
.
. The Processes page displays.
or click the Open Modeler iconto edit the selected Process model. Process Modeler displays.
Add one of the following Process model elements or to your Process model in which to associate with the Boundary Signal Event element:
element
element
element
element
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
From the Boundary Events drop-down menu, select the Boundary Signal Event option. The Boundary Signal Event element displays on the top of its associating element/connector.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
Interrupting workflow: When workflow routes through the Boundary Signal Event element, workflow is interrupted and does not route through the best-case scenario. As highlighted in the example below, workflow routes through the Boundary Signal Event element if the Boundary Signal Event element receives the specific broadcasting Signal for which it is listening if the Manual Task element is not complete when receiving that Signal.
Non-interrupting workflow: Workflow routes both through the Boundary Signal Event element and the best-case scenario, thereby creating parallel workflow in that Request. As highlighted in the example below, workflow routes through the Boundary Signal Event element if the Manual Task element is not yet complete; however, workflow also routes through the best-case scenario when that element completes.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Interrupting setting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting.
Click the menu iconbeside the Signal drop-down menu. The +Signal button displays.
Click the +Signal button. The ID and Name settings display to configure the new Signal's ID and name, respectively.
A Signal that corresponds with a must have the Signal ID value that corresponds with that User Signal's event. See . .
. The new Signal is added to .
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting. The Signal setting may have a selection unlike the image below indicates.
Click the menu iconbeside the Signal drop-down menu. All Signals configured in your ProcessMaker Platform instance display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.
Click the Edit iconthat displays beside each Signal to edit that signal. The Name setting displays the name of that Signal.
. The name of the Signal also changes in .
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Signal setting. The Signal setting may have a selection unlike the image below indicates.
Click the menu iconbeside the Signal drop-down menu. All Signals configured in your ProcessMaker Platform instance display below the +Signal button. The Signal ID displays in a gray border; the Signal name displays to the right of the Signal ID.
Click the Delete iconthat displays beside each Signal to delete that Signal. A message displays to confirm deletion of this Signal.
. The Signal is also deleted from .
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Add, copy, delete, change the color, align, and configure Sub Process elements in your Process model.
See Process Modeling Element Descriptions for a description of the Sub Process element.
Your user account or group membership must have the following permissions to configure a Sub Process element in 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 Administrator for assistance.
Add a Sub Process element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Sub Process element from the Explorer panel to the Process model:
Locate the Task object category from one of the following locations in the Explorer panel:
Pinned Objects: The Task object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Task object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Sub Process element cannot be placed outside of the Pool element.
Follow these steps to add a Sub Process element from the Objects bar to the Process model:
Click the Task object category's icon, and then click the Sub Process element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After adding the Sub Process element, consider adding any of the following Boundary-type Process model elements to design business solutions when your best-case scenarios don't happen:
Boundary Timer Event element (Don't know what that is?)
Boundary Error Event element (Don't know what that is?)
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Sub Process element has the following limitations in regards to the following Process model elements:
Pool element: If the Sub Process 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 Sub Process element inside the Pool element closest to where you attempt to move it.
Lane element: If the Sub Process element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Sub Process element cannot be moved outside of the Pool element.
After a Sub Process element is added to a Process model, you may replace it with a Task type element:
Form Task element
Manual Task element
Script Task element
The selected Sub Process element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Sub Process element with a Task type element:
Select the Sub Process element to change to another element. Available options display above the selected element.
Click Confirm. The new element replaces the Sub Process element with its default settings and color.
See Customize the Appearance of an Element or Connector.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Sub Process element has the following panels that contain settings:
Configuration panel
Loop Characteristics panel
Documentation panel (available when the Documentation package is installed)
Assignment Rules panel
Vocabularies panel
Advanced panel
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 Sub Process element:
Select the Sub Process element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
The Sub Process element calls a Sub Process when it triggers. The Sub Process is referred to as a "child" Process, while the calling Process is referred to as the "parent" Process. The child Sub Process must in the same ProcessMaker instance as the parent Process and not archived.
The child Sub Process has its own Request. The Request for the parent Process waits until the child Sub Process's Request completes before its workflow continues. When the child Sub Process's Request completes, the parent Process's Request continues from the Sub Process element.
The child Process must have at least one Start Event element from which to start its Request. Other Start-type BPMN elements result in an invalid parent Process error when this Sub Process element calls the child Process to start its Request.
As a best practice, verify that the child Process contains a Start Event element prior to completing design for the Process using this Sub Process element.
To prevent routing for the parent Process's Request from waiting until the child Sub Process's Request completes, use a Parallel Gateway element preceding the Sub Process element. Use a parallel outgoing Sequence Flow element from the Parallel Gateway element to continue routing the parent Process while the Sub Process element waits for the child Sub Process's Request to complete.
Follow these steps to select the child Sub Process the Sub Process element calls when it triggers:
Select the Sub Process element from the Process model in which to select the child Sub Process that element calls.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Start Event drop-down menu, select another Start Event element from the child Process that this Sub Process element calls to start a Request if the default Start Event element is not to be called. Optionally click the Open Process option below the Start Event drop-down menu to review the selected Process model in a new Web browser window.
Use the Loop Characteristics panel settings to specify how to perform multiple instances of this element. The following loop modes are available for this element:
No Loop Mode: Select the No Loop Mode option to perform this element's Task only once.
Loop: Select the Loop option to sequentially repeat this element's Task multiple times until an exit condition is True
. This is useful when a Task should be performed multiple times with the same set of data, such as, processing a credit card payment. This loop mode has the following characteristics:
The element's Task is repeated until the exit condition is True
or the maximum iterations limit is reached.
At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.
The same exit condition evaluates at the end of each instance; however, value(s) of the Request variable(s) used in the exit condition can change during an instance resulting in the exit condition to eventually evaluate as True
.
If any one instance of that Task does not complete, workflow pauses.
All active instances are terminated if an interrupting boundary-type event element triggers.
Multi-instance (Parallel): Select the Multi-instance (Parallel) option to perform this element's Task multiple times in parallel a fixed number of times. This is useful when performing any action in bulk, such as sending an email to several people. This loop mode has the following characteristics:
Instances of the Task are governed by the size of an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this Task that each contains data from its respective array index.
All instances begin simultaneously when this element triggers; however, they perform their Task independently of each other.
The Task as a whole completes when all instances are complete.
The output from each instance can either be saved in the source Request variable or a new array-type Request variable.
All active instances terminate if an interrupting boundary-type event element triggers.
Multi-instance (Sequential): Select the Multi-instance (Sequential) option to perform this element's Task multiple times sequentially a fixed number of times or until an exit condition is True
. This is useful when sequentially repeating a Task multiple times but with a different set of data each time. This loop mode has the following characteristics:
Instances of the Task are governed by the size an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this Task that each contains data from its respect array index.
At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.
At the end of each instance an exit condition evaluates and the loop activity halts if the exit condition is True
.
The Task as a whole completes when all instances are complete.
The output from each instance can either be saved in the source Request variable or a new array-type Request variable.
All active instances terminate if an interrupting boundary-type event element triggers.
‌Follow these steps to specify characteristics to perform multiple instances of the Task:‌
Select the element from the Process model in which to specify multiple instance characteristics.
Panels to configure this element display.Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Loop Characteristics panel. The Loop Characteristics setting displays. By default, Loop Activity is set to No Loop Mode and the Task is performed only once.
From the Loop Mode setting, select one of the following options to perform this element's Task more than once.
Loop: Select the Loop option. The settings for this loop mode display:
Follow these steps:
In the Maximum Iterations setting, enter an integer value representing the maximum number of times this Task should be performed.
In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
Multi-instance (Parallel): Select the Multi-instance (Parallel) option. The settings for this loop mode display:
Follow these steps:
In the Request Variable Array setting, enter the name of an array-type Request Variable. The size of this array will determine how many times this loop iterates.
In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.
Multi-instance (Sequential): Select the Multi-instance (Sequential) option. The settings for this loop mode display:
Follow these steps:
In the Request Variable Array setting, enter the name of an array-type Request Variable. The size of this array will determine how many times this loop iterates.
In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Select who may start Requests for the "child" Sub Process selected from the Process setting:
Anonymous: Any person may start Requests for the child Sub Process. Ensure that the child Sub Process contains a Start Event element configured to allow anonymous Web Entry; otherwise, that Start Event element only allows authenticated users to start Requests for the child Sub Process.
Requester: Only the person who started that Request for the "parent" Process may start Requests for the child Sub Process. This user is known as the Request starter.
Users and/or groups: Selected users and/or all members of selected groups may start Requests for the child Sub Process.
Previous Task assignee: Only the previous Task assignee in that Request may start Requests for the child Sub Process.
By User ID: A user based on a Variable Name value as entered into a Screen during a previous Task in that Request may start Requests for the child Sub Process. For example, if a Line Input control in a Screen has the Variable Name value of Name
, to contain a user's name, then use that value to thereby select that user to start Sub child Process Requests.
Follow these steps to select who may start Requests for the child Sub Process:
Select the Sub Process element from the Process model in which to select who may start Requests for the child Sub Process.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Start Sub Process As drop-down menu, select one of the following options:
Anonymous: Select Anonymous to allow any person to start Requests for the child Sub Process. Ensure that the child Process contains a Start Event element configured to allow anonymous Web Entry; otherwise, that Start Event element only allows authenticated users to start Requests of the child Sub Process.
Requester: Select Requester to only allow the Request starter to start Requests for the child Sub Process.
From the Assigned Users/Groups drop-down menu, select as all users and/or groups that may start Requests for the child Process. Multiple ProcessMaker users and/or groups may be added, one at a time, to this setting. You may click the Remove icon to remove a selection from the Assigned Users/Groups drop-down menu.
Previous Task Assignee: Select Previous Task Assignee to only allow the previous Task assignee in that Request to start Requests for the child Sub Process.
By User ID: Select By User ID to select a user based on a Variable Name value as entered into a Screen during a previous Task in that Request may start Requests for the child Sub Process.
For example, if a Line Input control in a Screen has the Variable Name value of Name
, to contain a user's name, then use that value to thereby select that user to start child Sub Process Requests. 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 user who may start child Sub Process Requests.
Assign Vocabularies that validate that 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 to make this configuration.
Use a Vocabulary on a Sub Process element to validate that Request data complies with the Vocabulary's JSON schema after routing returns from the child Sub Process's Request to the parent Process's Request, but prior to when the Request continues routing for the parent Request. See What is a Vocabulary? for more information.
Each moment ProcessMaker Platform evaluates workflow routing for an in-progress Request, ProcessMaker Platform also evaluates the Request data's conformity to the 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 Vocabulary's JSON schema.
During an in-progress Request, if ProcessMaker Platform evaluates that the Request data no longer complies with all Vocabularies to that moment, the Request status changes from In Progress to Error. The error displays in the Request summary. 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 Vocabularies are assigned, ProcessMaker Platform does not validate that Request data complies with a specific JSON schema prior to continuing workflow for that Request.
One or more Vocabularies must be created before assigning a Vocabulary. See Create a New Vocabulary. Multiple Vocabularies can be assigned to a Sub Process element.
The Vocabularies package installed to assign which Vocabularies validate Request data at a Sub Process element. Use the Vocabularies package to maintain uniform JSON schemas across all assets in your organization. These assets include Processes, Screens, and Scripts.
A 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 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.
Follow these steps to assign Vocabularies that validate Request data from a Sub Process element:
Select the Sub Process element from the Process model in which to assign Vocabularies that validate Request data prior to when this element completes.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.
From the Select Vocabulary drop-down menu, select a Vocabulary from which to validate Request data complies with its JSON schema.
If no Vocabularies are configured , then the following message displays: List is empty. Create at least one Vocabulary. See Create a New Vocabulary.
Click Save.
Repeat Steps 3 through 6 as necessary for each Vocabulary required to validate Request data complies with its JSON schema.
After one or more Vocabularies are assigned to a Sub Process element, the Vocabulary icon displays in that element.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Sub Process element:
Select the Sub Process element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Sub Process element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Manual Task elements in your Process model.
See Process Modeling Element Descriptions for a description of the Manual Task element.
Your user account or group membership must have the following permissions to configure a Manual Task element in 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 Administrator for assistance.
Add a Manual Task element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Manual Task element from the Explorer panel to the Process model:
Locate the Task object category from one of the following locations in the Explorer panel:
Pinned Objects: The Task object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Task object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Manual Task element cannot be placed outside of the Pool element.
Follow these steps to add a Manual Task element from the Objects bar to the Process model:
Click the Task object category's icon, and then click the Manual Task element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
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:
Boundary Timer Event element (Don't know what that is?)
Boundary Error Event element (Don't know what that is?)
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
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.
See Customize the Appearance of an Element or Connector.
Customize the Manual Task Element's appearance in the following ways:
Customize the color of the element, icon, and label, which by default display as black-colored. See Change a Manual Task Element's Color.
After a Manual Task Element is added to a Process model, optionally customize these aspects of its appearance. Each Manual Task element's appearance may only be changed individually.
The Manual Task element and label are black-colored by default. After a Manual Task element is added to a Process model, its shape and label color can be changed. An element color may only be changed individually.
Follow these steps to change the color for a Manual Task element:
View your Processes. The Processes page displays.
Do one of the following to change the color:
Select a color swatch: Select one of the color swatches from the color palette. The Manual Task element and label change to that color.
Follow these steps to change the icon for a Manual Task element:
View your Processes. The Processes page displays.
From the Search drop-down menu, select the icon to display. The Manual Task element's icon changes to the selected icon.
Click OK.
To reset the Manual Task element to its default icon, click the Reset to Default button from the Select a custom icon screen.
After a Manual Task element is added to a Process model, you may replace it with a different Task type or a Sub Process element:
Form Task element
Script Task element
Sub Process element
The selected Manual Task element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Manual Task element with a different Task type element or a Sub Process element:
Select the Manual Type element to change to another element. Available options display above the selected element.
Click Confirm. The new element replaces the Manual Task element with its default settings and color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Manual Task element has the following panels that contain settings:
Loop Characteristics panel
Documentation panel (available when the Documentation package is installed)
Assignment Rules panel
Notifications panel
Email Notifications panel (available when the Send Email package is installed)
Comments Panel
Vocabularies panel (available when the Vocabularies package is installed)
Advanced panel
The Manual Task element has multiple settings in the Configuration panel:
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 Manual Task element:
Select the Manual Task element from the Process model in which to edit its name.
Expand the ConfiguratioEnsure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
In the Name setting, edit the selected element's name and then press Enter.
When a Manual Task element triggers, a Screen can display instructions or information in its Task summary so its Task assignee can perform the manual Task. The Screen must be of Display type.
When a Manual Task element is placed into a Process model, it is not configured to display a Screen when it triggers. Therefore, it must be configured.
Follow these steps to select the Screen that displays when a Manual Task element triggers:
Select the Manual Task element from the Process model in which to select the Screen that displays when that Manual Task element is triggered, thereby providing instructions or information to the Task assignee.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Screen for Input drop-down menu, select the 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 Screen is selected, the Open Screen link displays.
Optionally, click the Open Screen link to view and/or edit your selected Screen. Note that your user account must have appropriate Screen category permissions to view and/or edit the selected Screen.
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.
If an interrupting boundary-type event associated with the Manual Task element triggers, workflow immediately routes through the interrupting boundary-type event. Therefore, any subsequent Task's due date following the boundary-type event applies.
The due date for a Task is unchanged in the following circumstances:
The Task is assigned to another user: If that Task is reassigned to another user, the time that task is due still applies; the elapsed time now applies toward the reassigned user.
An interrupting boundary-type event triggers: The boundary-type event has its own due date if applicable. Therefore, the Task to which the boundary-type event applies is unaffected.
After the specified time expires for a manual Task, an overdue indicator displays for that manual Task to the Task assignee.
Specify due time for a Task element in total number of hours. This includes hours not normally associated with business hours, including overnight hours, weekends, and holidays.
A Self Service Task can become overdue even though no members of a group have self-assigned that Task: the number of hours that Task is due begins as soon as that Task element triggers. Therefore, if configuring a Self Service Task, consider that the Task does not immediately have a Task assignee to do that Task.
Follow these steps to specify when a Manual Task element is due:
Select the Manual Task element from the Process model in which to specify how many hours the activity is due.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the
Due In setting.
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.
When the Display the Next Assigned Task to the Task Assignee setting is used in a Manual Task element, a selected Display-type Screen displays after the Task for this Manual Task element completes. An interstitial Screen displays while the Request resumes routing. Non-assigned automated actions run as part of that Request while the interstitial Screen displays. The interstitial Screen displays indefinitely until one of the following occurs:
The Request assigns another Task to the same Task assignee, at which time the new Task displays.
The Request completes, at which time the Request summary displays.
The user clicks a link to leave that page to display another location.
Use an interstitial Screen when the expected period of time that the next Task is assigned to the same Task assignee is short; otherwise, the interstitial Screen displays indefinitely without user intervention or the session expires.
Use the Display the Next Assigned Task to the Task Assignee setting in the following ways:
Tasks that use Conversational-type Screens: During an automated chat-style conversation with the Request participant using the Conversational Forms package, link Conversational Screens together while the Request resumes routing based on previous conversational responses by the participant. See What is a Conversational Screen? for information how to design modern-style chat experiences with Conversational Screens and the Conversational Forms package.
Tasks that use Form-type Screens: Display a message with a Display-type Screen in the following circumstances:
Next Task is for the same Task recipient: Design a Screen that reads Loading your next Task while the Request routes to the next Form Task or Manual Task element's Task for the same Task assignee.
See the tabs below for more information how to use the Display the Next Assigned Task to the Task Assignee setting with Conversational- and Form-type Screens.
After selecting the Display the Next Assigned Task to the Task Assignee setting, the Screen Interstitial setting displays to select which Screen displays between the Tasks. This behavior is different than the default functionality, whereby the To Do Tasks page displays after each Task completes.
The Display the Next Assigned Task to the Task Assignee setting applies only between this Manual Task element and the subsequent Form Task element or Manual Task element to which the Request routes.
If the next Task is assigned to a different user or group, then the interstitial Screen displays until that Request completes or another Task is assigned that user.
Interstitial Screen usage have the following limitations:
Interstitial Screens inside of a child Process's Request only redirect to Tasks in that Request and its parent Request. However, if the Interstitial Screen is three or more levels removed from its source Request, Tasks are not redirected.
An Interstitial Screen inside of a child Request that directly follows a Web Entry Start Event element can not redirect back to the parent Request. Instead the Interstitial Screen may only redirect to Tasks in the child Request.
The Display the Next Assigned Task to the Task Assignee setting has two purposes depending on whether the Form Task element's Task uses a Conversational- or Form-type Screen.
Use the Display the Next Assigned Task to the Task Assignee setting to link Conversational Screens together while the Request resumes routing based on previous conversational responses by the participant. Multiple elements and connectors may perform automatic tasks after this Manual Task element's Task and before the next Conversational Screen's Task triggers in that Request. However, the Request participant experiences a seamless conversation between the two Conversational Screens' Tasks while the interstitial Screen displays in the chat box. For example, use a Screen that uses an Image or Rich Text control that displays an animated GIF to imply that the other conversational participant is typing.
Non-assigned automated actions run as part of that Request while the interstitial Screen displays. When the Request assigns the next Task to that Task assignee, the new Task displays in the chat box as continued conversation in a seamless chat experience to the Request participant.
Use the Display the Next Assigned Task to the Task Assignee 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 the next Task immediately after submitting the current Task in that Request, especially if other elements and connectors are between Form Task and/or Manual Task elements so that Tasks are assigned quickly.
Follow these steps to configure a Manual Task element to display an interstitial Screen while the next assigned Task displays to the Task assignee:
Select the Manual Task element from the Process model in which to configure it to display an interstitial Screen after its Task completes.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Screen Interstitial drop-down menu, select which Display-type Screen to display after this Manual Task element's Task completes. This is a required setting.
Use the Loop Characteristics panel settings to specify how to perform multiple instances of this element. The following loop modes are available for this element:
No Loop Mode: Select the No Loop Mode option to perform this element's Task only once.
Loop: Select the Loop option to sequentially repeat this element's Task multiple times until an exit condition is True
. This is useful when a Task should be performed multiple times with the same set of data, such as, processing a credit card payment. This loop mode has the following characteristics:
The element's Task is repeated until the exit condition is True
or the maximum iterations limit is reached.
At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.
The same exit condition evaluates at the end of each instance; however, value(s) of the Request variable(s) used in the exit condition can change during an instance resulting in the exit condition to eventually evaluate as True
.
If any one instance of that Task does not complete, workflow pauses.
All active instances are terminated if an interrupting boundary-type event element triggers.
Multi-instance (Parallel): Select the Multi-instance (Parallel) option to perform this element's Task multiple times in parallel a fixed number of times. This is useful when performing any action in bulk, such as sending an email to several people. This loop mode has the following characteristics:
Instances of the Task are governed by the size of an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this Task that each contains data from its respective array index.
All instances begin simultaneously when this element triggers; however, they perform their Task independently of each other.
The Task as a whole completes when all instances are complete.
The output from each instance can either be saved in the source Request variable or a new array-type Request variable.
All active instances terminate if an interrupting boundary-type event element triggers.
Multi-instance (Sequential): Select the Multi-instance (Sequential) option to perform this element's Task multiple times sequentially a fixed number of times or until an exit condition is True
. This is useful when sequentially repeating a Task multiple times but with a different set of data each time. This loop mode has the following characteristics:
Instances of the Task are governed by the size an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this Task that each contains data from its respect array index.
At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.
At the end of each instance an exit condition evaluates and the loop activity halts if the exit condition is True
.
The Task as a whole completes when all instances are complete.
The output from each instance can either be saved in the source Request variable or a new array-type Request variable.
All active instances terminate if an interrupting boundary-type event element triggers.
Follow these steps to specify characteristics to perform multiple instances of the Task:
Select the element from the Process model in which to specify multiple instance characteristics.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Loop Characteristics panel. The Loop Characteristics setting displays. By default, Loop Activity is set to No Loop Mode and the Task is performed only once.
From the Loop Mode setting, select one of the following options to perform this element's Task more than once.
Loop: Select the Loop option. The settings for this loop mode display:
Follow these steps:
In the Maximum Iterations setting, enter an integer value representing the maximum number of times this Task should be performed.
In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
Multi-instance (Parallel): Select the Multi-instance (Parallel) option. The settings for this loop mode display:
Follow these steps:
In the Request Variable Array setting, enter the name of an array-type Request Variable. The size of this array will determine how many times this loop iterates.
In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.
Multi-instance (Sequential): Select the Multi-instance (Sequential) option. The settings for this loop mode display:
Follow these steps:
In the Request Variable Array setting, enter the name of an array-type Request Variable. The size of this array will determine how many times this loop iterates.
In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Specify whom to assign the manual Task or to use assignment rules to assign the manual Task.
Instead of assign the Task's assignee using one or more rules, select to whom to assign a manual Task:
Previous Task assignee: Assign that Task to the previous Task assignee in that Request's workflow.
Request starter: Assign that Task to the user that started the Request.
Process Variable: Assign the Task to a user or group based on the value of a Request variable.
Process Manager: That Task assigns to the Process Manager when all other configured assignment conditions do not occur.
Optionally, affect how an assigned Task can route after the initial assignment:
Self service: Use the self-service Task option to allow self-service Task assignment. Doing so allows any member in a specified group assigned that Task to self-assign the Task from a queue. Note that the self-service Task option is not available unless assigning a Task to a user, group, via a Request variable, or rule expression.
Lock user assignment: Use the Lock User Assignment option to assign this Task to the same Task assignee if workflow in that Request returns to this Task. If the initial Task assignee was a member of a group, the Task is reassigned to the same 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.
Allow reassignment: Enable the Allow Reassignment option to allow the Task assignee to reassign the Task if necessary. When using the Allow Reassignment option, the Reassign button displays in the Task summary to allow that Task assignee to reassign that Task. See View a Task Summary.
Allow manager escalation: Use the Allow Manager Escalation option to allow users to manually assign this Task to their manager. When this option is enabled, the Escalate to Manager button appears when viewing a Task's summary. This setting is only available if the Advanced User package is installed.
Assign to manager: Use the Assign to Manager option to assign that Task to the manager of that assignee's manager. As part of the Advanced User package, an Administrator can configure the manager for each user. The user account for that Task assignee must be configured from each user's account to route that Task to the assignee's manager.
If this Manual Task element is configured to assign the Task to an anonymous person who started this Request via Web Entry, the settings described below are disabled because these Manual Task element settings only configure which authenticated user(s) may assigned this Task. Therefore, to configure these settings, either disable Web Entry or select that authenticated users may start Requests from this element via Web Entry. See Web Entry Panel Settings.
To allow the same anonymous person who started that Request or which authenticated users may be assigned the Manual Task element's Task via a published URL, do not configure those persons from the Assignment Rules panel. Configure those persons from the Web Entry panel.
Follow these steps to select to whom to assign the Task that is referenced in a Manual Task element:
Select the Manual Task element from the Process model in which to select the Task assignee.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Assignment Rules panel if it is not presently expanded. The Assignment Type setting displays. The Request Starter option is the default, thereby affecting options below it.
From the Assignment Type drop-down menu, select one of the following options:
From the Assigned Users/Groups drop-down menu, select the person's full name or the name of a group as the Manual Task element's assignee. The Task is assigned following this protocol:
One user: The Task is assigned to the selected user.
One or more users and/or group(s): The Task is assigned randomly to one of those users or group members. The exception is if the Self Service toggle key is enabled, then the Task remains unassigned, in a queue, for one of those users to self-assign from the Self Service Task page.
Previous Task Assignee: Select Previous Task Assignee to assign the Task to who was assigned the previous Task in this Request. The Self Service toggle key is not available since the Task has a specific assignee.
Request Starter: Select Request Starter to assign the Task to the Request starter. This is the default option. The Self Service toggle key is not available since the Task has a specific assignee.
Process Variable: Select Process Variable to assign the Task determined by the value of a Request variable. The entered Request variable(s) may be one or both of the following:
Variable Name (Users): In the Variable Name (Users) setting, enter the Request variable that contains the user ID(s) for one or more users who might be assigned this Task. If more than one user ID is included the Request variable's value, then the Task is assigned randomly to one of those users. The exception is if the Self Service toggle key is enabled, then the Task remains unassigned, in a queue, for one of those users to self-assign from the Self Service Task page.
Follow these step to define an expression:
In the FEEL Expression setting, enter or edit the expression that determines that Manual Task element's Task assignee using the syntax components described in Expression Syntax Components, and then press Enter.
From the Assign to User/Group drop-down menu, select the user or group to whom to assign that Task if the expression in the FEEL Expression setting evaluates as True.
From the Default Assignment drop-down menu, select a user or group to assign that Task to if none of the expressions evaluate as True.
Process Manager: Select Process Manager to assign the Task to the Process Manager. This option is only available if the Advanced User package is installed. Ensure to configure the Process Manager for this Process.
Enable the Self Service toggle key to allow self-service Task assignment. Doing so allows any member in a specified group assigned that Task to self-assign any Task from a queue. Note that the Self Service toggle key is not available unless the Users / Groups, Process Variable, or Rule Expression options are selected from the Assignment Type setting.
Enable the Assign to Manager toggle key to assign that Task to the manager of that assignee's manager. As part of the Advanced User package, an Administrator can configure the manager for each user. The user account for that Task assignee must be configured from each user's account to route that Task to the assignee's manager.
Enable the Allow Reassignment toggle key 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.
Enable the Escalate To Manager toggle key to automatically reassign this Task to the Task assignee's manager. This setting is only available if the Advanced User package is installed. As part of the Advanced User package, an Administrator can configure the manager for each user.
Enable the Assignee Manager Escalation toggle key to automatically reassign this Task to the Task assignee's manager. This setting is only available if the Advanced User package is installed. As part of the Advanced User package, an Administrator can configure the manager for each user.
If you enable the Allow Reassignment option, ensure that this Task is assigned to more than one user or to a group. Otherwise, despite the availability of the Reassign button in the Task summary, that Task assignee has no users to which to reassign this Task unless that user started that Request.
Set email notifications for Tasks separately. Settings in the Notifications panel configure Task notifications only within the ProcessMaker Platform application.
Set when notifications regarding Tasks are sent to the following:
Requester: Send notifications to the Request initiator (referred to as the Request starter) when the Task associated with this Manual Task element is assigned and/or completed.
Task assignee: Send notifications to Task assignees associated with this Manual 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 Manual Task element is assigned or completed.
Process Manager: Send notifications to the Process Manager when the Task associated with this Manual Task element is assigned or completed. This option is only available if the Advanced User package is installed. Ensure to configure the Process Manager for this Process.
Follow these steps to set Task notifications in a Manual Task element:
Select the Manual Task element from the Process model in which to set Task notifications.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Notifications panel if it is not presently expanded. Settings display to set Task notifications.
From the Requester settings, set Task notifications for the Request starter following these guidelines:
Enable the Assigned setting to notify the Request starter 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 Request starter 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 Request starter when the Task associated with this Manual Task element is due to be completed. Otherwise, disable this setting to not send this notification.
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.
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.
From the Process Manager settings, set Task notifications for the Process Manager following these guidelines:
Enable the Assigned setting to notify the Process Manager 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 Process Manager 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 Process Manager when the Task associated with this Manual Task element is due to be completed. Otherwise, disable this setting to not send this notification.
Set ProcessMaker Platform application notifications for Tasks separately. Settings in the Email Notifications panel configure only email notifications for Tasks.
The Email Notification panel is available only when the Send Email package is installed.
The following may be email Task notification recipients:
Specific email addresses for individuals who are not users in your ProcessMaker Platform instance.
The email body for the Task notification may be plain text or referenced from an Email-type Screen. If referencing the email body from a Display-type 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 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 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:
Follow these steps to set the email Task notification's subject and body content in a Manual Task element:
Select the Manual Task element from the Process model in which to set email Task notifications.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
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:
In the setting below the Plain Text option, revise the default text if necessary that displays as the email body. By default, ProcessMaker Platform displays the current Manual Task element's Name setting as part of the Plain Text option.
Display Screen:
Select the Display Screen option to select an Email-type Screen from which to display its content as the email body. Follow these steps:
From the drop-down menu below the Display Screen option, select from which Screen to display its content as the email body. Only Email-type Screens display from this drop-down menu.
Optionally, click the Open Screen link to view and/or edit your selected Screen. Note that your user account must have appropriate Screen category permissions to view and/or edit the selected Screen.
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 Add a Recipient setting to set which users, groups and/or email addresses to send this email notification. Follow these steps:
Users and Groups: Send this email to user(s) or group(s). When this option is selected, the Send to Users and Groups setting displays. Select a user or group from the available list.
Requester: Send this email to the user who started this Request.
Participants: Send this email to all users participating in this Request.
User ID: Send this email to a user based on the value of a Request variable. When this option is selected, the Send to User ID setting displays. Enter a variable name in this setting. A valid user name must be assigned to this variable in a previous step in the Request.
Email Address: Send this email to the entered email address. When this option is selected, the Send to Email Address setting displays. Enter a single email address or multiple email addresses separated by commas with no spaces.
For example: amanda@mycompany.com,john@homeoffice.com
.
Alternatively, enter a Request variable in mustache syntax that contains a comma delimited string of multiple email addresses.
Process Manager: Send this email to the Process Manager assigned in the Process's configuration.
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 Attach File setting to specify one or more file(s) to attach with this email notification. Follow these steps:
From the Source setting, select one of the following options:
URL: Select the URL option. The URL settings display. Follow these guidelines:
Click Save. The URL referencing the file displays.
Request Variable: Select the Request Variable option if it is not selected. This is the default option. The Request Variable setting displays. Follow these guidelines:
Click Save. The Request variable referencing the file displays.
Request Array: Select the Request Array option to attach multiple files. The Request Array Variable Name and Variable in Array settings display. Follow these guidelines:
In the Request Array Variable Name setting, enter an array-type Request variable. This variable must already be linked to a File Upload control with Upload Multiple Files option enabled in the same Request. When the Request is in-progress, any files uploaded using this File Upload control are attached to this email.
In the Variable in Array setting, enter the name of a variable in the Request Array Variable containing ID of the file to be attached. If the Request Array Variable is a simple array containing a list of files, leave this setting blank.
Repeat steps 3 and 4 to add additional files.
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:
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.
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:
Configure which commenting functions Task assignees of this Manual Task element may use in Task summaries.
Configure which commenting functions are allowed for a Process's Request summaries in Process configuration. Commenting function allowances in Form Task elements and Manual Task elements do not affect commenting allowances for this Process's Request summaries.
All commenting functions are restricted by default. If the Allow Comments commenting function is enabled, then the remaining commenting functions may be configured, but are restricted by default:
Allow comments: The Manual Task element must be configured to allow comments in Tasks from that Manual Task element.
The Comments package must be installed to use commenting functions in Requests or Tasks.
Follow these steps to configure which commenting functions Task assignees from this Manual Task element may use:
Select the Manual Task element from the Process model in which to configure commenting functions.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Toggle any of the following settings as necessary to allow commenting functionality in this Manual Task element's Task summaries:
Allow Reactions: Toggle the Allow Reactions toggle key to allow or restrict emoticon reactions in this Manual Task element's Task summaries.
Allow Voting: Toggle the Allow Voting toggle key to allow voting to sent comments in this Manual Task element's Task summaries.
Allow Comment Editing: Toggle the Allow Comment Editing toggle key to allow or restrict Request participants to edit their own sent comments in this Manual Task element's Task summaries.
Allow Comment Deletion: Toggle the Allow Comment Deletion toggle key to allow or restrict Request participants to delete their own sent comments in this Manual Task element's Task summaries.
Assign Vocabularies that validate that 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 to make this configuration.
Use a Vocabulary on a Manual Task element to validate that 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 Platform evaluates workflow routing for an in-progress Request, ProcessMaker also evaluates the Request data's conformity to the 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 Platform evaluates that the Request data no longer complies with all Vocabularies to that moment, the Request status changes from In Progress to Error. The error displays in the Request summary. 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 Vocabularies are assigned, ProcessMaker Platform does not validate that Request data complies with a specific JSON schema prior to continuing workflow for that Request.
One or more Vocabularies must be created before assigning a Vocabulary. See Create a New Vocabulary. Multiple Vocabularies can be assigned to a Manual Task element.
The Vocabularies package installed to assign which 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, Screens, and Scripts.
A 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 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.
Follow these steps to assign Vocabularies that validate Request data from a Manual Task element:
Select the Manual Task element from the Process model in which to assign Vocabularies that validate Request data prior to when this element completes.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.Panels to configure this element display.
From the Select Vocabulary drop-down menu, select a Vocabulary from which to validate Request data complies with its JSON schema.
If no Vocabularies are configured, then the following message displays: List is empty. Create at least one Vocabulary. See Create a New Vocabulary.
Click Save.
Repeat Steps 3 through 6 as necessary for each Vocabulary required to validate Request data complies with its JSON schema.
After one or more Vocabularies are assigned to a Manual Task element, the Vocabulary icon displays in that element.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Manual Task element:
Select the Manual Task element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required field.
In the Node Identifier setting, edit the Manual Task element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Exclusive Gateway elements in your Process model.
Your user account or group membership must have the following permissions to configure a Exclusive Gateway element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add an Exclusive Gateway element from one of the following locations in Process Modeler:
Follow these steps to add an Exclusive Gateway element from the Explorer panel to the Process model:
Locate the Gateway object category from one of the following locations in the Explorer panel:
Object Category: The Gateway object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Follow these steps to add an Exclusive Gateway element from the Objects bar to the Process model:
Click the Gateway object category's icon. This object's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving an Exclusive Gateway element has the following limitations in regards to the following Process model elements:
Lane element: If the Exclusive Gateway element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Exclusive Gateway element cannot be moved outside of the Pool element.
The selected Exclusive Gateway element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Exclusive Gateway element with a different Gateway type element:
Select the Exclusive Gateway element to change to another element. Available options display above the selected element.
Click Confirm. The new element replaces the Exclusive Gateway element with its default settings and color.
The Exclusive Gateway element has the following panels that contain settings:
Configuration panel
Advanced panel
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 an Exclusive Gateway element:
Select the Exclusive Gateway element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Exclusive Gateway element:
Select the Exclusive Gateway element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Exclusive Gateway element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Inclusive Gateway elements in your Process model.
Your user account or group membership must have the following permissions to configure an Inclusive Gateway element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add an Inclusive Gateway element from one of the following locations in Process Modeler:
Follow these steps to add an Inclusive Gateway element from the Explorer panel to the Process model:
Locate the Gateway object category from one of the following locations in the Explorer panel:
Object Category: The Gateway object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Inclusive Gateway element cannot be placed outside of the Pool element.
Follow these steps to add an Inclusive Gateway element from the Objects bar to the Process model:
Click the Gateway object category's icon, and then click the Inclusive Gateway element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving an Inclusive Gateway element has the following limitations in regards to the following Process model elements:
Lane element: If the Inclusive Gateway element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Inclusive Gateway element cannot be moved outside of the Pool element.
The selected Inclusive Gateway element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Inclusive Gateway element with a different Gateway type element:
Select the Inclusive Gateway element to change to another element. Available options display above the selected element.
Click Confirm. The new element replaces the Inclusive Gateway element with its default settings and color.
The Inclusive Gateway element has the following panels that contain settings:
Configuration panel
Advanced panel
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 an Inclusive Gateway element:
Select the Inclusive Gateway element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Indicate if the workflow direction for the Inclusive Gateway is converging or diverging:
One Inclusive Gateway element can only converge or diverge workflow, but not both. Use two Inclusive Gateway elements to both converge and diverge workflow.
Follow these steps to indicate the workflow direction for an Inclusive Gateway element:
Select the Inclusive Gateway element from the Process model in which indicate the workflow direction.
From the Direction drop-down menu, select from one of the following options:
Converging: Select the Converging option to indicate the workflow direction is for incoming Sequence Flow elements. All incoming Sequence Flow elements to the Inclusive Gateway element must trigger before the Inclusive Gateway element triggers.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Inclusive Gateway element:
Select the Inclusive Gateway element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Inclusive Gateway element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Parallel Gateway elements in your Process model.
Your user account or group membership must have the following permissions to configure a Parallel Gateway element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add a Parallel Gateway element from one of the following locations in Process Modeler:
Follow these steps to add a Parallel Gateway element from the Explorer panel to the Process model:
Locate the Gateway object category from one of the following locations in the Explorer panel:
Object Category: The Gateway object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Parallel Gateway element cannot be placed outside of the Pool element.
Follow these steps to add a Parallel Gateway element from the Objects bar to the Process model:
Click the Gateway object category's icon, and then click the Parallel Gateway element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving a Parallel Gateway element has the following limitations in regards to the following Process model elements:
Lane element: If the Parallel Gateway element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Parallel Gateway element cannot be moved outside of the Pool element.
The selected Parallel Gateway element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Parallel Gateway element with a different Gateway type element:
Select the Parallel Gateway element to change to another element. Available options display above the selected element.
Click Confirm. The new element replaces the Parallel Gateway element with its default settings and color.
The Parallel Gateway element has the following panels that contain settings:
Configuration panel
Advanced panel
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 Parallel Gateway element:
Select the Parallel Gateway element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Indicate if the workflow direction for the Parallel Gateway is converging or diverging:
Diverging: Diverging workflow represents two or more outgoing Sequence Flow elements from the Parallel Gateway element. When a Parallel Gateway triggers, all outgoing Sequence Flow elements from the gateway element trigger simultaneously without exception. Conditions cannot be placed on any outgoing Sequence Flow elements from the Parallel Gateway element. Use this when multiple workflow routes must occur simultaneously.
One Parallel Gateway element can only converge or diverge parallel workflow, but not both. Use two Parallel Gateway elements to synchronize both converging and diverging parallel workflow.
Follow these steps to indicate the workflow direction for a Parallel Gateway element:
Select the Parallel Gateway element from the Process model in which indicate the workflow direction.
From the Direction drop-down menu, select from one of the following options:
Diverging: Select the Diverging option to indicate that the workflow direction is for outgoing Sequence Flow elements. When this option is selected, all outgoing Sequence Flow elements from the Parallel Gateway element trigger simultaneously without exception. This is the default option.
Converging: Select the Converging option to indicate the workflow direction is for incoming Sequence Flow elements. All incoming Sequence Flow elements to the Parallel Gateway element must trigger before the Parallel Gateway element triggers.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Parallel Gateway element:
Select the Parallel Gateway element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Parallel Gateway element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, resize, delete, and configure Pool and Lane elements in your Process model.
Your user account or group membership must have the following permissions to configure a Pool or Lane element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add a Pool element from one of the following locations in Process Modeler:
Follow these steps to add a Pool element from the Explorer panel to the Process model:
Locate the Pool object category from one of the following locations in the Explorer panel:
Object Category: The Pool object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Follow these steps to add a Pool element from the Objects bar to the Process model:
Click the Pool object category's icon. This object's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
If a non-Pool element is placed into a Pool element, that element cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places that element inside the Pool element closest to where you attempt to move it.
If you accidentally delete a Pool element with other elements you want to keep, then click the Undo button.
Follow these steps to resize a Pool element:
Select the Pool element from the Process model to resize. Anchors display on each corner of the Pool element.
The Pool element has the following panels that contain settings:
Configuration panel
Advanced panel
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 Pool element:
Select the Pool element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Pool element:
Select the Pool element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Pool element's identifier to a unique value from all nodes in the Process model and then press Enter.
Follow these steps to add a Lane element to a Pool element:
Click the Pool element from the Process model into which to add a Lane element. Icons to add a Lane to a Pool element display.
Do one of the following:
Follow these steps to resize a Lane element:
The Lane element has the following panels that contain settings:
Configuration panel
Advanced panel
An element name is a human-readable reference for a Process element.
Follow these steps to enter or edit the name for a Lane element:
Select the Lane element from the Process model in which to edit its name.
In the Name setting, enter or edit the selected element's name and then press Enter.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Lane element:
Select the Lane element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Lane element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, align, and configure Event-Based Gateway elements in your Process model.
Your user account or group membership must have the following permissions to configure an Event-Based Gateway element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add an Event-Based Gateway element from one of the following locations in Process Modeler:
Follow these steps to add an Event-Based Gateway element from the Explorer panel to the Process model:
Locate the Gateway object category from one of the following locations in the Explorer panel:
Object Category: The Gateway object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Event-Based Gateway element cannot be placed outside of the Pool element.
Follow these steps to add an Event-Based Gateway element from the Objects bar to the Process model:
Click the Gateway object category's icon, and then click the Event-Based Gateway element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving an Event-Based Gateway element has the following limitations in regards to the following Process model elements:
Lane element: If the Event-Based Gateway element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Event-Based Gateway element cannot be moved outside of the Pool element.
The selected Event-Based Gateway element is replaced by the default settings and color of the replacing element.
Follow these steps to replace an Event-Based Gateway element with a different Gateway type element:
Select the Event-Based Gateway element to change to another element. Available options display above the selected element.
Click Confirm. The new element replaces the Event-Based Gateway element with its default settings and color.
The Event-Based Gateway element has the following panels that contain settings:
Configuration panel
Advanced panel
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 an Event-Based Gateway element:
Select the Event-Based Gateway element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for an Event-Based Gateway element:
Select the Event-Based Gateway element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Event-Based Gateway element's identifier to a unique value from all nodes in the Process model and then press Enter.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Task object category.
Click the Elements drop-down menu, and then select the Script Task option.
The Sub Process element displays.
Ensure that the Task object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Sub Process element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the Task type elements and the Sub Process element.
Select the element to replace the Sub Process element. The Change Type screen displays to confirm replacing the currently selected element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
Expand the Configuration panel if it is not presently expanded, and then locate the Process setting.
From the Process drop-down menu, select which child Sub Process the Sub Process element calls when it triggers. This is a required setting. After selecting a Process from the Process drop-down menu, the Start Event setting displays. A Start Event element from the selected Process displays in the Start Event drop-down menu.
An element configured in this mode shows the Loop icon in Process Modeler.
An element configured in this mode shows the Multi-instance (Parallel) icon in Process Modeler.
An element configured in this mode shows the Multi-instance (Sequential) iconin Process Modeler.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Assignment Rules panel if it is not presently expanded. The Start Sub Process As setting displays.
Users and/or Groups: Select Users/Groups to choose specific users and/or all members of specific groups may start Requests for the child Sub Process. When this option is selected, the Assigned Users/Groups drop-down menu displays below the Start Sub Process As drop-down menu.
Click theicon to add a Vocabulary. The Assign Vocabulary setting displays.
Click the Remove iconfrom the Vocabularies setting to remove a Vocabulary from assignment to this element.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Task object category.
Click the Elements drop-down menu, and then select the Manual Task option.
The Manual Task element displays.
Ensure that the Task object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Manual Task element cannot be placed outside of the Pool element.
Customize the icon that displays in the element. Manual Task Elements display theicon in the shape by default. See Change a Manual Task Element's Icon.
Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.
Select the Manual Task element to change its color. Available options display above the selected element.
Click the Open Color Palette icon. The color palette displays.
Specify a custom color: Click theicon to display the color selector, and then select a color, enter the Hex color code, or enter the red, green, blue, and alpha color values for the custom color. The Manual Task element and label change to that color.
Reset to the default color: Click theicon to reset the Manual Task element and label to its default color.
A Manual Task element displays theicon in the shape by default.
Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.
Select the Manual Task Element to customize. Available options display above the selected element.
Click the Open Color Palette icon. The color palette displays.
Click theicon. The Select a custom icon screen displays.
Click the Elements icon. The Elements drop-down menu displays the Task type elements and the Sub Process element.
Select the element to replace the Manual Task element. The Change Type screen displays to confirm replacing the currently selected element.
Expand the Configuration panel if it is not presently expanded, and then locate the Screen for Input setting.
A Script Task element, then an End Event element, follow this Manual Task element: If a Script Task element, and then an End Event element, immediately follow this Manual Task element with connecting Sequence Flow elements (see example below), then use the Display the Next Assigned Task to the Task Assignee setting to ensure that a Screen that summarizes that completed Request displays.
Expand the Configuration panel if it is not presently expanded, and then locate the Display Next Assigned Task to Task Assignee setting.
Select the Display Next Assigned Task to Task Assignee setting. The Screen Interstitial setting displays.
An element configured in this mode shows the Loop iconin Process Modeler.
An element configured in this mode shows the Multi-instance (Parallel) iconin Process Modeler.
An element configured in this mode shows the Multi-instance (Sequential) iconin Process Modeler.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Users / Groups: Select Users/Groups to assign the Task to a specified user or randomly to a group member. When this option is selected, the Assigned Users/Groups drop-down menu displays below the Assignment Type drop-down menu. Notice that the Self Service toggle key is available.
Variable Name (Groups): In the Variable Name (Groups) setting, enter the Request variable that contains the group ID(s) in which its members may be assigned this Task. The Task is assigned randomly to one of those users. The exception is if the Self Service toggle key is enabled, then the Task remains unassigned, in a queue, for one of those users to self-assign from the Self Service Task page.
Rule Expression: Select Rule Expression to assign the Task's assignee using one or more rules. The rule expressions follow the Friendly Enough Expression Language (FEEL) syntax described in Expression Syntax Components. Notice that the Self Service toggle key is available.
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. To add an expression, click the addbutton. The Add FEEL Expression settings display.
Enable the Lock User Assignment toggle key to assign this Task to the same Task assignee if workflow in the Request returns to this Task. If the initial Task assignee was a member of a group, the Task is reassigned to the same 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.
Expand the Email Notifications panel if it is not presently expanded. The Notifications setting displays.
Click the iconto add an email notification. The Add Notification settings display.
From the Subject setting, revise the default text if necessary that displays as the email subject. By default, ProcessMaker Platform displays the current Manual Task element's Name setting as part of the Subject setting.
From the Body setting, ensure that the Plain Text option is selected.
From the Body setting, ensure that the Display Screen option is selected.
From the Add a Recipient setting, select the recipient(s) of this email. To remove an email recipient that is currently added, click theicon. Choose one of these options:
Click the +File button to specify the files to attach to this email notification. The Attach File settings displays:
In the URL setting, enter the URL referencing an attached file to be accessed from a Web address.
In the Request Variable Name setting, enter a Request variable name without the mustache syntax. This variable must already be linked to a File Upload control in a Screen in the same Request. When the Request is in-progress, any file uploaded using this File Upload control is attached to this email notification. This is a required setting.
Click Save. The Request variable referencing the files displays.
Optionally, click on the Deleteicon to delete any referenced file from being attached to the email.
Task Completion: Select the Task Completion option to send this email notification when this Manual Task element completes (when the Task assignee submits the 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.
Add reactions to comments: Add emoticon reactions in sent comments to Tasks from this Manual Task element. When emoticon reactions are allowed, each sent comment from this element's Tasks displays the reaction iconbelow each sent comment from which a Request participant may click to select an emoticon reaction to a selected comment.
Allow comment voting: Vote on sent comments to Tasks from this Manual Task element. Voting allows Request participants to vote on the merits of a sent comment and provide feedback to the Request participant that sent that comment. When comment voting is allowed, each sent comment from this element's Tasks displaysandicons below each comment from which to vote favorably or unfavorably to that comment, respectively.
Allow comment editing: Request participants may edit their own sent comments in this Manual Task element's Tasks. When comment editing is allowed, aicon displays above each comment a Request participant sent to that Task. Theicon does not display above comments for Request participants that did not send that comment.
Allow comment deleting: Request participants may delete their own sent comments in this Manual Task element's Tasks. When comment deleting is allowed, aicon displays above each comment a Request participant sent to that Task. Theicon does not display above comments for Request participants that did not send that comment.
Expand the Comments panel if it is not presently expanded. The Comments toggle key displays as disabled by default.
Toggle the Comments toggle key to allow commenting functions in Tasks from this Manual Task element. Toggle keys for available commenting functions display. All commenting functions are disabled by default unless they have been previously configured. This commenting function configuration only affects Tasks from this Manual Task element.
Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.
Click theicon to add a Vocabulary. The Assign Vocabulary option displays.
Click the Remove iconfrom the Vocabularies setting to remove a Vocabulary from assignment to this element.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Gateway object category displays from the Pinned Objects section when it is . This object category is not pinned by default.
Click the Gateway object category.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Exclusive Gateway element cannot be placed outside of the Pool element.
Ensure that the Gateway object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Exclusive Gateway element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Exclusive Gateway element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Exclusive Gateway element inside the Pool element closest to where you attempt to move it.
After an Exclusive Gateway element is , you may replace it with a different Gateway type element:
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the Gateway type elements. Note that the element is only available when the Exclusive Gateway element's elements connect with Catch-type Events, such as the element or the element.
Select the element to replace the Exclusive Gateway element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Gateway object category displays from the Pinned Objects section when it is . This element type is not pinned by default.
Click the Gateway object category.
Click the Elements drop-down menu, and then select the Inclusive Gateway option.
The Inclusive Gateway element displays.
Ensure that the Gateway object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Inclusive Gateway element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Inclusive Gateway element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Inclusive Gateway element inside the Pool element closest to where you attempt to move it.
After an Inclusive Gateway element is , you may replace it with a different Gateway type element:
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the Gateway type elements. Note that the element is only available when the Inclusive Gateway element's elements connect with Catch-type Events, such as the element or the element.
Select the element to replace the Inclusive Gateway element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
Converging workflow (synchronize workflow): An Inclusive Gateway element may synchronize workflow from two or more incoming elements to the Inclusive Gateway element. All incoming Sequence Flow elements converging to the Inclusive Gateway element must trigger before the Inclusive Gateway element triggers, thereby synchronizing a Request's workflow. Use this coordinate workflow.
Diverging workflow (evaluate routing conditions): An Inclusive Gateway element may also evaluate a Request's workflow routing conditions for a Process. These routing conditions are configured on each outgoing element from the Inclusive Gateway element. When a Request is in progress and the Inclusive Gateway element triggers, each of its outgoing Sequence Flow elements' conditions are evaluated to determine which Sequence Flow element(s) continue routing for that Request. Unlike the element, multiple Sequence Flow elements can trigger from the Inclusive Gateway element, thereby causing multiple workflow routes simultaneously for the same Request that stem from that Inclusive Gateway element. Use an Inclusive Gateway element when you potentially want multiple workflow routes to occur simultaneously in that Request. Otherwise, consider using an Exclusive Gateway element to allow only one Sequence Flow element's condition(s) to continue workflow route for that Request.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Direction setting.
Diverging: Select the Diverging option to indicate that the workflow direction is for outgoing Sequence Flow elements. When this option is selected, all outgoing . Multiple Sequence Flow elements may be triggered. This is the default option.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Gateway object category displays from the Pinned Objects section when it is . This element type is not pinned by default.
Click the Gateway object category.
Click the Elements drop-down menu, and then select the Parallel Gateway option.
The Parallel Gateway element displays.
Ensure that the Gateway object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Parallel Gateway element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Parallel Gateway element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Parallel Gateway element inside the Pool element closest to where you attempt to move it.
After a Parallel Gateway element is , you may replace it with a different Gateway type element:
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the Gateway type elements. Note that the element is only available when the Inclusive Gateway element's elements connect with Catch-type Events, such as the element or the element.
Select the element to replace the Parallel Gateway element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
Converging: Converging workflow represents two or more incoming elements to the Parallel Gateway element. All incoming Sequence Flow elements converging to the Parallel Gateway element must trigger before the Parallel Gateway element triggers, thereby synchronizing a workflow. Use this coordinate workflow.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Direction setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Pool object category displays from the Pinned Objects section when it is . This element type is not pinned by default.
Click the Pool object category.
Click the location in the Process model to place this element. If other non-Pool objects or exist in the Process model, the Pool element automatically places these objects and PM Blocks into the new Pool element when it displays.
Ensure that the Pool object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If other non-Pool objects or exist in the Process model, the Pool element automatically places these objects and PM Blocks into the new Pool element when it displays.
.
Move the element by dragging it to a new location. Any elements and within the Pool element move as well.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or connectors.
When a Pool element is , all elements within it are also deleted. If you want to keep the elements within a Pool element, you must add those elements outside of the Pool element prior to deleting the Pool element.
.
.
Click one of the anchors on the Pool element, hold your cursor, and then adjust the size of the Pool element on the Process model canvas. If the Pool element contains elements within it prior to resizing, the Pool element only resizes to contain all elements within it. Lane elements automatically adjust to the width of the Pool element, though separately.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
.
Add a Lane element above existing Lane elements: Click the Lane Above iconto add a Lane element above all existing Lane elements. If only the Pool element exists, two Lane elements display.
Add a Lane element below existing Lane elements: Click the Lane Below iconto add a Lane element below all existing Lane elements. If only the Pool element exists, two Lane elements display.
.
.
Select the Lane element from the Pool element to resize. Anchors display on each corner of the Lane element.
Click one of the anchors on the Lane element, hold your cursor, and then adjust the size of the Lane element in the Pool element. If the Lane element contains elements within it prior to resizing, the Lane element only resizes to contain all elements within it. The Pool element automatically adjusts to the width of the resized Lane element so far as all elements contained within the Pool element remain contained in it. separately.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Gateway object category displays from the Pinned Objects section when it is . This element type is not pinned by default.
Click the Gateway object category.
Click the Elements drop-down menu, and then select the Event-Based Gateway option.
The Event-Based Gateway element displays.
Ensure that the Gateway object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Event-Based Gateway element cannot be placed outside of the Pool element.
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Event-Based Gateway element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Event-Based Gateway element inside the Pool element closest to where you attempt to move it.
After an Event-Based Gateway element is , you may replace it with a different Gateway type element:
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the Gateway type elements.
Select the element to replace the Event-Based Gateway element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Model your Process in an easy-to-use graphical BPMN 2.0 compliant editor.
Indicate the flow of data between your Process model elements and connectors with Data Object and Data Store elements using Data Association Flow elements.
See Process Modeling Element Descriptions for a description of the Data Association Flow element.
Your user account or group membership must have the following permissions to configure a Data Association Flow element in 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 Administrator for assistance.
Follow these steps to add a Data Association Flow element to the Process model:
Add a Data Object or a Data Store element to the Process model.
Repeat steps 3 and 4 to indicate data flow from another Data Object or Data Store element.
Use anchors in a Data Association Flow element to adjust how that element bends between its connecting elements. There are two (2) types of anchors:
Follow these steps to adjust a straight line within a Data Association Flow element:
Select the Data Association Flow element so that available options display above the selected element.
Follow these steps to adjust where a Data Association Flow element bends:
Select the element so that available options display above the selected element.
Do one of the following:
Click, and then drag, on a straight line to add a round anchor, then place where to add a bend in that element.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Data Association Flow element has the following panels that contain settings:
Configuration panel
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 Data Association Flow element:
Select the Data Association Flow element to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the element's identifier to a unique value from all elements in the Process model and then press Enter.
Indicate the order of workflow routing in your Process model elements and connectors using Sequence Flow elements.
Use a Sequence Flow element to indicate workflow routing between the connected elements. The direction in which the Sequence Flow points implies how Request data is conveyed and utilized in the Process model. As a best practice, indicate a consistent direction of Sequence Flow elements: either left to right or top to bottom, to make Process models easier to understand.
Sequence Flow elements are not to be confused with Message Flow elements.
Sequence Flow elements have the following attributes in regards to specific Process model elements:
From the context of a Process model element associated with a Sequence Flow element, that Sequence Flow element can be "incoming" or "outgoing." Consider the following Process model example to demonstrate their differences.
Incoming: An incoming Sequence Flow element comes from its connecting element. In the example, the Sequence Flow element is incoming to the Form Task element.
Outgoing: An outgoing Sequence Flow goes to the connecting element. In the example, the Sequence Flow element is outgoing from the Form Task element.
Text annotation elements and Pool elements do not participate in sequence flow.
Sequence Flow elements cannot connect workflow between Process model elements within different Pool elements. Use Message Flow elements to indicate messaging between elements in different Pool elements.
Start Event type elements begin the flow of a Request for that Process. Therefore, the following elements cannot have an incoming Sequence Flow element:
Start Event element
Start Timer Event element
Signal Start Event element
Message Start Event element
End Event type elements terminate the flow of a Request for that Process. Therefore, the following elements cannot have an outgoing Sequence Flow element:
End Event element
Message End Event element
Error End Event element
Signal End Event element
Terminate End Event element
Sequence Flow elements from Exclusive Gateway and Inclusive Gateway elements can be configured to specify under which condition a Request routes through that Sequence Flow element. See Configure an Outgoing Sequence Flow Element from an Exclusive Gateway or Inclusive Gateway Element.
The Flow indicator displays when you click an element or connector in the Process model. ProcessMaker knows whether to use an outgoing Sequence Flow or Message Flow element depending on the selected element or connector selected and its context within the Process model.
Your user account or group membership must have the following permissions to configure Sequence Flow elements in 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 Administrator for assistance.
Follow these steps to set the Sequence Flow element from one connecting element/connector to another:
​View your Processes. The Processes page displays.
Select the Process model element from which you want to set the workflow routing. Available options display to the right of the selected element.
Click the Process model element or connector to which to set the workflow routing. ProcessMaker Platform knows whether to use an outgoing Sequence Flow or Message Flow element depending on the selected element or connector selected and its context within the Process model.
Use anchors in a Sequence Flow element to adjust how that Sequence Flow element bends between its connecting elements/connectors. There are two (2) types of Sequence Flow anchors:
Follow these steps to adjust a straight line within a Sequence Flow element:
Do one of the following:
Connect a Sequence Flow element from one element/connector to another.
Select a Sequence Flow element so that available options display above the selected element. Sequence Flow elements that have immediately been connected require two clicks of the Sequence Flow element for anchors to display.
Follow these steps to adjust where a Sequence Flow element bends:
Connect a Sequence Flow element from one element/connector to another.
Select the Sequence Flow element so that available options display above the selected element. Sequence Flow elements that have immediately been connected require two clicks of the Sequence Flow element for anchors to display.
Do one of the following:
Click, and then drag, on a straight line of the Sequence Flow element to add a round anchor, then place where to add a bend in that Sequence Flow element.
See Change a Process Model Object's Color.
Follow these steps to delete a Sequence Flow element from your Process model:
The Sequence Flow element has the following panels that contain settings:
Configuration panel
Edit the expression to indicate Workflow routing (available only for Exclusive Gateway and Inclusive Gateway elements)
Set the Value for a Request Variable (available only for Exclusive Gateway elements)
Documentation panel (available when the Documentation package is installed)
Advanced panel
An element name is a human-readable reference for a Process element.
Follow these steps to enter or edit the name for a Sequence Flow element:
Select the Sequence Flow element from the Process model in which to edit its name.
In the Name setting, enter or edit the selected element's name and then press Enter.
This Sequence Flow element setting is available only for Exclusive Gateway and Inclusive Gateway elements. See Configure an Outgoing Sequence Flow Element from an Exclusive Gateway or Inclusive Gateway Element for information how this setting affects workflow routing.
Outgoing Sequence Flow elements from Exclusive Gateway and Inclusive Gateway elements have an additional setting from which to configure under which Request condition(s) that Sequence Flow element triggers to route that Request's workflow to its connecting element or connector.
Follow these steps to edit the expression that indicates under which Request condition(s) that Sequence Flow element triggers to route that Request's workflow to its connecting element or connector:
Select the outgoing Sequence Flow element from the Exclusive Gateway or Inclusive Gateway element from which dictate conditions under which workflow routes through that Sequence Flow element.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Expression setting, enter the expression that dictates under which condition(s) that Sequence Flow element triggers to route a Request's workflow to its connecting element, and then press Enter. Consider the following dynamic methods to affect workflow routing for that Request when this Sequence Flow element triggers:
Sequence Flow elements support Request variables. Do not use mustache syntax to reference the Request variable to get its value.
Sequence Flow elements support counter functionality by adding 1
to an existing Request variable value. Example: VariableName + 1
, where VariableName
is the name of the Request variable to reference its value in the Request data, then add 1
.
See the following sections for more information:
An outgoing Sequence Flow element from an Exclusive Gateway element may set the value for a Request variable when that Sequence Flow element triggers. See Set the Value for a Request Variable.
This Sequence Flow element setting is available only for Exclusive Gateway elements. See Set the Value for a Request Variable in the Configure an Outgoing Sequence Flow Element from an Exclusive Gateway or Inclusive Gateway Element section for information how this setting affects workflow routing.
Outgoing Sequence Flow elements from Exclusive Gateway elements have a unique setting. Optionally configure such a Sequence Flow element to set the value of a Request variable when that Sequence Flow element triggers. This setting supports mustache syntax to set the value for the specified Request variable. Regardless of whether Request conditions evaluate as true for that Sequence Flow element or it is the default Sequence Flow element to trigger when no configured Request conditions evaluate as true, the configured Request variable changes to the specified value.
Follow these steps to set the value for a Request variable when the outgoing Sequence Flow element triggers:
Select the outgoing Sequence Flow element from the Exclusive Gateway or Inclusive Gateway element from which dictate conditions under which workflow routes through that Sequence Flow element.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Variable Name setting, enter the name of the Request variable to set its setting when this Sequence Flow element triggers.
In the Value setting, enter the value to set the Request variable. This setting supports mustache syntax.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Sequence Flow element:
Select the Sequence Flow element from the Process model in which to edit its name.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Sequence Flow element's identifier to a unique value from all nodes in the Process model and then press Enter.
Outgoing Sequence Flow elements from Exclusive Gateway and Inclusive Gateway elements have the following settings as do other Sequence Flow elements:
Outgoing Sequence Flow elements from Exclusive Gateway and Inclusive Gateway elements have additional settings to indicate under which condition(s) an outgoing Sequence Flow element triggers to route a Request's workflow to its connecting element or connector:
Specify the condition(s) to trigger each Sequence Flow element: Specify the condition(s) that must occur in a Request to trigger that Sequence Flow element, thereby triggering its connecting element. By setting different conditions on all outgoing Sequence Flow elements from an Exclusive Gateway or Inclusive Gateway element, you determine the business requirements for each Request of that Process model. ProcessMaker Platform evaluates a Sequence Flow element's condition(s) to trigger by reviewing the Request's data to an expression that describes the condition(s). Specify this condition using an expression syntax described in Expression Syntax Components. Each Sequence Flow element can only have one expression, but by using logical operators multiple conditions can be specified in that expression. You may use Magic Variables in your expression syntax. See Edit the Expression to Indicate Workflow Routing.
Select which Sequence Flow element triggers if Request conditions cannot trigger any of them: Select which outgoing Sequence Flow element triggers by default when none of the Request conditions can trigger any of the outgoing Sequence flows from an Exclusive Gateway or Inclusive Gateway element. If none of the conditions specified in any of the outgoing Sequence Flow elements meet the Request conditions to trigger, the default outgoing Sequence Flow triggers, thereby preventing the Request from pausing indefinitely. If a Sequence Flow element is set as the default, then its evaluation is ignored and it triggers by default. Only one outgoing Sequence Flow element from an outgoing Exclusive Gateway or Inclusive Gateway element may be set as the default. See Select a Default Outgoing Sequence Flow Element.
See Edit the Expression to Indicate Workflow Routing for information how to edit an expression in an outgoing Sequence Flow element from an Exclusive Gateway or Inclusive Gateway element.
An Exclusive Gateway element allows only one outgoing Sequence Flow element to trigger. If any of the following scenarios occur during a Request, that Request pauses and remains in-progress indefinitely without that Request being canceled:
All outgoing Sequence Flow elements from an Exclusive Gateway element do not have expressions from which to evaluate conditions during a Request. Furthermore, there is no default outgoing Sequence Flow element to trigger.
None of the expressions configured for all outgoing Sequence Flow elements from an Exclusive Gateway element evaluate as true for that Request. Furthermore, there is no default outgoing Sequence Flow element to trigger.
Therefore, ensure to do the following when configuring outgoing Sequence Flow elements from an Exclusive Gateway element:
Select one outgoing Sequence Flow element as the default outgoing Sequence Flow element if none of the Request conditions can trigger any of the Sequence Flow elements, thereby preventing any in-progress Request from pausing indefinitely.
An Inclusive Gateway element potentially allows all its outgoing Sequence Flow elements to trigger if the Request condition(s) for each Sequence Flow element are met. For example, if no outgoing Sequence Flow elements from an Inclusive Gateway element have expressions from which to evaluate Request conditions, then all Sequence Flow elements always trigger, thereby causing the Inclusive Gateway element to function as a Parallel Gateway element set to diverge workflow. Even if one Sequence Flow element is selected as the default Sequence Flow element to trigger, workflow routing is not affected when no outgoing Sequence Flow elements have expressions from which to evaluate Request conditions.
Therefore, ensure to do the following when configuring outgoing Sequence Flow elements from an Inclusive Gateway element:
Select one outgoing Sequence Flow element as the default outgoing Sequence Flow element to ensure that this Sequence Flow element always triggers regardless of Request conditions. Selecting one outgoing Sequence Flow element as the default workflow prevents any in-progress Request from pausing indefinitely.
Outgoing Sequence Flow elements from Exclusive Gateway elements have a unique setting that does not apply to Sequence Flow elements outgoing from Inclusive Gateway elements. Optionally configure such a Sequence Flow element to set the value of one of the following when that Sequence Flow element triggers:
Update the value of an existing Request variable.
Create a new Request variable if that variable does not currently exist in that Request, then set its value.
This setting supports mustache syntax to set the value for the specified Request variable. If the value to set the Request variable is a string, place quotation marks ("
) preceding and after the string value.
Regardless of whether Request conditions evaluate as true for that Sequence Flow element or it is the default Sequence Flow element to trigger when no configured Request conditions evaluate as true, the configured Request variable changes to the specified value. See Set the Value for a Request Variable.
Follow these steps to set the value for a Request variable from an Exclusive Gateway element when that Sequence Flow element triggers:
Select the outgoing Sequence Flow element from the Exclusive Gateway element from which to set the value for a Request variable.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Variable Name setting, enter the name of the Request variable in which to set its value.
In the Value setting, enter the value to set that Request variable.
Select which outgoing Sequence Flow element triggers by default when none of the Request conditions can trigger any of the outgoing Sequence flows from an Exclusive Gateway or Inclusive Gateway element. If none of the conditions specified in any of the outgoing Sequence Flow elements meet the Request conditions to trigger, the default outgoing Sequence Flow triggers, thereby preventing the in-progress Request from pausing indefinitely. If a Sequence Flow element is set as the default, then its evaluation is ignored and it triggers by default. Only one outgoing Sequence Flow element from an outgoing Exclusive Gateway or Inclusive Gateway element may be set as the default.
Setting a default Sequence Flow to trigger is only available for outgoing Sequence Flow elements from Exclusive Gateway or Inclusive Gateway elements.
Follow these steps to select an outgoing Sequence Flow element as the default to trigger from either an Exclusive Gateway or Inclusive Gateway element:
Select the outgoing Sequence Flow element from either an Exclusive Gateway element or Inclusive Gateway element to set as default to trigger.
The center outgoing Sequence Flow element is the default Sequence Flow element from the Exclusive Gateway element below.
Add, delete, and configure Data Object element in your Process model.
See Process Modeling Element Descriptions for a description of the Data Object element.
Your user account or group membership must have the following permissions to configure a Data Object element in 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 Administrator for assistance.
Add a Data Object element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Data Object element from the Explorer panel to the Process model:
Locate the Data Object object category from one of the following locations in the Explorer panel:
Pinned Objects: The Data Object object category displays from the Pinned Objects section when it is pinned. This element type is not pinned by default.
Object Category: The Data Object object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Follow these steps to add a Data Object element from the Objects bar to the Process model:
Click the Data Object object category's icon. This object's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Data Object element has the following limitations in regards to the following Process model elements:
Pool element: If the Data Object 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 Data Object element inside the Pool element closest to where you attempt to move it.
Lane element: If the Data Object element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Data Object element cannot be moved outside of the Pool element.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Data Object element has the following panels that contain settings:
Configuration panel
Documentation panel (available when the Documentation package is installed)
Advanced panel
Process Modeler automatically assigns a default name to a new Data Object element. However, change the name to provide context to your Process model.
Follow these steps to edit the name for a Data Object element:
Select the Data Object element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name to display in the Process model and then press Enter.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Data Object element:
Select the Data Object element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, delete, and configure Text Annotation and Association elements in your Process model.
See Process Modeling Element Descriptions for a description of the Text Annotation element.
Your user account or group membership must have the following permissions to configure a Text Annotation or Association element in 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 Administrator for assistance.
Add a Text Annotation element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Text Annotation element from the Explorer panel to the Process model:
Locate the Text Annotation object category from one of the following locations in the Explorer panel:
Pinned Objects: The Text Annotation object category displays from the Pinned Objects section when it is pinned. This element type is not pinned by default.
Object Category: The Text Annotation object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Follow these steps to add a Text Annotation element from the Objects bar to the Process model:
Click the Text Annotation object category's icon. This object's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Text Annotation element has the following limitations in regards to the following Process model elements:
Pool element: If the Text Annotation 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 Text Annotation element inside the Pool element closest to where you attempt to move it.
Lane element: If the Text Annotation element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Text Annotation element cannot be moved outside of the Pool element.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Text Annotation element has the following panels that contain settings:
Configuration panel
Documentation panel (available when the Documentation package is installed)
Advanced panel
Process Modeler automatically assigns a default value to a new Text Annotation element. However, change the annotation description to provide context to your Process model.
Follow these steps to edit the annotation description for a Text Annotation element:
Select the Text Annotation element from the Process model in which to edit its name.
In the Text to Show setting, edit the selected Text Annotation element's text to display in the Process model and then press Enter.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Panels to configure this elemeEnsure that the Configuration panel displays. If not, show it.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Text Annotation element:
Select the Text Annotation element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Text Annotation element's identifier to a unique value from all nodes in the Process model and then press Enter.
See Process Modeling Element Descriptions for a description of the Association element.
Follow these steps to add an Association element to the Process model:
Select the Text Annotation element from which you want to add an Association element. Available options display to the right of the selected element.
Click the Process model element to which the Text Annotation element describes. The Annotation element is placed.
Repeat steps 5 and 6 to reference another Process model element that the Text Annotation element describes as necessary.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Association element has the following panels that contain settings:
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 an Association element:
Select the Association element from the Text Annotation element in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the Text Annotation element's identifier to a unique value from all elements in the Process model and then press Enter.
Use the Annotation element to place a directional arrow that points between the Text Annotation element and the element it describes.
Follow these steps to edit the directional arrow that points between the Text Annotation element and the element it describes:
Select the Association element from the Text Annotation element in which to edit its annotation description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Direction setting.
From the Direction drop-down menu, select the direction in which the arrow points between the Text Annotation element and the element it describes. Select one of the following options:
None: Select the None option to not display an arrow that indicates the reference between the Text Annotation element and the element it describes.
One: Select the One option to display an arrow that points from the Text Annotation element to the element it describes. This is the default option.
Both: Select the Both option to display arrows to and from the Text Annotation element's referencing element.
Edit information regarding the Process model.
Your user account or group membership must have the following permissions to edit the Process model identifier unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Process Modeler assigns a unique identifier to the Process model. However, the Process model's identifier value can be changed if it is unique to all other nodes in the Process model.
Follow these steps to edit the identifier value for a Process model:
In the Node Identifier setting, edit the Process model's identifier to a unique value from all nodes in the Process model and then press Enter. The identifier value is changed.
Your user account or group membership must have the following permissions to edit the Process model name unless your user account has the Make this user a Super Admin setting selected:
Processes: View Processes
Processes: Edit Processes
Process Modeler assigns a name to the Process model that has no association with the Process name. This name has no affect on the Process model or Requests, so its name is not relevant. The default Process model name can be changed.
Follow these steps to edit the Process model name:
Click anywhere in the Process model other than any Process element so that no elements are selected. The Configuration panel displays.
In the Name setting, edit the Process model's name and then press Enter. The name is changed.
Indicate messaging in your Process model by setting Message Flows elements between elements in separate Pool elements.
Flow indicators display when you click an element in the Process model.
From the context of a Process model element associated with a Message Flow element, that Message Flow element can be "incoming" or "outgoing." Consider the following Process model example to demonstrate their differences.
Below are the differences between incoming and outgoing Message Flow elements:
Incoming: An incoming Message Flow element comes from its connecting element. In the Process model example above, the Message Flow element is incoming to the "Task 2" element.
Outgoing: An outgoing Message Flow element goes to the connecting element. In the Process model example above, the Message Flow element is outgoing from the "Task 1" element. The outgoing Message Flow element must originate from a separate Pool element than from where it connects.
The following BPMN 2.0 elements do not use outgoing Message Flow elements:
Your user account or group membership must have the following permissions to configure Message Flow elements in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Follow these steps to set the Message Flow element between elements in separate Pool elements:
Ensure that the Process model has at least two (2) Pool elements from which to establish Message Flow between them.
Do one of the following:
Click the second Pool element to indicate messaging between the two elements.
Click an element inside the second Pool element to indicate messaging between the two elements.
Use anchors in a Message Flow element to adjust how that Message Flow element bends between its connecting elements. There are two (2) types of Message Flow anchors:
Follow these steps to adjust a straight line within a Message Flow element:
Do one of the following:
Select a Message Flow element so that available options display above the selected element/connector. Message Flow elements that have immediately been connected require two clicks of the Message Flow element for anchors to display.
Follow these steps to adjust where a Sequence Flow element bends:
Select the Message Flow element so that available options display above the selected element. Message Flow elements that have immediately been connected require two clicks of the Message Flow element for anchors to display.
Do one of the following:
Click, and then drag, on a straight line of the Message Flow element to add a round anchor, then place where to add a bend in that Message Flow element.
Follow these steps to delete a Message Flow element from your Process model:
The Message Flow element has the following panels that contain settings:
Configuration panel
Advanced panel
An element name is a human-readable reference for a Process element.
Follow these steps to enter or edit the name for a Message Flow element:
Select the Message Flow element from the Process model in which to edit its name.
In the Name setting, enter or edit the selected element's name and then press Enter.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Message Flow element:
Select the Message Flow element from the Process model in which to edit its name.
In the Node Identifier setting, edit the Message Flow element's identifier to a unique value from all nodes in the Process model and then press Enter.
Select the Data Object or Data Store element from which you want to add a Data Association Flow element. Available options display to the right of the selected element.
Click the Data Association Flow icon.
Click the Process element to/from which the data flows. The Data Association Flow element is placed.
Adjust a straight line within a Data Association Flow element by dragging the placement of an oblong anchor.
Adjust where a Data Association Flow element bends by placing, then dragging round anchors.
Drag the oblong anchorperpendicularly with the straight line of the element.
Drag an existing round anchorto place where to bend that element.
Click an existing round anchor to delete it, thereby removing that bend in the element.
Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.
Click the Flow icon.
Adjust a straight line within a Sequence Flow element by dragging the placement of an oblong anchor.
Adjust where a Sequence Flow element bends by placing, then dragging round anchors.
Drag the oblong anchorperpendicularly with the straight line of the Sequence Flow element.
Drag an existing round anchorto place where to bend that Sequence Flow element.
Double-click an existing round anchor to delete it, thereby removing that bend in that Sequence Flow element.
Select the Sequence Flow element between the connected element/connector to delete. Available options display above the selected element.
Click the Delete icon. The Process model element deletes.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays.
Expand the Configuration panel if it is not presently expanded and then locate the Expression setting.
Expand the Configuration panel if it is not presently expanded and then locate the Flow Variable group of settings.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays.
Expand the Configuration panel if it is not presently expanded and then locate the Flow Variable setting.
Click the Set as Default Flow iconfor that outgoing Sequence Flow element. The default workflow indicator displays for that Sequence Flow element. The default workflow indicator removes from any other Sequence Flow element previously configured to be the default to trigger since only one outgoing Sequence Flow element can be the default.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Data Object object category.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Data Object element cannot be placed outside of the Pool element.
Ensure that the Data Object object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Data Object element cannot be placed outside of the Pool element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Text Annotation object category.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Text Annotation element cannot be placed outside of the Pool element.
Ensure that the Text Annotation object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Text Annotation element cannot be placed outside of the Pool element.
Ensure that the Configuration panel displays. If not, show it. The Text to Show setting displays.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Click the Association Flow icon.
See the permissions or ask your Administrator for assistance.
Ensure that the Configuration panel displays. If not, .
Expand the Configuration panel if it is not presently expanded. The Node Identifier setting displays. This is a required field.
See the permissions or ask your Administrator for assistance.
. The Processes page displays.
or click the Open Modeler iconto edit the selected Process model. Process Modeler displays.
Expand the Configuration panel if it is not presently expanded. The Name setting displays.
In a Process model, Message Flow elements represent messaging between elements of (or within) one element to elements of (or within) another Pool element. Message Flow elements cannot connect to Process model elements within the same Pool element. Message Flow elements are not to be confused with elements.
Use Message Flow elements to represent collaboration and transfer of data from one Pool to another. Since each Pool element in a Process uses its own Request and , use Message Flow elements to exchange data and information between separate Pool elements and/or elements within those Pool elements.
These messages indicate the transfer of Request data between separate Process model elements. Use a element to add descriptive information about the nature of the data transfer.
​ element
element
element
element
element
element
element
element
element
element
element
element
element
element
element
element
element
element
element
element
element
element
element
See the permissions or ask your Administrator for assistance.
.
From one Pool element, select the Process model element to which to establish messaging via the Message Flow element. Available options display to the right of the selected element. Process model element types that do not have the Message Flow indicator as highlighted below.
Click the Flow icon.
by dragging the placement of an oblong anchor.
by placing, then dragging round anchors.
.
from one element to another.
Drag the oblong anchorperpendicularly with the straight line of the Message Flow element.
.
from one element to another.
Drag an existing round anchorto place where to bend that Message Flow element.
Click an existing round anchor to delete it, thereby removing that bend in that Message Flow element.
See .
.
Select the Message Flow element between the connected element to delete. Available options display above the selected element.
Click the Delete icon. The Process model element deletes.
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays.
Add, copy, delete, change the color, align, and configure Conditional Start Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Conditional Start Event element.
Your user account or group membership must have the following permissions to configure a Conditional Start Event element in 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 Administrator for assistance.
Add a Conditional Start Event element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Conditional Start Event element from the Explorer panel to the Process model:
Locate the Start Event object category from one of the following locations in the Explorer panel:
Pinned Objects: The Start Event object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Start Event object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Start Timer Event element cannot be placed outside of the Pool element.
Follow these steps to add a Conditional Start Event element from the Objects bar to the Process model:
Click the Start Event object category's icon, and then click the Conditional Start Event element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Conditional Start Event element has the following limitations in regards to the following Process model elements:
Pool element: If the Conditional Start Event 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 Conditional Start Event element inside the Pool element closest to where you attempt to move it.
Lane element: If the Conditional Start Event element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Conditional Start Event element cannot be moved outside of the Pool element.
After a Conditional Start Event element is added to a Process model, you may replace it with a different starting Request event element:
Start Event element
Start Timer Event element
Signal Start Event element
Message Start Event element
The selected Conditional Start Event element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Conditional Start Event element with a different Start-type event element:
Select the Conditional Start Event element to change to another Start-type event element. Available options display above the selected element.
Click Confirm. The new element replaces the Conditional Start Event element with its default settings and color.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Conditional Start Event element has the following panels that contain settings:
Documentation panel (available when the Documentation package is installed)
Advanced panel
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 Conditional Start Event element:
Select the Conditional Start Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Enter the Request condition(s) that triggers the Conditional Start Event element, thereby starting a Request. A Conditional Start Event element starts a child Request for a Process when a parent Request sends its Request data to the Conditional Start Event element via a Sub Process element. The Conditional Start Event element triggers when the parent Request's data meets one or more specified conditions.
The Conditional Start Event ignores the call to start a Request in the following scenarios:
The Request condition(s) do not evaluate to the condition(s) set in the Condition setting.
The Request condition(s) evaluates as null
.
The Condition setting contains no value.
A Process model may use multiple Conditional Start Event elements. However, each Conditional Start Event element must use a unique condition for that element to trigger.
Follow these steps to enter the Request conditions that trigger a Conditional Start Event element:
Select the Conditional Start Event element from the Process model in which to edit its name.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Enter the Expression Syntax Components that trigger this Conditional Start Event element and then press Enter, thereby starting a Request of its Process.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Conditional Start Event element:
Select the Conditional Start Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Conditional Start Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, copy, delete, change the color, and configure Boundary Timer Event elements in your Process model.
See Process Modeling Element Descriptions for a description of the Boundary Timer Event element.
Your user account or group membership must have the following permissions to configure a Boundary Timer Event element in 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 Administrator for assistance.
Follow these steps to add a Boundary Timer Event element to the Process model:
Add one of the following Process model elements or connectors to your Process model in which to associate with the Boundary Timer Event element:
Form Task element
Manual Task element
Script Task element
Sub Process element
Actions By Email connector (requires the Actions By Email package)
Data Connector connector (requires the Data Connector package)
DocuSign connector (requires the DocuSign package)
IDP connector (requires the IDP package)
PDF Generator connector (requires the PDF Generator package)
Send Email connector (requires the Send Email package)
After placing the Boundary Timer Event element, you may drag it to an adjacent side of its associating element/connector. Since Process Modeler displays labels at the bottom of Process model elements and connectors, the Boundary Timer Event element displays best at the bottom of its associating element.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Boundary Timer Event element has the following panels that contain settings:
Configuration panel
Timing Control panel
Advanced panel
Documentation panel (available when the Documentation package is installed)
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 Boundary Timer Event element:
Select the Boundary Timer Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Indicate whether the Boundary Timer Event element interrupts the best-case scenario workflow:
Follow these steps to indicate if this Boundary Timer Event element interrupts the best-case scenario workflow when it triggers:
Select the Boundary Timer Event element from the Process model in which to indicate if it interrupts the best-case scenario workflow. Panels to configure this element display.
From the Interrupting checkbox, indicate whether this Boundary Timer Event element interrupts the best-case scenario workflow when it triggers. When the Interrupting checkbox is selected, which is the default setting, this element interrupts the best-case scenario workflow.
When a Boundary Timer Event element is placed into a Process model, it is set to trigger in one (1) hour before workflow routes through it unless its associative element completes before then. If this is not the timing control setting you want, the Boundary Timer Event element must be configured. Set the timer controls for a Boundary Timer Event element using one of the following methods:
Set an interval in which to delay routing workflow through the Boundary Timer Event element in a specified number of days, weeks, months, or years (unless its associative element completes before the delay expires).
Set the date and hour when the Boundary Timer Event element routes workflow through it (unless its associative element completes before that date and hour arrives).
Follow these steps to set the timer controls for a Boundary Timer Event element:
Select the Boundary Timer Event element from the Process model in which to set its timer controls.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Timing Control panel if it is not presently expanded. The Type setting displays.
Do one of the following to set the timer control:
Set the timer when workflow routes through the Boundary Timer Event element: From the Type drop-down menu, select the Delay option. Delay is the default setting. From the Delay setting, select the delay to route workflow through the Boundary Timer Event element unless its associative element completes. 1 hour is the default setting. Then select one of the following time periods for that element to trigger:
Minute
Hour (default setting)
Day
Month
Set date and time when workflow routes through the Boundary Timer Event element: From the Type drop-down menu, select the Date/Time option. The Wait until specific date/time setting displays.
From the Wait until specific date/time setting, use the date control to select the date and time to route workflow through the Boundary Timer Event element unless its associative element completes. If this setting has not been previously set, the current date is the default.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Boundary Timer Event element:
Select the Boundary Timer Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Boundary Timer Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Add, copy, delete, change the color, and configure Boundary Message Event elements in your Process model.
Your user account or group membership must have the following permissions to configure a Boundary Message Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Follow these steps to add a Boundary Message Event element to the Process model:
After placing the Boundary Message Event element, you may drag it to an adjacent side of its associating element/connector. Since Process Modeler displays labels at the bottom of Process model elements and connectors, the Boundary Message Event element displays best at the bottom of its associating element.
The Boundary Message Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 Boundary Message Event element:
Select the Boundary Message Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Indicate whether the Boundary Message Event element interrupts the best-case scenario workflow:
Follow these steps to indicate if this Boundary Message Event element interrupts the best-case scenario workflow when it triggers:
Select the Boundary Message Event element from the Process model in which to indicate if it interrupts the best-case scenario workflow.
From the Interrupting checkbox, indicate whether this Boundary Message Event element interrupts the best-case scenario workflow when it triggers. When the Interrupting checkbox is selected, which is the default setting, this element interrupts the best-case scenario workflow.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Boundary Message Event element:
Select the Boundary Message Event element from the Process model in which to edit its identifier value.
In the Node Identifier setting, edit the Boundary Message Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, delete, change the color, and configure Boundary Conditional Event elements in your Process model.
Your user account or group membership must have the following permissions to configure a Boundary Conditional Event element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Follow these steps to add a Boundary Conditional Event element to the Process model:
After placing the Boundary Conditional Event element, you may drag it to an adjacent side of its associating element/connector. Since Process Modeler displays labels at the bottom of Process model elements and connectors, the Boundary Conditional Event element displays best at the bottom of its associating element.
Follow these steps to delete a Boundary Conditional Event element from your Process model:
The Boundary Conditional Event element has the following panels that contain settings:
Configuration panel
Advanced panel
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 Boundary Conditional Event element:
Select the Boundary Conditional Event element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
Follow these steps to enter the Request conditions that trigger a Boundary Conditional Catch Event element:
Select the Boundary Conditional Catch Event element from the Process model in which to edit its name.
Indicate whether the Boundary Conditional Event element interrupts the best-case scenario workflow:
Follow these steps to indicate if this Boundary Conditional Event element interrupts the default workflow when it triggers:
Select the Boundary Conditional Event element from the Process model in which to indicate if it interrupts the default workflow.
From the Interrupting checkbox, indicate whether this Boundary Conditional Event element interrupts the default workflow when it triggers. When the Interrupting checkbox is selected, which is the default setting, this element interrupts the default workflow.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Boundary Conditional Event element:
Select the Boundary Conditional Event element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the Boundary Conditional Event element's identifier to a unique value from all nodes in the Process model and then press Enter.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
‌Use the following expression syntax components to compose the expression that describes under which Request condition(s) an Intermediate Conditional Catch Event element triggers.‌
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)
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Start Event object category.
Click the Elements drop-down menu, and then select the Conditional Start Event option.
The Conditional Start Event element displays.
Ensure that the Start Event object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Conditional Start Event element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the Start-type event elements.
Select the element to replace the Conditional Start Event element. The Change Type screen displays to confirm replacing the currently selected element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
Expand the Configuration panel if it is not presently expanded, and then locate the Condition setting. This is a required setting.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
From the Boundary Events drop-down menu, select the Boundary Timer Event option. The Boundary Timer Event element displays on the top of its associating element/connector.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
Interrupting workflow: When workflow routes through the Boundary Timer Event element, workflow is interrupted and does not route through the best-case scenario. As highlighted in the example below, workflow routes through the Boundary Timer Event element if the Manual Task element does not complete within 30 minutes.
Non-interrupting workflow: Workflow routes both through the Boundary Timer Event element and the best-case scenario, thereby creating parallel workflow in that Request. As highlighted in the example below, workflow routes through the Boundary Timer Event element if the Manual Task element does not complete within 30 minutes; however, workflow also routes through the best-case scenario when that element completes.
Expand the Configuration panel if it is not presently expanded, and then locate the Interrupting setting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
.
. The Processes page displays.
or click the Open Modeler iconto edit the selected Process model. Process Modeler displays.
Add the following Process model element or to your Process model in which to associate with the Boundary Error Event element:
element
element
element
element
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
From the Boundary Events drop-down menu, select the Boundary Message Event option. The Boundary Message Event element displays on the top of its associating element/connector.
See .
See .
See .
See .
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
Interrupting workflow: When workflow routes through the Boundary Message Event element, workflow is interrupted and does not route through the best-case scenario. As highlighted in the example below, workflow routes through the Boundary Message Event element if that element receives a message from the child Request.
Non-interrupting workflow: Workflow routes both through the Boundary Message Event element and the best-case scenario, thereby creating parallel workflow in that Request. As highlighted in the example below, workflow routes through the Boundary Message Event element if that element receives a message from the child Request; however, after the child Request completes and workflow resumes in the parent Request, the Sub Process element completes and routes through the best-case scenario.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Interrupting setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
.
. The Processes page displays.
or click the Open Modeler iconto edit the selected Process model. Process Modeler displays.
Add one of the following Process model elements or to your Process model in which to associate with the Boundary Conditional Event element:
element
element
element
element
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
connector (requires the )
From the Boundary Events drop-down menu, select the Boundary Conditional Event option. The Boundary Conditional Event element displays on the top of its associating element/connector.
See .
See .
See .
See .
.
​. The Processes page displays.
Click the Open Modeler iconto edit the selected Process model. Process Modeler displays.
Select the Boundary Conditional Event element to delete. Available options display above the selected element.
Click the Delete icon. The Process model element deletes.
Documentation panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
Enter the Request condition(s) that triggers the Boundary Conditional Catch Event element, thereby thereby allowing workflow to route through that element. A Boundary Conditional Catch Event element only triggers when the specified condition(s) in that Request are met while the element/connector to which the Boundary Conditional Event associates has triggered but is not yet complete, thereby allowing workflow to route through its outgoing element(s). Otherwise, workflow routes through the default scenario route.
.
See to Specify Request Conditions That Trigger a Boundary Conditional Event Element.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Condition setting. This is a required setting.
Enter the Expression Syntax Components that trigger this Boundary Conditional Catch Event element and then press Enter, thereby allowing workflow to route through its outgoing Sequence Flow element(s). See .
Interrupting workflow: When workflow routes through the Boundary Conditional Event element, workflow is interrupted and does not route through the default scenario route. As highlighted in the example below, workflow routes through the Boundary Conditional Event element if this element's specified Request conditions are met and the Manual Task element has not yet completed.
Non-interrupting workflow: Workflow routes both through the Boundary Conditional Event element and the default scenario, thereby creating parallel workflow in that Request. As highlighted in the example below, workflow routes through the Boundary Conditional Event element if this element's specified Request conditions are met; however, workflow also routes through the default scenario when the Manual Task element completes.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Interrupting setting.
.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
can be used in when composing expressions.
Add, copy, delete, change the color, align, and configure Script Task elements in your Process model.
Your user account or group membership must have the following permissions to configure a Script Task element in the Process model unless your user account has the Make this user a Super Admin setting selected:
Processes: Edit Processes
Processes: View Processes
Add a Script Task element from one of the following locations in Process Modeler:
Follow these steps to add a Script Task element from the Explorer panel to the Process model:
Locate the Task object category from one of the following locations in the Explorer panel:
Object Category: The Task object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Script Task element cannot be placed outside of the Pool element.
Follow these steps to add a Script Task element from the Objects bar to the Process model:
Click the Task object category's icon, and then click the Script Task element. This element's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After adding the Script 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 adjust its location in the following ways:
Move the element by dragging it to a new location.
Moving a Script Task element has the following limitations in regards to the following Process model elements:
Lane element: If the Script Task element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Script Task element cannot be moved outside of the Pool element.
The selected Script Task element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Script Task element with a different Task type element or a Sub Process element:
Select the Script Task element to change to another element. Available options display above the selected element.
Click Confirm. The new element replaces the Script Task element with its default settings and color.
The Script Task element has the following panels that contain settings:
Configuration panel
Loop Characteristics panel
Error Handling panel
Advanced panel
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 Script Task element:
Select the Script Task element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name and then press Enter.
See the following topics for more information:
Ensure to select a Script for each Script Task element in your Process model. If a Script is not specified and Requests are started for that Process, a placeholder Script displays when that Script Task element triggers.
The placeholder Script allows the Request without causing it to pause indefinitely.
This functionality also allows Process Designers to place the basic Process objects into a Process model and then evaluate it during development.
Follow these steps to select a Script for a Script Task element:
Select the Script Task element from the Process model in which to specify its Script.
Expand the Configuration panel if it is not presently expanded, and then locate the Script setting.
From the Script drop-down menu, select which Script that Script Task element references. After a Script is selected, the Open Script link displays.
If no Scripts exist, the Script drop-down menu contains no options. Ensure to select and configure a Script for every Script Task element in the Process model before deploying your Process.
See the following topics for more information:
If a JSON script exists in the Script Task element, that script is used for the Script. An existing JSON configuration script displays in the Script Configuration option for a selected Script Task element.
The JSON script in the Script Task element overrides any JSON script entered in the Script Config JSON panel in Scripts Editor for the associated Script.
Follow these steps to enter or edit a JSON configuration script for a Script Task element:
Select the Script Task element from the Process model in which to specify its Script.
Expand the Configuration panel if it is not presently expanded, and then locate the Script Configuration option.
Enter your JSON configuration script. Use the scroll panel to the right of the Script to scroll to different sections of the Script if necessary. This is useful especially when you are editing a long Script.
You can enter your JSON configuration script directly into the Script Configuration option instead of using the Script Config Editor.
Use the Loop Characteristics panel settings to specify how to perform multiple instances of this element. The following loop modes are available for this element:
No Loop Mode: Select the No Loop Mode option to perform this element's Task only once.
Loop: Select the Loop option to sequentially repeat this element's Task multiple times until an exit condition is True
. This is useful when a Task should be performed multiple times with the same set of data, such as, processing a credit card payment. This loop mode has the following characteristics:
The element's Task is repeated until the exit condition is True
or the maximum iterations limit is reached.
At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.
The same exit condition evaluates at the end of each instance; however, value(s) of the Request variable(s) used in the exit condition can change during an instance resulting in the exit condition to eventually evaluate as True
.
If any one instance of that Task does not complete, workflow pauses.
All active instances are terminated if an interrupting boundary-type event element triggers.
Multi-instance (Parallel): Select the Multi-instance (Parallel) option to perform this element's Task multiple times in parallel a fixed number of times. This is useful when performing any action in bulk, such as sending an email to several people. This loop mode has the following characteristics:
Instances of the Task are governed by the size of an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this Task that each contains data from its respective array index.
All instances begin simultaneously when this element triggers; however, they perform their Task independently of each other.
The Task as a whole completes when all instances are complete.
The output from each instance can either be saved in the source Request variable or a new array-type Request variable.
All active instances terminate if an interrupting boundary-type event element triggers.
Multi-instance (Sequential): Select the Multi-instance (Sequential) option to perform this element's Task multiple times sequentially a fixed number of times or until an exit condition is True
. This is useful when sequentially repeating a Task multiple times but with a different set of data each time. This loop mode has the following characteristics:
Instances of the Task are governed by the size an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this Task that each contains data from its respect array index.
At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.
At the end of each instance an exit condition evaluates and the loop activity halts if the exit condition is True
.
The Task as a whole completes when all instances are complete.
The output from each instance can either be saved in the source Request variable or a new array-type Request variable.
All active instances terminate if an interrupting boundary-type event element triggers.
‌Follow these steps to specify characteristics to perform multiple instances of the Task:‌
Select the element from the Process model in which to specify multiple instance characteristics.
Expand the Loop Characteristics panel. The Loop Characteristics setting displays. By default, Loop Activity is set to No Loop Mode and the Task is performed only once.
From the Loop Mode setting, select one of the following options to perform this element's Task more than once.
Loop: Select the Loop option. The settings for this loop mode display:
Follow these steps:
In the Maximum Iterations setting, enter an integer value representing the maximum number of times this Task should be performed.
In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
Multi-instance (Parallel): Select the Multi-instance (Parallel) option. The settings for this loop mode display:
Follow these steps:
In the Request Variable Array setting, enter the name of an array-type Request Variable. The size of this array will determine how many times this loop iterates.
In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.
Multi-instance (Sequential): Select the Multi-instance (Sequential) option. The settings for this loop mode display:
Follow these steps:
In the Request Variable Array setting, enter the name of an array-type Request Variable. The size of this array will determine how many times this loop iterates.
In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Follow these guidelines to set how to handle Script Task runtime errors:
Set how many seconds to wait when an unexpected error occurs during runtime before displaying the error in that Script Task, thereby causing that Request to be in Error status.
Set how many consecutive attempts to run the Script Task before displaying a runtime error.
Requests are going to wait the configured number of seconds and consecutive runtime attempts for an unresponsive Script Task before displaying the error.
Follow these steps to edit the Error Handling settings:
Select the Script Task element from the Process model in which to edit the Error Handling.
In the Timeout setting, configure how many seconds to wait for an unresponsive Script Task before declaring a time-out as follows:
Enter the number of seconds. Use the up and down arrows to increase or decrease seconds.
Set 0
for no timeout.
Leave empty to use the Script Task default setting.
In the Retry Attempts setting, configure how many times to re-run the Script Task if the Script Task returns a runtime error as follows:
Enter a number. Use the up and down arrows to increase or decrease the number.
Set 0
for no retry attempts.
Leave empty to use the Script Task default setting.
In the Retry Wait Time setting, configure how many seconds to wait before attempting a retry as follows:
Enter the number of seconds. Use the up and down arrows to increase or decrease seconds.
Set 0
for no timeout.
Leave empty to use the Script Task default setting.
Enable the Email Notification toggle to notify through an email to the Process Manager that there is a Script Task runtime error.
Each moment ProcessMaker evaluates workflow routing for an in-progress Request, ProcessMaker Platform also evaluates the Request data's conformity to the 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 Vocabulary's JSON schema.
If no Vocabularies are assigned, ProcessMaker Platform does not validate that Request data complies with a specific JSON schema prior to continuing workflow for that Request.
A 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 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.
Follow these steps to assign Vocabularies that validate Request data from a Script Task element:
Select the Script Task element from the Process model in which to assign Vocabularies that validate Request data prior to when this element completes.
Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.
From the Select Vocabulary drop-down menu, select a Vocabulary from which to validate Request data complies with its JSON schema.
Click Save.
Repeat Steps 3 through 6 as necessary for each Vocabulary required to validate Request data complies with its JSON schema.
After one or more Vocabularies are assigned to a Script Task element, the Vocabulary icon displays in that element.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Script Task element:
Select the Script Task element from the Process model in which to edit its identifier value.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the Script Task element's identifier to a unique value from all nodes in the Process model and then press Enter.
See for a description of the element.
See the permissions or ask your Administrator for assistance.
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains Process model objects which are easily accessible to add to the Process model.
.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Pinned Objects: The Task object category displays from the Pinned Objects section when it is . This element type is pinned by default.
Click the Task object category.
Click the Elements drop-down menu, and then select the Script Task option.
The Script Task element displays.
Ensure that the Task object category is pinned to the Objects bar. If not, it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Script Task element cannot be placed outside of the Pool element.
element ()
element ()
element ()
, and then move them collectively by dragging them to new locations in relation to one another.
and/or the element in relation to other selected elements and/or .
Pool element: If the Script Task element is inside of a element, it cannot be moved outside of the Pool element. If you attempt to do so, Process Modeler places the Script Task element inside the Pool element closest to where you attempt to move it.
After a Script Task element is , you may replace it with a different Task type or a Sub Process element:
element
element
element
.
Click the Elements icon. The Elements drop-down menu displays the Task type elements and the Sub Process element.
Select the element to replace the Script Task element. The Change Type screen displays to confirm replacing the currently selected element.
See .
See .
See .
See .
Documentation panel (available when the is installed)
Vocabularies panel (available when the is installed)
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
Since Script Task elements are designed to run a , specify which Script a selected Script Task element uses. A Script must already exist before it can be selected for use in a Script Task element.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Optionally, click the Open Script link to view and/or edit your selected Script. Note that your user account must have appropriate permissions to view and/or edit the selected Script.
After , optionally provide a JSON object that configures variable values for the selected Script. Providing a JSON script from the Script Task is identical to providing JSON configuration script in the Script Config JSON panel in Scripts Editor for a Script.
, including the section
, specifically the section how a JSON object is used to configure a Script for a Script Task element
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
.
Click the iconbeside the Script Configuration option. The Script Config Editor displays.
Click Close or the Close icon.
An element configured in this mode shows the Loop icon in Process Modeler.
An element configured in this mode shows the Multi-instance (Parallel) icon in Process Modeler.
An element configured in this mode shows the Multi-instance (Sequential) iconin Process Modeler.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
If the is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the .
The must be installed to view or edit the documentation for a Process element. Use the Documentation package to that includes an image of the Process map and entered description of its and .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Optionally, notify the of the Script Task runtime error via an in-platform or email notification.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Expand the Error Handling panel if it is not presently expanded. The Timeout setting displays.
Enable the In-app Notification toggle to notify through the user interface to the that there is a Script Task runtime error.
Assign that validate that 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 to make this configuration.
Use a Vocabulary on a Script Task element to validate that Request data complies with the Vocabulary's JSON schema after the Script Task runs its Script but prior to when the Request continues workflow. See for more information.
During an in-progress Request, if ProcessMaker Platform evaluates that the Request data no longer complies with all Vocabularies to that moment, the Request status changes from In Progress to Error. The error displays in the . 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.
One or more Vocabularies must be created before assigning a Vocabulary. See . Multiple Vocabularies can be assigned to a Script Task element.
The must be installed to assign which Vocabularies validate Request data at a Script Task element. Use the Vocabularies to maintain uniform JSON schemas across all assets in your organization. These assets include , , and.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Click theicon to add a Vocabulary. The Assign Vocabulary setting displays.
If no Vocabularies are configured, then the following message displays: List is empty. Create at least one Vocabulary. See .
Click the Remove iconfrom the Vocabularies setting to remove a Vocabulary from assignment to this element.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Add, copy, delete, change the color, align, and configure Form Task elements in your Process model.
See Process Modeling Element Descriptions for a description of the Form Task element.
Your user account or group membership must have the following permissions to configure a Form Task element in 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 Administrator for assistance.
Add a Form Task element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Form Task element from the Explorer panel to the Process model:
Locate the Task object category from one of the following locations in the Explorer panel:
Pinned Objects: The Task object category displays from the Pinned Objects section when it is pinned. This element type is pinned by default.
Object Category: The Task object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Follow these steps to add a Form Task element from the Objects bar to the Process model:
Click the Task object category'sobject category icon. This object's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After adding the Form 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:
Boundary Timer Event element (Don't know what that is?)
Boundary Error Event element (Don't know what that is?)
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Form Task element has the following limitations in regards to the following Process model elements:
Pool element: If the Form 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 Form Task element inside the Pool element closest to where you attempt to move it.
Lane element: If the Form Task element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Form Task element cannot be moved outside of the Pool element.
After a Form Task element is added to a Process model, you may replace it with a different Task type or a Sub Process element:
Manual Task element
Script Task element
Sub Process element
The selected Form Task element is replaced by the default settings and color of the replacing element.
Follow these steps to replace a Form Task element with a different Task type element or a Sub Process element:
Select the Form Type element to change to another element. Available options display above the selected element.
Click Confirm. The new element replaces the Form Task element with its default settings and color.
See Customize the Appearance of an Element or Connector.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Form Task element has the following panels that contain settings:
Loop Characteristics panel
Documentation panel (available when the Documentation package is installed)
Assignment Rules panel
Specify Task reassignment options
Notifications panel
Email Notifications panel (available when the Send Email package is installed)
Comments
Web Entry panel (available when the Web Entry package is installed)
Vocabularies panel (available when the Vocabularies package is installed)
Advanced panel
The Form Task element has multiple settings in the Configuration panel:
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 Form Task element:
Select the Form Task element from the Process model in which to edit its name.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays. This is a required setting.
In the Name setting, edit the selected element's name and then press Enter.
Since Form Task elements are designed to collect or display Request information, specify which Screen a selected Form Task element uses. A Screen must already exist before it can be selected for use in a Form Task element.
Ensure to select a Screen for each Form Task element in your Process model. If a Screen is not specified and Requests are started for that Process, the following placeholder Screen displays when that Form Task element triggers.
The placeholder Screen allows the Task assignee to continue the Request without causing it to pause indefinitely.
This functionality also allows Process Designers to place the basic Process objects into a Process model and then evaluate it during development.
Follow these steps to select a Screen for a Form Task element:
Select the Form Task element from the Process model in which to specify its Screen.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Screen For Input setting. This is a required setting.
From the Screen For Input drop-down menu, select which Screen that Form Task element references. After a Screen is selected, the Open Screen link displays.
Optionally, click the Open Screen link to view and/or edit your selected Screen. Note that your user account must have appropriate Screen category permissions to view and/or edit the selected Screen.
If no Screens exist, the Screen For Input drop-down menu contains no options. Ensure to select a Screen for every Form Task element in the Process model before deploying your Process.
Specify when a Task in a Form Task element is due from when that Task is assigned to a Request participant.
The Task due date displays for each pending assigned Task.
If an interrupting boundary-type event associated with the Form Task element triggers, workflow immediately routes through the interrupting boundary-type event. Therefore, any subsequent Task's due date following the boundary-type event applies.
The due date for a Task is unchanged in the following circumstances:
The Task is assigned to another user: If that Task is reassigned to another user, the time that task is due still applies; the elapsed time now applies toward the reassigned user.
An interrupting boundary-type event triggers: The boundary-type event has its own due date if applicable. Therefore, the Task to which the boundary-type event applies is unaffected.
After the specified time expires for a Task, an overdue indicator displays for that Task to the Task assignee.
Specify due time for a Form Task element in total number of hours. This includes hours not normally associated with business hours, including overnight hours, weekends, and holidays.
A Self Service Task can become overdue even though no members of a group have self-assigned that Task: the number of hours that Task is due begins as soon as that Task element triggers. Therefore, if configuring a Self Service Task, consider that the Form Task does not immediately have a Task assignee to do that Task.
When a Form Task element is placed into a Process model, the default period of time for a Task to be due is 72 hours (three days).
Follow these steps to specify when a Form Task element is due:
Select the Form Task element from the Process model in which to specify how many hours the Task is due.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Configuration panel if it is not presently expanded, and then locate the Due In setting.
In the Due In setting, specify the total number of hours the Task 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.
When the Display the Next Assigned Task to the Task Assignee setting is used in a Form Task element, a selected Display-type Screen displays after the Task for this Form Task element completes. An interstitial Screen displays while the Request resumes routing. Non-assigned automated actions run as part of that Request while the interstitial Screen displays. The interstitial Screen displays indefinitely until one of the following occurs:
The Request assigns another Task to the same Task assignee, at which time the new Task displays.
The Request completes, at which time the Request summary displays.
The user clicks a link to leave that page to display another location.
Use an interstitial Screen when the expected period of time that the next Task is assigned to the same Task assignee is short; otherwise, the interstitial Screen displays indefinitely without user intervention or the ProcessMaker Platform session expires.
Use the Display the Next Assigned Task to the Task Assignee setting in the following ways:
Tasks that use Conversational-type Screens: During an automated chat-style conversation with the Request participant using the Conversational Forms package, link Conversational Screens together while the Request resumes routing based on previous conversational responses by the participant. See What is a Conversational Screen? for information how to design modern-style chat experiences with Conversational Screens and the Conversational Forms package.
Tasks that use Form-type Screens: Display a message with a Display-type Screen in the following circumstances:
Next Task is for the same Task recipient: Design a Screen that reads Loading your next Task while the Request routes to the next Form Task or Manual Task element's Task for the same Task assignee.
See the tabs below for more information how to use the Display the Next Assigned Task to the Task Assignee setting with Conversational- and Form-type Screens.
After selecting the Display the Next Assigned Task to the Task Assignee setting, the Screen Interstitial setting displays to select which Screen displays between the Tasks. This behavior is different than the default functionality, whereby the To Do Tasks page displays after each Task completes.
The Display the Next Assigned Task to the Task Assignee setting applies only between this Form Task element and the subsequent Form Task element or Manual Task element to which the Request routes.
If the next Task is assigned to a different user or group, then the interstitial Screen displays until that Request completes or another Task is assigned that user.
Interstitial Screen usage have the following limitations:
Interstitial Screens inside of a child Process's Request only redirect to Tasks in that Request and its parent Request. However, if the Interstitial Screen is three or more levels removed from its source Request, Tasks are not redirected.
An Interstitial Screen inside of a child Request that directly follows a Web Entry Start Event element can not redirect back to the parent Request. Instead the Interstitial Screen may only redirect to Tasks in the child Request.
The Display the Next Assigned Task to the Task Assignee setting has two purposes depending on whether the Form Task element's Task uses a Conversational- or Form-type Screen.
Use the Display the Next Assigned Task to the Task Assignee setting to link Conversational Screens together while the Request resumes routing based on previous conversational responses by the participant. Multiple elements and connectors may perform automatic tasks after this Form Task element's Task and before the next Conversational Screen's Task triggers in that Request. However, the Request participant experiences a seamless conversation between the two Conversational Screens' Tasks while the interstitial Screen displays in the chat box. For example, use a Screen that uses an Image or Rich Text control that displays an animated GIF to imply that the other conversational participant is typing.
Non-assigned automated actions run as part of that Request while the interstitial Screen displays. When the Request assigns the next Task to that Task assignee, the new Task displays in the chat box as continued conversation in a seamless chat experience to the Request participant.
Use the Display the Next Assigned Task to the Task Assignee 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 the next Task immediately after submitting the current Task in that Request, especially if other elements and connectors are between Form Task and/or Manual Task elements so that Tasks are assigned quickly.
Follow these steps to configure a Form Task element to display an interstitial Screen while the next assigned Task displays to the Task assignee:
Select the Form Task element from the Process model in which to configure it to display an interstitial Screen after its Task completes.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Screen Interstitial drop-down menu, select which Display-type Screen to display after this Form Task element's Task completes. This is a required setting.
Use the Loop Characteristics panel settings to specify how to perform multiple instances of this element. The following loop modes are available for this element:
No Loop Mode: Select the No Loop Mode option to perform this element's Task only once.
Loop: Select the Loop option to sequentially repeat this element's Task multiple times until an exit condition is True
. This is useful when a Task should be performed multiple times with the same set of data, such as, processing a credit card payment. This loop mode has the following characteristics:
The element's Task is repeated until the exit condition is True
or the maximum iterations limit is reached.
At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.
The same exit condition evaluates at the end of each instance; however, value(s) of the Request variable(s) used in the exit condition can change during an instance resulting in the exit condition to eventually evaluate as True
.
If any one instance of that Task does not complete, workflow pauses.
All active instances are terminated if an interrupting boundary-type event element triggers.
Multi-instance (Parallel): Select the Multi-instance (Parallel) option to perform this element's Task multiple times in parallel a fixed number of times. This is useful when performing any action in bulk, such as sending an email to several people. This loop mode has the following characteristics:
Instances of the Task are governed by the size of an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this Task that each contains data from its respective array index.
All instances begin simultaneously when this element triggers; however, they perform their Task independently of each other.
The Task as a whole completes when all instances are complete.
The output from each instance can either be saved in the source Request variable or a new array-type Request variable.
All active instances terminate if an interrupting boundary-type event element triggers.
Multi-instance (Sequential): Select the Multi-instance (Sequential) option to perform this element's Task multiple times sequentially a fixed number of times or until an exit condition is True
. This is useful when sequentially repeating a Task multiple times but with a different set of data each time. This loop mode has the following characteristics:
Instances of the Task are governed by the size an array-type Request variable where a new instance is created for each item in this variable. For example, an array with 10 items will create 10 parallel instances of this Task that each contains data from its respect array index.
At any given time, only one instance of the Task is active. The subsequent instance does not begin until the current instance completes.
At the end of each instance an exit condition evaluates and the loop activity halts if the exit condition is True
.
The Task as a whole completes when all instances are complete.
The output from each instance can either be saved in the source Request variable or a new array-type Request variable.
All active instances terminate if an interrupting boundary-type event element triggers.
Follow these steps to specify characteristics to perform multiple instances of the Task:
Select the element from the Process model in which to specify multiple instance characteristics.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Loop Characteristics panel. The Loop Characteristics setting displays. By default, Loop Activity is set to No Loop Mode and the Task is performed only once.
From the Loop Mode setting, select one of the following options to perform this element's Task more than once.
Loop: Select the Loop option. The settings for this loop mode display:
Follow these steps:
In the Maximum Iterations setting, enter an integer value representing the maximum number of times this Task should be performed.
In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
Multi-instance (Parallel): Select the Multi-instance (Parallel) option. The settings for this loop mode display:
Follow these steps:
In the Request Variable Array setting, enter the name of an array-type Request Variable. The size of this array will determine how many times this loop iterates.
In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.
Multi-instance (Sequential): Select the Multi-instance (Sequential) option. The settings for this loop mode display:
Follow these steps:
In the Request Variable Array setting, enter the name of an array-type Request Variable. The size of this array will determine how many times this loop iterates.
In the Exit Condition setting, enter a condition in FEEL syntax. When this condition is True the loop activity is halted.
In the Output Data Variable setting, enter the name of an array-type Request variable in which to store the results of all instances. Each instance of the loop saves to a separate JSON object within the array of the specified Request variable. If the Output Data Variable setting is not configured, then the output data replaces the source data in the Request Variable Array.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Specify whom to assign the Task or to use assignment rules to assign the Task.
Instead of specifying the Task's assignee using one or more rules, select to whom to assign a Task:
Previous Task assignee: Assign that Task to the previous Task assignee in that Request's workflow.
Request starter: Assign that Task to the user that started the Request.
Process variable: Assign the Task to a user or group based on the value of a Request variable.
Process Manager: That Task assigns to the Process Manager of the Process when all other configured assignment conditions do not occur.
Optionally, affect how an assigned Task can route after the initial assignment:
Self service: Use the self-service Task option to allow self-service Task assignment. Doing so allows any member in a specified group assigned that Task to self-assign the Task from a queue. Note that the self-service Task option is not available unless assigning a Task to a user, group, via a Request variable, or rule expression.
Lock user assignment: Use the Lock User Assignment option to assign this Task to the same Task assignee if workflow in that Request returns to this Task. If the initial Task assignee was a member of a group, the Task is reassigned to the same 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.
Allow reassignment: Enable the Allow Reassignment option to allow the Task assignee to reassign the Task if necessary. When using the Allow Reassignment option, the Reassign button displays in the Task summary to allow that Task assignee to reassign that Task. See View a Task Summary.
Allow manager escalation: Use the Allow Manager Escalation option to allow users to manually assign this Task to their manager. When this option is enabled, the Escalate to Manager button appears when viewing a Task's summary. This setting is only available if the Advanced User package is installed.
Assign to manager: Use the Assign to Manager option to assign that Task to the manager of that assignee's manager. As part of the Advanced User package, an Administrator can configure the manager for each user. The user account for that Task assignee must be configured from each user's account to route that Task to the assignee's manager.
If this Form Task element is configured to assign the Task to an anonymous person who started this Request via Web Entry, the settings described below are disabled because these Form Task element settings only configure which authenticated user(s) may assigned this Task. Therefore, to configure these settings, either disable Web Entry or select that authenticated users may start Requests from this element via Web Entry. See Web Entry Panel Settings.
To allow the same anonymous person who started that Request or which authenticated users may be assigned the Form Task element's Task via a published URL, do not configure those persons from the Assignment Rules panel. Configure those persons from the Web Entry panel.
Follow these steps to select to whom to assign the Task that is referenced in a Form Task element:
Select the Form Task element from the Process model in which to select the Task assignee.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Assignment Rules panel if it is not presently expanded. The Assignment Type setting displays. The Request Starter option is the default, thereby affecting options below it.
From the Assignment Type drop-down menu, select one of the following options:
From the Assigned Users/Groups drop-down menu, select one or more users and/or groups to assign this Task. The Task is assigned following this protocol:
One user: The Task is assigned to the selected user.
One or more users and/or group(s): The Task is assigned randomly to one of those users or group members. The exception is if the Self Service toggle key is enabled, then the Task remains unassigned, in a queue, for one of those users to self-assign from the Self Service Task page.
Previous Task Assignee: Select Previous Task Assignee to assign the Task to who was assigned the previous Task in this Request. The Self Service toggle key is not available since the Task has a specific assignee.
Request Starter: Select Request Starter to assign the Task to the Request starter. This is the default option. The Self Service toggle key is not available since the Task has a specific assignee.
Process Variable: Select Process Variable to assign the Task determined by the value of a Request variable. The entered Request variable(s) may be one or both of the following:
Variable Name (Users): In the Variable Name (Users) setting, enter the Request variable that contains the user ID(s) for one or more users who might be assigned this Task. If more than one user ID is included the Request variable's value, then the Task is assigned randomly to one of those users. The exception is if the Self Service toggle key is enabled, then the Task remains unassigned, in a queue, for one of those users to self-assign from the Self Service Task page.
Follow these steps to define an expression:
In the FEEL Expression setting, enter or edit the expression that determines that Form Task element's Task assignee using the syntax components described in Expression Syntax Components, and then press Enter.
From the Assign to User/Group drop-down menu, select the user or group to whom to assign that Task if the expression in the FEEL Expression setting evaluates as True.
From the Default Assignment drop-down menu, select a user or group to assign that Task to if none of the expressions evaluate as True.
Process Manager: Select Process Manager to assign the Task to the Process Manager. This option is only available if the Advanced User package is installed. Ensure to configure the Process Manager for this Process.
Enable the Self Service toggle key to allow self-service Task assignment. Doing so allows any member in a specified group assigned that Task to self-assign the Task from a queue. Note that the Self Service toggle key is not available unless the Users / Groups, Process Variable, or Rule Expression options are selected from the Assignment Type setting.
Enable the Assign to Manager toggle key to assign that Task to the manager of that assignee's manager. As part of the Advanced User package, an Administrator can configure the manager for each user. The user account for that Task assignee must be configured from each user's account to route that Task to the assignee's manager.
Enable the Allow Reassignment toggle key 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.
Enable the Allow Manager Escalation toggle key to automatically reassign this Task to the Task assignee's manager. This setting is only available if the Advanced User package is installed. As part of the Advanced User package, an Administrator can configure the manager for each user.
If you enable the Allow Reassignment option, ensure that this Task is assigned to more than one user or to a group. Otherwise, despite the availability of the Reassign button in the Task summary, that Task assignee has no users to which to reassign this Task unless that user started that Request.
If this Form Task element is configured to assign the Task to an anonymous person who started this Request via Web Entry, the settings described below are disabled because these Form Task element settings only configure which authenticated user(s) may assigned this Task. Therefore, to configure these settings, either disable Web Entry or select that authenticated users may start Requests from this element via Web Entry. See Web Entry Panel Settings.
Set email notifications for Tasks separately. Settings in the Notifications panel configure Task notifications only within the ProcessMaker Platform application.
Set when notifications regarding Tasks are sent to the following:
Requester: Send notifications to the Request initiator (referred to as the Request starter) when the Task associated with this Form Task element is assigned and/or completed.
Task assignee: Send notifications to Task assignees associated with this Form 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 Form ask element is assigned or completed.
Process Manager: Send notifications to the Process Manager when the Task associated with this Form Task element is assigned or completed. This option is only available if the Advanced User package is installed. Ensure to configure the Process Manager for this Process.
Follow these steps to set Task notifications in a Form Task element:
Select the Form Task element from the Process model in which to set Task notifications.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Notifications panel if it is not presently expanded. Settings display to set Task notifications.
From the Requester settings, set Task notifications for the Request starter following these guidelines:
Enable the Assigned setting to notify the Request starter when the Task associated with this Form Task element is assigned. Otherwise, disable this setting to not send this notification.
Enable the Completed setting to notify the Request starter when the Task associated with this Form Task element is completed. Otherwise, disable this setting to not send this notification.
Enable the Due setting to notify the Request starter when the Task associated with this Form Task. Otherwise, disable this setting to not send this notification.
From the Assignee settings, set Task notifications for assignees of this Task element following these guidelines:
Enable the Assigned setting to notify Task assignees associated with this Form 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 Form 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 Form Task element is due to be completed. Otherwise, disable this setting to not send this notification.
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 Form 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 Form 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 Form Task element is due to be completed. Otherwise, disable this setting to not send this notification.
Enable the Due setting to notify the Request starter when the Task associated with this Form Task element is due to be completed. Otherwise, disable this setting to not send this notification.
From the Process Manager settings, set Task notifications for the Process Manager following these guidelines:
Enable the Assigned setting to notify the Process Manager when the Task associated with this Form Task element is assigned. Otherwise, disable this setting to not send this notification.
Enable the Completed setting to notify the Process Manager when the Task associated with this Form Task element is completed. Otherwise, disable this setting to not send this notification.
Enable the Due setting to notify the Process Manager when the Task associated with this Form Task element is due to be completed. Otherwise, disable this setting to not send this notification.
Set ProcessMaker Platform application notifications for Tasks separately. Settings in the Email Notifications panel configure only email notifications for Tasks.
The Email Notification panel is available only when the Send Email package is installed.
The following may be email Task notification recipients:
Specific email addresses for individuals who are not users in your ProcessMaker Platform instance.
The email body for the Task notification may be plain text or referenced from an Email-type Screen. If referencing the email body from a Display-type 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 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 Screen.
Set when email Task notifications are sent to email recipients:
Task trigger: Send email notifications when the Task triggers.
Task completion: Send email notifications when the 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:
Email Notifications settings in Form Task elements are not included when importing a Process. Configure Email Notifications settings after importing the Process instead.
Follow these steps to set the email Task notification's subject and body content in a Form Task element:
Select the Form Task element from the Process model in which to set email Task notifications.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
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:
In the setting below the Plain Text option, revise the default text if necessary that displays as the email body. By default, ProcessMaker Platform displays the current Form Task element's Name setting as part of the Plain Text option.
Display Screen:
Select the Display Screen option to select an Email-type Screen from which to display its content as the email body. Follow these steps:
From the drop-down menu below the Display Screen option, select from which Screen to display its content as the email body. Only Email-type Screens display from this drop-down menu.
Optionally, click the Open Screen link to view and/or edit your selected Screen. Note that your user account must have appropriate Screen category permissions to view and/or edit the selected Screen.
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 Form Task element.
Use the Add a Recipient setting to set which users, groups, and/or email addresses to send this email notification.
When setting the recipient as a group, optionally organize groups to more flexibly manage email notifications. To do so, create groups with a specific set of users. Thereafter, add the individual groups as the email recipient.
Follow these steps to set the recipient(s) for this email notification:
Users and Groups: Send this email to user(s) or group(s). When this option is selected, the Send to Users and Groups setting displays. Select a user or group from the available list.
Requester: Send this email to the user who started this Request.
Participants: Send this email to all users participating in this Request.
User ID: Send this email to a user based on the value of a Request variable. When this option is selected, the Send to User ID setting displays. Enter a variable name in this setting. A valid user name must be assigned to this variable in a previous step in the Request.
Email Address: Send this email to the entered email address. When this option is selected, the Send to Email Address setting displays. Enter a single email address or multiple email addresses separated by commas with no spaces.
For example: amanda@mycompany.com,john@homeoffice.com
.
Alternatively, enter a Request variable in mustache syntax that contains a comma delimited string of multiple email addresses.
Process Manager: Send this email to the Process Manager assigned in the Process's configuration.
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 Form Task element.
Use the Attach File setting to specify one or more file(s) to attach with this email notification. Follow these steps:
From the Source setting, select one of the following options:
URL: Select the URL option. The URL settings display. Follow these guidelines:
Request Variable: Select the Request Variable option if it is not selected. This is the default option. The Request Variable setting displays. Follow these guidelines:
Click Save. The Request variable referencing the file displays.
Request Array: Select the Request Array option to attach multiple files. The Request Array Variable Name and Variable in Array settings display. Follow these guidelines:
In the Request Array Variable Name setting, enter an array-type Request variable. This variable must already be linked to a File Upload control with Upload Multiple Files option enabled in the same Request. When the Request is in-progress, any files uploaded using this File Upload control are attached to this email.
In the Variable in Array setting, enter the name of a variable in the Request Array Variable containing ID of the file to be attached. If the Request Array Variable is a simple array containing a list of files, leave this setting blank.
Repeat steps 3 and 4 to add additional files.
These instructions continue from the Select Files to Attach to This Email Notification section. An email notification is an aggregate of multiple settings in the Email Notifications panel for a selected Form Task element.
Use the Send At or Expression settings to set when this email notification is sent. Follow these steps:
Optionally, select files to attach to this email notification.
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 Form Task element triggers. This is the default option.
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:
Follow these steps to edit an email notification:
Select the Form Task element from the Process model in which to edit an email notification.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Email Notifications panel if it is not presently expanded. Email notifications display below the Notifications setting.
Edit the email notification settings as described in the following sections:
Follow these steps to copy an email notification:
Select the Form Task element from the Process model in which to copy an email notification. Panels to configure this element display.
Expand the Email Notifications panel if it is not presently expanded. Email notifications display below the Notifications setting.
Edit the copied email notification settings as described in the following sections:
Consider carefully when deleting an email notification. Deleting a configured email notification cannot be undone.
Follow these steps to delete an email notification:
Select the Form Task element from the Process model in which to delete an email notification.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Email Notifications panel if it is not presently expanded. Email notifications display below the Notifications setting.
Click Delete.
Configure which commenting functions Task assignees of this Form Task element may use in Task summaries.
Configure which commenting functions are allowed for a Process's Request summaries in Process configuration. Commenting function allowances in Form Task elements and Manual Task elements do not affect commenting allowances for this Process's Request summaries.
All commenting functions are restricted by default. If the Allow Comments commenting function is enabled, then the remaining commenting functions may be configured, but are restricted by default:
Allow comments: The Form Task element must be configured to allow comments in Tasks from that Form Task element.
The Comments package must be installed to use commenting functions in Requests or Tasks.
Follow these steps to configure which commenting functions Task assignees from this Form Task element may use:
Select the Form Task element from the Process model in which to configure commenting functions.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Toggle any of the following settings as necessary to allow commenting functionality in this Form Task element's Task summaries:
Allow Reactions: Toggle the Allow Reactions toggle key to allow or restrict emoticon reactions in this Form Task element's Task summaries.
Allow Voting: Toggle the Allow Voting toggle key to allow voting to sent comments in this Form Task element's Task summaries. Voting allows Request participants to vote on the merits of a sent comment and provide feedback to the Request participant that sent that comment.
Allow Comment Editing: Toggle the Allow Comment Editing toggle key to allow or restrict Request participants to edit their own sent comments in this Form Task element's Task summaries.
Allow Comment Deletion: Toggle the Allow Comment Deletion toggle key to allow or restrict Request participants to delete their own sent comments in this Form Task element's Task summaries.
When a Form Task element is placed into a Process model, Web Entry settings for that element are not configured. Therefore, even if the Web Entry package is installed, it must be configured for use.
The Screen used for Web Entry does not display in the Forms tab in those Request summaries started via Web Entry.
In overview, configuring Web Entry involves making the following decisions:
To Whom to assign the Task: Decide to assign the Task to the anonymous person that started this Request via Web Entry or only to one of the authenticated user(s) specified from the Assignment Rules panel. In conjunction, decide the following based on who may start the Request:
Assign the Task to the anonymous Request starter: Decide any of the following:
Require that the anonymous Request starter be logged on to ProcessMaker Platform to perform the Web Entry Task.
Password-protect access to the Web Entry.
Exclude specific Request data from being included in the Web Entry Task so that it does not display in the Screen for that Task. Specify the Request variable name to exclude as indicated by the Screen control's Variable Name setting value.
Authenticated user: Decide any of the following:
Require that the Task assignee have participated previously in this Request.
Exclude specific Request data from being included in the Web Entry Task as described above.
Screen for the chat or Task: Select from which Screen the Task assignee interacts with this Request. This may be one of the following types of Screens:
Conversational-type: The Task assignee interacts in an automated chat-style correspondence by responding to questions and responses, and then either submits the chat or the Screen submits itself if it times out from interaction. The Conversational-type Screen is available only if the Conversational Forms package is installed.
Form-type: The Task assignee enters information into an interactive form, and then submits the Task to continue that Request.
Completed action after Screen submission: Decide whether to display a separate Screen when the Task completes or to route the Task assignee to a URL. If to display a Screen, select that Screen.
Embed the Web Entry into a third-party site: If embedding the Web Entry into a third-party site, decide one or both of the following:
Embed the Web Entry if using a Form-type Screen: Copy the JavaScript that contains the Web Entry URL, and then embed that JavaScript into your Web server's or blog's HTML header.
Embed the Web Entry if using a Conversational-type Screen: Copy the JavaScript that contains the Web Entry URL, configure options how the chat-style presentation displays in your site, and then embed that JavaScript into your Web server's or blog's HTML header.
The Web Entry package must be installed to select to whom to assign a Task via a Web entry. The Web Entry package allows anonymous or authenticated users to start or participate in Requests via a published URL.
Follow these steps to select to whom to assign the Task via a Web Entry:
Select the Form Task element from the Process model in which to select to whom to assign the Task via a Web Entry.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Mode drop-down menu, select one of the following options:
Disabled: Select the Disabled option to disable the Web Entry package from assigning this Form Task element via a Web Entry. This is the default setting.
Anonymous: Select the Anonymous option to assign the Task to the anonymous person that started this Request via Web Entry from a Start Event element. This person is not to be a user.
If selecting the Anonymous option, consider using the following settings:
Require Valid Session: Select the Require Valid Session immediately below the Mode setting to require that the anonymous Request starter be logged on to ProcessMaker Platform to perform the Web Entry Task.
Enable Password Protect: Select the Enable Password Protect setting below the Completed Action setting (described below) to require a password to access the Web Entry.
Authenticated: Select the Authenticated option to assign the Task to an authenticated user or group member. If an authenticated user or group member is already selected from the Assignment Rules panel, then only one of those user(s) may be assigned this Task from this Form Task element.
If selecting the Authenticated option, consider using the Require Valid Session immediately below the Mode setting to require that the Task assignee have participated previously in this Request.
Select the Require Valid Session setting to require one of the following depending on whether the Anonymous or Authenticated User option is selected from the Mode setting described above:
Anonymous: Require that the anonymous Request starter be logged on to ProcessMaker Platform to perform the Web Entry Task.
From the Screen Associated drop-down menu, select the Screen that displays the assigned Task when the Web Entry URL is accessed. This drop-down menu displays only Conversational and Form types so the Task assignee can interact with information in the Screen. This is a required setting.
Optionally, click the Open Screen link to open the selected Screen in a separate Web browser window.
From the Completed Action drop-down menu, select one of the following options:
After the Screen option is selected, the Screen For Completed setting displays below the Completed Action drop-down menu. From the Screen For Completed drop-down menu, select the Screen that displays after submitting the Screen selected from the Screen Associated drop-down menu. This drop-down menu displays only Display types to display a message to the request starter. This is a required setting.
Optionally, click the Open Screen link to open the selected Screen in a separate Web browser window.
URL: Select the URL option to indicate that the Task assignee is redirected to a URL after the Task assignee submits the Screen selected from the Screen Associated drop-down menu.
After the URL option is selected, the Redirect URL setting display below the Completed Action option. From the Redirect URL setting, enter the URL to which the Task assignee redirects after submitting the Task's Screen selected from the Screen Associated drop-down menu, and then press Enter. The redirect URL supports mustache syntax to reference the value of a Request variable as the URL. This is a required setting.
In the Password Protect setting, enter the password that the anonymous Request starter assigned this Task must enter to access the Web Entry.
Follow these guidelines to specify Request data to exclude from the Web Entry Task:
Enter the Request variable name into the setting.
The Web Entry URL displays the Web Entry URL from which the Task assignee accesses the Web Entry. The Web Entry URL value cannot be changed. ProcessMaker Platform generates this URL using the following structure: ProcessMaker Platform instance domain
/webentry/
Web Entry numerical instance
/
Identifier Value of this Form Task element
. If necessary, click the Copy button below the Web Entry URL setting to copy the Web Entry URL so that it is available in your clipboard.
Configure how the chat box displays in the embedded container from the following options:
From the Position setting, select one of the following options:
Fill Container: The chat box displays the width of the container to which the Web Entry's JavaScript code is applied. This is the default setting. When the Fill Container setting is selected, all other settings in the Embed Options screen are disabled.
Top Left: The chat box displays in the top left corner of the container to which the Web Entry's JavaScript code was applied.
Top Right: The chat box displays in the top right corner of the container to which the Web Entry's JavaScript code was applied.
Bottom Left: The chat box displays in the bottom left corner of the container to which the Web Entry's JavaScript code was applied.
Bottom Right: The chat box displays in the bottom right corner of the container to which the Web Entry's JavaScript code was applied.
In the Title setting, enter the title that displays in the chat box. Form is the default setting. This setting does not apply when the Fill Container option is selected from the Position setting.
From the Color setting, select the color that displays for button to show the chat box and for the chat box frame itself. The left-most color option is the default. This setting does not apply when the Fill Container option is selected from the Position setting.
From the Icon setting, select an icon that displays to show the chat box. The Question Circle is the default option. This setting does not apply when the Fill Container option is selected from the Position setting.
Click Save.
Assign Vocabularies that validate that 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 to make this configuration.
Use a Vocabulary on a Form Task element to validate that Request data complies with the Vocabulary's JSON schema after the Task assignee submits the Task User Documentation. See What is a Vocabulary? for more information.
Each moment ProcessMaker evaluates workflow routing for an in-progress Request, ProcessMaker Platform also evaluates the Request data's conformity to the 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 Vocabulary's JSON schema.
During an in-progress Request, if ProcessMaker Platform evaluates that the Request data no longer complies with all Vocabularies to that moment, the Request status changes from In Progress to Error. The error displays in the Request summary. 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 Vocabularies are assigned, ProcessMaker Platform does not validate that Request data complies with a specific JSON schema prior to continuing workflow for that Request.
One or more Vocabularies must be created to your ProcessMaker Platform instance before assigning a Vocabulary. See Create a New Vocabulary. Multiple Vocabularies can be assigned to a Form Task element.
The Vocabularies package must be installed to assign which Vocabularies validate Request data at a Task element. Use the Vocabularies package to maintain uniform JSON schemas across all assets in your organization. These assets include Processes, Screens, and Scripts.
A 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 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.
Follow these steps to assign Vocabularies that validate Request data from a Form Task element:
Select the Form Task element from the Process model in which to assign Vocabularies that validate Request data prior to when this element completes.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Select Vocabulary drop-down menu, select a Vocabulary from which to validate Request data complies with its JSON schema.
If no Vocabularies are configured in your ProcessMaker Platform instance, then the following message displays: List is empty. Create at least one Vocabulary. See Create a New Vocabulary.
Click Save.
Repeat Steps 3 through 5 as necessary for each Vocabulary required to validate Request data complies with its JSON schema.
After one or more Vocabularies are assigned to a Form Task element, the Vocabulary icon displays in that element.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Form Task element:
Select the Form Task element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.
In the Node Identifier setting, edit the Form Task element's identifier to a unique value from all nodes in the Process model and then press Enter.
Add, delete, and configure Data Store element in your Process model.
See Process Modeling Element Descriptions for a description of the Data Store element.
Your user account or group membership must have the following permissions to configure a Data Store element in 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 Administrator for assistance.
Add a Data Store element from one of the following locations in Process Modeler:
Explorer panel: The Explorer panel is to the left of the Process Modeler canvas. The Explorer panel contains Process model objects and PM Blocks which may be added to the Process model.
Objects bar: The Objects bar is at the bottom of the Process Modeler canvas. This bar contains pinned Process model objects which are easily accessible to add to the Process model.
Follow these steps to add a Data Store element from the Explorer panel to the Process model:
Locate the Data Store object category from one of the following locations in the Explorer panel:
Pinned Objects: The Data Store object category displays from the Pinned Objects section when it is pinned. This element type is not pinned by default.
Object Category: The Data Store object category displays from the Object Category section when it is not pinned.
Its icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
Follow these steps to add a Data Store element from the Objects bar to the Process model:
Click the Data Store object category's icon. This object's icon displays adjacent to the mouse icon to indicate this element type may be placed into the Process model.
After the element is placed into the Process model, you may adjust its location in the following ways:
Move the element by dragging it to a new location.
Select the element with other elements and/or connectors, and then move them collectively by dragging them to new locations in relation to one another.
Align and/or distribute the element in relation to other selected elements and/or connectors.
Moving a Data Store element has the following limitations in regards to the following Process model elements:
Pool element: If the Data Store 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 Data Store element inside the Pool element closest to where you attempt to move it.
Lane element: If the Data Store element is inside of a Lane element, it can be moved to another Lane element in the same Pool element. However, the Data Store element cannot be moved outside of the Pool element.
See Change a Process Model Object's Color.
See Copy Elements and Connectors into the Clipboard.
See Clone Elements and Connectors Without the Clipboard.
See Delete Elements and Connectors.
The Data Store element has the following panels that contain settings:
Configuration panel
Documentation panel (available when the Documentation package is installed)
Advanced panel
Process Modeler automatically assigns a default name to a new Data Store element. However, change the name to provide context to your Process model.
Follow these steps to edit the name for a Data Store element:
Select the Data Store element from the Process model in which to edit its name.
In the Name setting, edit the selected element's name to display in the Process model and then press Enter.
If the Documentation package is installed, describe the element's purpose and how it functions in the Process. This description does not affect Requests for the Process, but may be useful for Process model maintenance such as how the element is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
A Process's entered documentation displays by selecting the View Documentation icon for that Process.
The Documentation package must be installed to view or edit the documentation for a Process element. Use the Documentation package to view documentation for Processes that includes an image of the Process map and entered description of its elements and connectors.
Follow these steps to edit the description for an element:
Select the element from the Process model in which to edit its description.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Follow these guidelines to use the WYSIWYG rich text editor to stylize your text:
Select the required text from the Rich Text control.
In the URL setting, enter the destination URL.
In the Text to display setting, edit or enter the text displayed in the Rich Text control.
In the Title setting, enter the text to display when a user hovers over the displayed text.
From Open link in… drop-down menu, select one of these options:
New window: Select this option to open the destination page in a new browser window.
Current window: Select this option to open the destination page in the current browser window.
In the Source setting, enter a URL for the image.
In the Alternative Description setting, enter the text to display if the source URL of the image is not accessible.
In the Width setting, enter the maximum width for the image.
In the Height setting, enter the maximum height for the image.
Click Save.
Format text: Follow these guidelines to format text:
Headings: From the Paragraph/Formats menu, select Headings and then select a heading size.
Bold: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Bold.
Italics: Do one of the following:
From the Paragraph/Formats menu, select Inline and then Italic.
Underline: From the Paragraph/Formats menu, select Inline and then Underline.
Strikethrough: From the Paragraph/Formats menu, select Inline and then Strikethrough.
Superscript: From the Paragraph/ Formats menu, select Inline and then Superscript.
Subscript: From the Paragraph/Formats menu, select Inline and then Subscript.
Code: From the Paragraph/Formats menu, select Inline and then Code.
Paragraph: From the Paragraph/Formats menu, select Blocks and then Paragraph.
Blockquote: From the Paragraph/Formats menu, select Blocks and then Blockquote.
Division: From the Paragraph/Formats menu, select Blocks and then Div.
Preformatted: From the Paragraph/Formats menu, select Blocks and then Pre.
Select one of the color swatches from the color palette. The selected text changes to that color.
Align text: Follow these guidelines to align text:
Left align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Left.
Center align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Center.
Right align: Do one of the following:
From the Paragraph/Formats menu, select Align and then Right.
Justify: Do one of the following:
From the Paragraph/Formats menu, select Align and then Justify.
Process Modeler automatically assigns a unique value to each Process node added to a Process model. However, a node's identifier value can be changed if it is unique to all other nodes in the Process model, including the Process model's identifier value.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a Data Store element:
Select the Data Store element from the Process model in which to edit its identifier value.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Node Identifier setting, edit the element's identifier to a unique value from all nodes in the Process model and then press Enter.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Task object category.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Form Task element cannot be placed outside of the Pool element.
Ensure that the Task object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Form Task element cannot be placed outside of the Pool element.
Click the Elements icon. The Elements drop-down menu displays the Task type elements and the Sub Process element.
Select the element to replace the Form Task element. The Change Type screen displays to confirm replacing the currently selected element.
A Script Task element, then an End Event element, follow this Form Task element: If a Script Task element, and then an End Event element, immediately follow this Form Task element with connecting Sequence Flow elements (see example below), then use the Display the Next Assigned Task to the Task Assignee setting to ensure that a Screen that summarizes that completed Request displays.
Expand the Configuration panel if it is not presently expanded, and then locate the Display Next Assigned Task to Task Assignee setting.
Select the Display Next Assigned Task to Task Assignee setting. The Screen Interstitial setting displays.
An element configured in this mode shows the Loop iconin Process Modeler.
An element configured in this mode shows the Multi-instance (Parallel) iconin Process Modeler.
An element configured in this mode shows the Multi-instance (Sequential) iconin Process Modeler.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Users / Groups: Select Users/Groups to assign the Task to a specified user or randomly to a group member. When this option is selected, the Assigned Users/Groups drop-down menu displays below the Assignment Type drop-down menu. Notice that the Self Service toggle key is available.
Variable Name (Groups): In the Variable Name (Groups) setting, enter the Request variable that contains the group ID(s) in which its members may be assigned this Task. The Task is assigned randomly to one of those users. The exception is if the Self Service toggle key is enabled, then the Task remains unassigned, in a queue, for one of those users to self-assign from the Self Service Task page.
Rule Expression: Select Rule Expression to assign the Task's assignee using one or more rules. The rule expressions follow the Friendly Enough Expression Language (FEEL) syntax described in Expression Syntax Components. Notice that the Self Service toggle key is available.
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. To add an expression, click the addbutton. The Add FEEL Expression settings display.
Enable the Lock User Assignment toggle key to assign this Task to the same Task assignee if workflow in the Request returns to this Task. If the initial Task assignee was a member of a group, the Task is reassigned to the same 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.
Expand the Email Notifications panel if it is not presently expanded. The Notifications setting displays.
Click the iconto add an email notification. The Add Notification settings display.
From the Subject setting, revise the default text if necessary that displays as the email subject. By default, ProcessMaker Platform displays the current Form Task element's Name setting as part of the Subject setting.
From the Body setting, ensure that the Plain Text option is selected.
From the Body setting, ensure that the Display Screen option is selected.
From the Add a Recipient setting, select the recipient(s) of this email. To remove an email recipient that is currently added, click theicon. Choose one of these options:
Click the +File button to specify the files to attach to this email notification. The Attach File settings displays:
In the URL setting, enter the URL referencing an attached file to be accessed from a Web address.
Click Save. The URL referencing the file displays.
In the Request Variable Name setting, enter a Request variable name without the mustache syntax. This variable must already be linked to a File Upload control in a Screen in the same Request. When the Request is in-progress, any file uploaded using this File Upload control is attached to this email notification. This is a required setting.
Click Save. The Request variable referencing the files displays.
Optionally, click on the Deleteicon to delete any referenced file from being attached to the email.
Task Completion: Select the Task Completion option to send this email notification when this Form Task element completes (when the Task assignee submits the Screen associated with this 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.
Click the Edit iconbeside the email notification to edit.
Click the Duplicate iconbeside the email notification to copy. The email notification is copied.
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?
Add reactions to comments: Add emoticon reactions in sent comments to Tasks from this Form Task element. When emoticon reactions are allowed, each sent comment from this element's Tasks displays the reaction iconbelow each sent comment from which a Request participant may click to select an emoticon reaction to a selected comment.
Allow comment voting: Vote on sent comments to Tasks from this Form Task element. Voting allows Request participants to vote on the merits of a sent comment and provide feedback to the Request participant that sent that comment. When comment voting is allowed, each sent comment from this element's Tasks displaysandicons below each comment from which to vote favorably or unfavorably to that comment, respectively.
Allow comment editing: Request participants may edit their own sent comments in this Form Task element's Tasks. When comment editing is allowed, aicon displays above each comment a Request participant sent to that Task. Theicon does not display above comments for Request participants that did not send that comment.
Allow comment deleting: Request participants may delete their own sent comments in this Form Task element's Tasks. When comment deleting is allowed, aicon displays above each comment a Request participant sent to that Task. Theicon does not display above comments for Request participants that did not send that comment.
Expand the Comments panel if it is not presently expanded. The Comments toggle key displays as disabled by default.
Toggle the Comments toggle key to allow commenting functions in Tasks from this Form Task element. Toggle keys for available commenting functions display. All commenting functions are disabled by default unless they have been previously configured. This commenting function configuration only affects Tasks from this Form Task element.
Expand the Web Entry panel if it is not presently expanded. The Mode setting displays.
Authenticated User: Require that the Task assignee have participated previously in this Request.
Screen: Select the Screen option to indicate that a Screen displays after the Task assignee submits the Task's Screen selected from the Screen Associated drop-down menu described above. Screen is the default setting.
If the Anonymous option is selected from the Mode setting, the Enable Password Protect setting displays.
Select the Enable Password Protect setting to require a password to access the Web Entry. If the Enable Password Project setting is selected, the Password Protect setting displays below it.
From the Exclude Data setting, optionally specify any Request data from being included in the Web Entry Task so that it does not display in the Screen for that Task. Specify the Request variable name to exclude as indicated by the Screen control's Variable Name setting value.
Click theicon to add a Request variable from inclusion to the Request data for this Task. A setting displays to enter that Request variable name.
If necessary, click theicon to the right off an added Request variable to remove that Request data from those to exclude from the Web Entry Task.
The Embed Code setting displays the JavaScript that contains the Web Entry URL to embed into your Web server's or blog's HTML header. If necessary, click the Copy button below the Embed Code setting to copy the Web Entry URL so that it is available in your clipboard.
If this Form Task element's Web Entry uses a Conversational-type Screen to provide a chat-style interaction with the Request starter, optionally click the Options button below the Embed Code setting to configure how the chat box displays in the embedded container to which the Web Entry's JavaScript code is applied. When the Options button is clicked, the Embed Options screen displays.
Expand the Vocabularies panel if it is not presently expanded. The Assigned setting displays.
Click theicon to add a Vocabulary. The Assign Vocabulary option displays.
Click the Remove iconfrom the Vocabularies setting to remove a Vocabulary from assignment to this element.
Ensure that the Explorer panel is visible. If not, click the Add icon from the Objects bar to display the Explorer panel.
Click the Data Store object category.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Data Store element cannot be placed outside of the Pool element.
Ensure that the Data Store object category is pinned to the Objects bar. If not, pin it.
Click the location in the Process model to place this element. If a Pool element is in your Process model, the Data Store element cannot be placed outside of the Pool element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays.
Expand the Documentation panel if it is not presently expanded. The Description setting displays.
In the Description setting, edit the information to display when viewing documentation for this element and then press Enter. Alternatively, use the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor to stylize your text by clicking the More icon.
Undo changes: Click on theicon to undo the last action.
Redo changes: Click on theicon to redo the last undone action.
Insert/Edit Link: Click on theicon to convert the selected text into a hyperlink. Follow these steps to create a hyperlink:
Click on theicon. The Insert/Edit Link screen displays.
Insert/Edit Image: Click on the Insert/Edit Image iconto insert an image. Follow these guidelines:
Click on the Insert/Edit Image icon.
The Insert/Edit Image screen displays:
Toggle the Constrain Proportions iconto maintain the width-height ratio of the image to its original proportion.
Insert Page Break for PDF: Click on the Insert Page Break for PDF iconto insert a page break when a PDF document is created for this documentation if your browser supports this feature.
From the editor toolbar, select theicon.
From the editor toolbar, select theicon.
Change text color: Use the Text Color drop-down to change text color. Click on theicon. The color palette displays. Do one of the following:
Click theicon to select a custom color from the Color Picker.
Click theicon to reset the text to its default color.
From the editor toolbar, use theicon to left-align text.
From the editor toolbar, use theicon to center-align text.
From the editor toolbar, use theicon to right-align text.
From the editor toolbar, use theicon to justify text.
Insert a bullet list: Use theicon to format text as a bulleted list.
Insert a numbered list: Use theicon to format text as a numbered list.
Indent text: Click on theicon to increase text indenting.
Outdent text: Click on theicon to decrease text indenting.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting displays. This is a required setting.