Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Request participants can make decisions via email with the click of a button.
Use the Actions By Email connector in your Process models to automate emails to Request participants that allow them make decisions via email.
When the Actions By Email connector triggers during an in-progress Request, ProcessMaker Platform sends an email from the "no-reply@processmaker.net" email address to one email recipient so that this Request participant can make a decision as part of the Request. For example, this Request participant must make a decision to approve or deny a vacation request or for a purchase. The email recipient receives an email with buttons in the email to easily indicate the decision.
Email design is subject to email client limitations and may not fully support HTML5 or CSS3 specifications. Test your emails in your supported client applications.
While the Actions by Email connector can send the email to multiple email recipients, ProcessMaker Platform registers only the first response. The emails are sent using the Email Default settings, while the response is received using the Actions By Email settings.
After the email recipient clicks a button to indicate the decision, the email client creates an email reply to be delivered to the ProcessMaker Platform instance that used the Actions By Email connector. As indicated in the email reply, do not change anything below the automatically generated response because this response notifies the ProcessMaker Platform instance of the email recipient's decision for Request routing.
After the email recipient sends the reply email, ProcessMaker Platform receives the response and uses the indicated decision as part of the Request routing. For example, if you grant a leave request, the Request routes differently than if you deny that leave request.
The comment in the email reply above the indicated line is not preserved when the email reply is sent. This comment displays only for the benefit of the email recipient prior to sending the email reply.
The Actions By Email connector adds the Actions By Email connector below the BPMN 2.0 elements in the panel to the left of the Process Modeler canvas. See the following sections in this topic:
The recipient's email address and/or subject can be specified in one of the following ways when configuring the Actions By Email connector:
Plain text
A Variable Name setting value using mustache syntax, for example {{ email_recipient }}
and {{ email_address }}
, respectively
A Magic Variable value, specifically {{ _user.fullname }}
and {{ _user.email }}
, respectively
The Actions By Email connector can send the email to multiple recipients. These email recipients and their email addresses may be referenced from Request data or entered into connector settings.
When an Actions By Email connector triggers during an in-progress Request, ProcessMaker Platform automatically creates an asynchronous child Process: the Actions By Email connector sends the email (the child Process) while simultaneously the in-progress Request continues (the parent Process). In doing so, one of the following occurs:
An error occurs in the email delivery: While attempting to send the email, the Actions By Email connector receives an error. For example, your organization's email server or the email recipient's email server may be down. The child Process receives and sends the error to the parent Process. The child Process ends. Reference the child Process's error from the in-progress Request.
The Actions by Email connector sends the email: The email recipient receives the email while the in-progress Request continues (the parent Process). The child Process ends, but the email recipient may not have responded to the email. If the in-progress Request routes to an Exclusive Gateway element that requires the email recipient's response to evaluate routing, then the in-progress Request remains indefinitely active on the Exclusive Gateway element.
To ensure that Requests do not remain indefinitely active on an Exclusive Gateway element while the Request waits for the email recipient's response, design your Process model to use an Event-Based Gateway element preceding the Exclusive Gateway element that checks the following:
If an Intermediate Timer Event element triggers (after 72 hours, for example), the email recipient has not responded to the email. Thereafter, design in the Process model how to address this, such as sending a subsequent email using the Send Email connector.
If an Intermediate Message Catch Event element triggers instead of the Intermediate Timer Event element, the email recipient sent the response within the allotted time period.
Add an Actions By Email connector from one of the following locations in Process Modeler:
Object Panel: Located to the left of the Process Modeler canvas, the Object Panel contains various process model objects.
Object Bar: Located at the bottom of the Process Modeler canvas, the Object Bar contains pinned Process model objects, which are easy accessible.
Follow these steps to add an Actions By Email connector from the Object panel to the Process model:
Click the Actions By Email object from one of the following sections:
Pinned Objects: The Actions By Email object appears in the Pinned Objects section when it is pinned.
Click the location in the Process model to place this connector. Follow these guidelines when placing this connector:
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.
Follow these steps to add an Actions By Email connector from the Object bar to the Process model:
Click the Actions By Email object 's icon. This object's 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. Follow these guidelines when placing this connector:
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.
The Actions by Email connector has the following panels that contain settings:
Configuration panel
Loop Characteristics panel
Documentation panel
Follow these steps to configure an Actions By Email connector:
Select the Actions By Email connector from the Process model in which to configure its settings.
In the Name setting, edit the selected connector's name and then press Enter.
From the Email Server drop-down menu, select which email server that sends the email to the recipient(s). The Default Email Server option is the default. If additional email servers are configured from the Email Default Settings tab in Settings, then additional email server options display in the Email Server drop-down menu.
In the Email setting, enter the email address(es) to which the Actions By Email connector sends an email when this Actions By Email control triggers. 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
that the Request participant enters an email address, use mustache syntax {{EmailAddress}}
to use that Line Input control's value in the Email setting. Email addresses may be referenced from Request data or entered into the Email setting by using commas (,
) between email addresses. You may also use mustache syntax to reference Magic Variables.
From the Language drop-down, select one of the following options to specify in which supported natural language the email recipient receives the email:
English (en): The email is in English.
German (de): The email is in German.
Spanish (es): The email is in Spanish.
French (fr): The email is in French.
Use Variable: Use a Request variable to specify which supported language to send the email.
In the Subject setting, enter the subject of the email the Actions By Email connector sends. For example, enter the decision that the email recipient must make in this email.
From the Body setting, select one of the following options:
Text: From the Body drop-down menu, select the Text option to enter the email body text. The Email body setting displays. In the Email body setting, enter the email body text.
Screen: From the Body drop-down menu, select the Screen option to use a Screen to display the email body. The Email body setting displays. From the Email body drop-down menu, select the Display-type Screen to display the email body.
In the Key name setting, enter the name of the key that stores the Actions By Email connector response within the JSON data model of the Request.
Follow these steps to add an option:
In the Button Text setting, enter the button label displayed to the email.
In the Value setting, enter the internal data name for the option that only the Process Owner views at design time.
In the Button Style setting, select a button style:
Primary: Displays a button with a blue-colored background and white-colored text.
Secondary: Displays a button with a gray-colored background and white-colored text.
Success: Displays a button with a green-colored background and white-colored text.
Info: Displays a button with a teal-colored background and white-colored text.
Warning: Displays a button with a yellow-colored background and black-colored text.
Danger: Displays a button with a red-colored background with white-colored text.
Dark: Displays a button with a black-colored background with white-colored text.
Light: Displays a button with a white-colored background with black-colored text.
Click Add.
Email design is subject to email client limitations and may not fully support HTML5 or CSS3 specifications. Test your emails in your supported client applications.
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.
Describe the connector'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 connector 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.
Follow these steps to edit the description for a connector:
Select the connector 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.
Access both Collection records and third-party data sources from Process models, then make workflow routing decisions based on that data.
Data Connectors allow Process Designers too interact with a data source within a process. Use a Data Connector in your Process models in the following ways:
Access Collections: From your Process model, interact with any Collection in your ProcessMaker Platform instance, including viewing, creating, updating, and/or delete records in a selected Collection. By default, each Collection has a corresponding Data Connector when it is created. Incorporate Collection record data into your Process model so you can make business decisions using it. Likewise, automatically change records in a Collection during a Request when workflow routing conditions are met.
Access third-party data sources: Similarly to Collections, interact with third-party data sources such as Application Program Interfaces (APIs). Reference data from that API, then incorporate it into your Process's Request data. Incorporating data from external data sources helps you make business decisions from information outside of your ProcessMaker Platform instance.
Add a Data Connector from one of the following locations in Process Modeler:
Object Panel: Located to the left of the Process Modeler canvas, the Object Panel contains various process model objects.
Object Bar: Located at the bottom of the Process Modeler canvas, the Object Bar contains pinned Process model objects, which are easy accessible.
Follow these steps to add a Data Connector from the Object panel to the Process model:
Click the Data Connector object from one of the following sections:
Pinned Objects: The Data Connector object appears in the Pinned Objects section when it is pinned.
Click the location in the Process model to place this connector. Follow these guidelines when placing this connector:
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.
Follow these steps to add a Data Connector from the Object bar to the Process model:
Click the Data Connector object's icon. This object's 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. Follow these guidelines when placing this connector:
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.
The Data Connector has the following panels that contain settings:
Loop Characteristics panel
Callback panel
Error Handling panel
Documentation panel
The Data Connector has the following settings in the Data Connector panel:
A connector name is a human-readable reference for a Process model control. Process Modeler automatically assigns the name of a Process model connector with its connector type. However, a connector's name can be changed.
Follow these steps to edit the name for a Data Connector:
Select the Data Connector from the Process model in which to edit its name.
In the Name setting, edit the selected connector's name and then press Enter.
The Data Connector uses a Data Connector that is configured to interact with a data source, such as a Collection or a third-party Application Program Interface (API). A Data Connector must already exist before it can be selected for use in a Data Connector. Each Data Connector is already configured with which data source it interacts.
Collections automatically create a Data Connector when the Collection is created. Data Connectors created from a Collection by default have the same name as the Collection that it references.
Follow these steps to select the Data Connector the Data Connector uses:
Select the Data Connector from the Process model in which to specify the Data Connector to reference.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
From the Select a Data Connector drop-down menu, select which Data Connector the Data Connectoruses.
Ensure to select which of the Data Connector's Resources interacts with the data source to properly configure the Data Connector.
Each Data Connector contains at least one Resource. These Resources are configured from the Data Connector itself. A Resource is an action the Data Connector uses to interact with the data source. The Data Connector uses a Resource to interact with the data source. These Resources may interact with Collection records, Application Program Interfaces (APIs), or other data source types. After a Data Connector has been selected from the Select a Data Connector setting, select the Resource from that Data Connector the Data Connector uses to interact with the data source.
Data Connectors created from Collections use a default set of Resources. See Resources for Collections.
Follow these steps to select which Resource the Data Connector uses:
Select the Data Connector from the Process model in which to select the resource the Data Connector uses.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Data Connector panel if it is not presently expanded, and then locate the Select a Data Connector setting. Ensure that a Data Connector is selected from the Select a Data Connector setting. If not, see Select the Data Connector.
From the Select a Resource drop-down menu, select which Resource the Data Connector uses to interact with the data source.
Configure to which data properties the Data Connector sends to the data source, whether that be an Application Program Interface (API) or Collection to which the Data Connector is configured to interact.
Ensure that you have configured the following before configuring outbound properties, in this order:
Outbound data may be sent to each parameter, header, or body configured in the Data Connector once.
Follow these steps to configure outbound properties:
Select the Data Connector from the Process model in which to add outbound properties.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Expand the Data Connector panel if it is not presently expanded, and then locate the Outbound Configuration. Ensure that a Data Connector and a Resource are selected from the Select a Data Connector and Select a Resource settings, respectively. If not, see Select the Data Connector and Select the Resource, in that order.
From the Type drop-down menu, select from which type of data configured for the selected Resource in which to interact with its data:
Param: Select the Param option to select a parameter configured with the selected Resource. If no parameters are configured for the selected Resource, Not available displays.
Header: Select the Header option to select a header configured with the selected Resource. If no headers are configured for the selected Resource, Not available displays.
Body: Select the Body option to select the body configured for the selected Resource that is typically used in PUT and POST methods. If the selected Resource is not configured to include a body, Not available displays.
From the Property drop-down menu, select a property configured for the selected type from the selected resource. If no properties are configured for the selected type in that Resource, Not available displays.
In the Request Variable setting, enter using mustache syntax the Request variable name to use that variable's value when the Resource calls the data source. If the Request Variable setting value is not contained in mustache syntax, the Data Connector uses the literal string during its Resource call.
Click Save.
Each outbound configuration to a data source property displays in the Outbound Configuration setting. An icon to the left of each outbound configuration represents its property type:
P: The P icon represents an outbound configuration for a parameter property type.
H: The H icon represents an outbound configuration for a header property type.
B: The B icon represents an outbound configuration for a body property type.
Configure how data from the data source integrates with Request data.
Ensure that you have configured the following before configuring outbound properties, in this order:
The procedure to integrate the data source's data to the Request JSON data model is called response mapping: specifying into which Request variable to store the data source's data. The Data Connector may be configured with response mapping, whereby a specified source name in the body or header of the data source response's is mapped to store that value in a specified Request variable. By relying on the Data Connector's response mapping, the Process designer only needs to select the Request variable name as mapped in the Data Connector's response without knowing technical details for this mapping.
Each JSON object contains a key name that references the JSON object, and the value for that key. If the JSON object already exists in a Request's JSON data model, then the Data Connector overwrites the existing JSON object value with that from the data source. If the JSON object(s) to map the data source data does not exist, then the Data Connector adds the JSON data object(s) to that Request's JSON data model.
Follow these steps to specify the Request JSON data object(s) to which to map the data source's data:
Select the Data Connector from the Process model to map the data source's data to the Request JSON object(s).
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Source setting, enter the name of the source from which to store the response. If the source is from Request data, such as from a Collection, the source name is data
. data
is the name of the JSON object that stores all data for each Request. However, the Source setting corresponds with how the Data Connector maps the data response: by selecting a mapped Request variable from the Set to Request Variable setting below, its corresponding source name displays in the Source setting. Optionally, specify the source name as a Request variable using mustache syntax.
In the Set to Request Variable setting, enter the Request variable as configured in the Data Connector's response mapping in which to store the data source's response. Optionally, specify the source name as a Request variable using mustache syntax. After doing so, the Source setting displays the source's name configured for that response mapping.
Click Save.
Repeat Steps 4 through 6 for each Request variable to store the data source's response.
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.
‌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.
Configure how the Data Connector automatically calls back the data source by enabling the Wait for server callback setting with a callback. A callback automates receiving data from the data source, such as a third-party service, and then subsequently sending back data to that data source. The Data Connector monitors for data from the data source via a unique URL that may be stored in a Request variable. Likewise, the data that the Data Connector sends to the data source as a response may be stored in a Request variable. Configure the callback to use GET and/or POST methods to retrieve and/or send data, respectively.
In overview, a callback functions as follows:
A Data Connector interacts with a data source, such as the third-party service Stripe that automates payment services. For example, a Request participant has submitted information for a payment via a Task earlier in that Request.
The Request pauses while the Data Connector waits for the data source to respond. The connector monitors for that response. For example, Stripe responds that the submitted payment is accepted or rejected. The third-party service is the Data Connector's data source.
After the third-party service processes its data and responds to the Data Connector, the connector calls back that data source: the connector may get data or post data to that third-party service.
For example, consider a course enrollment process where each student selects courses for that semester and then must pay for tuition. After enrolling in courses, a Task presents the student with a final invoice and payment options. When the student submits payment, the Request invokes a payment service's Application Program Interface (API), such as Stripe, to verify the payment. Use a Data Connector callback to monitor when the payment service's API verifies the payment information entered by the student. The Request now waits for a response from the payment service's API. The API response returns to a Request variable which can be used to determine next steps in that Request. If the student entered correct payment information and payment is honored, then their course enrollment is confirmed; otherwise the student must re-enter their payment details.
Follow these steps to specify a Data connector's callback to the data source:
Select the Data Connector from the Process model in which to configure the server callback.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Enable the Wait for server callback option to configure callback settings.
In the Authentication drop-down menu, select one of the following authentication methods:
None: Select the None option if no authentication is required.
Follow these steps to enter basic authentication credentials:
In the Username setting, enter the username to authenticate with the data source.
In the Password setting, enter the password to authenticate with the data source.
Follow these guidelines to manage server URLs:
After entering a server URL, press Enter.
Follow these guidelines to set how to handle Data Connector runtime errors:
Set how many seconds to wait when an unexpected error occurs during runtime before displaying the error in that Data Connector, thereby causing that Request to be in Error status.
Set how many consecutive attempts to run the Data Connector before displaying a runtime error.
Requests are going to wait the configured number of seconds and consecutive runtime attempts for an unresponsive Data Connector before displaying the error.
Optionally, notify the Process Manager of the Data Connector runtime error via an in-platform or email notification.
Follow these steps to edit the Error Handling settings:
Select the Data Connector from the Process model in which to edit the Error Handling.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Timeout setting, configure how many seconds to wait for an unresponsive Data Connector 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 Data Connector default setting.
In the Retry Attempts setting, configure how many times to re-execute the Data Connector if the Data Connector 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 Data Connector 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 Data Connector default setting.
Enable the In-app Notification toggle to notify through the user interface to the Process Manager that there is a Data Connector runtime error.
Enable the Email Notification toggle to notify through an email to the Process Manager that there is a Data Connector execution error.
Describe the connector'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 connector 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.
Follow these steps to edit the description for a connector:
Select the connector 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.Panels to configure this connector 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.
A Process node represents a component of a Process model, whether that is a BPMN element or a connector. Process Modeler automatically assigns a unique value to each Process node added to a Process model. A Process 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 Connector:
Select the Data Connector 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 Data connector's identifier to a unique value from all nodes in the Process model and then press Enter.
Add ProcessMaker-designed connectors to your Process model that provide integration to third-party services.
A connector is an integration with a third-party service that ProcessMaker designed with easy-to-configure settings that any Process Designer can use in a Process. Connectors are not part of the BPMN 2.0 specification; connectors extend ProcessMaker Platform functionality outside of the BPMN 2.0 specification.
A connector functions similarly to a Process model element in Process Modeler: drag and place the connector into your Process model, and then configure it.
After the connector is configured and the Process is published, Requests for that Process use that configured connector. For example, if your Process model uses the Send Email connector, Requests for that Process can send email to specific email recipients during each Request's workflow using configuration settings you've specified.
Integrate Decision Tables into your business Processes.
Use Decision Task connectors to run Decision Tables in your Processes. Specify which Decision Table(s) to run, thereby evaluating their business rules, and then map how data routes between Request variables to and from Decision Table variables.
Decision Task connectors immediately evaluate the business rules within a specified Decision Table, thereby affecting Request workflow routing in real time with the current conditions and outcomes for all decisions in that Decision Table.
Add a Decision Task connector from one of the following locations in Process Modeler:
Object Panel: Located to the left of the Process Modeler canvas, the Object Panel contains various process model objects.
Object Bar: Located at the bottom of the Process Modeler canvas, the Object Bar contains pinned Process model objects, which are easy accessible.
Follow these steps to add a Decision Task connector from the Object panel to the Process model:
Click the Decision Task object from one of the following sections:
Pinned Objects: The Decision Task object appears in the Pinned Objects section when it is pinned.
Click the location in the Process model to place this connector. Follow these guidelines when placing this connector:
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.
Follow these steps to add a Decision Task connector from the Object bar to the Process model:
Click the Decision Task object's icon. This object's 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. Follow these guidelines when placing this connector:
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.
After a Decision Task connector element is added to a Process model and selected Decision Table(s) to run Business Rules, you may preview the first associated Decision Table, which allows you to interact with and verify the Decision Table content in the same Process Modeler.
Ensure to select a Decision Table for each Decision Task element in your Process model. If a Decision Table is not specified and the Decision Task previews, the following placeholder displays:
Follow these steps to preview the first associated Decision Table from a Decision Task Connector element:
Select the Decision Task connector element to preview the first associated Decision Table. Available options display above the selected element.
In the Preview window, you can do the following:
Click another Task or connector element to change the asset in the same preview window.
The Decision Task connector has the following panels that contain settings:
Configuration panel
Loop Activity panel
Advanced panel
A connector name is a human-readable reference for a Process model control. Process Modeler automatically assigns the name of a Process model connector with its connector type. However, a connector's name can be changed.
Follow these steps to edit the name for a Decision Task connector:
Select the Decision Task connector from the Process model in which to edit its name.
In the Name setting, edit the selected connector's name and then press Enter.
Use the Loop Characteristics panel settings to specify how to perform multiple instances of this connector. The following loop modes are available for this connector:
No Loop Mode: Select the No Loop Mode option to perform this connector's function only once.
Loop: Select the Loop option to sequentially repeat this connector's function multiple times until an exit condition is True
. This is useful when a function 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 connector's function is repeated until the exit condition is True
or the maximum iterations limit is reached.
At any given time, only one instance of the connector 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 function 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 connector'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 connector 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 function that each contains data from its respective array index.
All instances begin simultaneously when this connector triggers; however, they perform their function independently of each other.
The function 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 connector's function multiple times sequentially a fixed number of times or until an exit condition is True
. This is useful when sequentially repeating a function multiple times but with a different set of data each time. This loop mode has the following characteristics:
Instances of the function 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 function that each contains data from its respect array index.
At any given time, only one instance of the function 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 function 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 connector:‌
Select the connector 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 function is performed only once.
From the Loop Mode setting, select one of the following options to perform this connector's function 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.
Select which Decision Table(s) to run from which to evaluate business rules. Optionally, configure a Friendly Enough Expression Language (FEEL) expression that evaluates if the Decision Table should run prior to evaluating any decisions in it.
Follow these steps to select which Decision Table(s) to run from which to evaluate business rules:
Select the connector from the Process model in which to specify the Decision Table(s) to run.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Do one of the following:
From the Select a Table drop-down menu, select which Decision Table to run its business rules.
Click the Create a new decision table link. A new browser window opens to create a new Decision Table. After creating the Decision Table, the Select a Table drop-down menu automatically populates with the created Decision Table. Otherwise, be sure to select the new Decision Table in the Select a Table drop-down menu.
Optionally, click the Open table link to view and/or edit your selected Decision Table. Note that your user account must have appropriate Decision Table category permissions or be a Project member in which this Decision Table is an asset.
Optionally, configure a Friendly Enough Expression Language (FEEL) expression that evaluates if the Decision Table should run prior to evaluating any decisions in it. To do so, do the following:
Enable the Execute Conditionally setting.
Enter the expression that must evaluate as TRUE
for this Decision Table to evaluate its business rules.
Repeat step 3 through 7 for each Decision Table that this Decision Task connector runs for its business rules.
If no Decision Tables exist, the Select a Table drop-down menu contains no options.
After selecting which Decision Table to run, optionally select a different Decision Table to run or conditions in which it runs.
Follow these steps to edit settings for an added Decision Table to run:
Select the connector from the Process model in which to edit settings for which Decision Table(s) to run.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Optionally, from the Select a Table drop-down menu, select a different Decision Table to run its business rules.
Optionally, click the Open table link to view and/or edit your selected Decision Table. Note that your user account must have appropriate Decision Table permissions to view and/or edit the selected Decision Table.
Optionally, configure a Friendly Enough Expression Language (FEEL) expression that evaluates if the Decision Table should run prior to evaluating any decisions in it. To do so, do the following:
Enable the Execute Conditionally setting.
Enter the expression that must evaluate as TRUE
for this Decision Table to evaluate its business rules.
Optionally, repeat steps 4 through 7 for each Decision Table's settings to edit.
Follow these steps to delete a Decision Table from running to evaluate its business rules:
Select the connector from the Process model in which to delete a Decision Table from evaluating its business rules.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
Click Delete.
After selecting which Decision Table(s) to evaluate its business rules, map how decision variables in the selected Decision Table(s) map to Request variables. Mapping involves two procedures:
Follow these steps to map outbound data from the Request to the Decision Table:
Select the connector from the Process model in which to map variable data routing.
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 that sends data to the decision input variable of the Decision Table.
In the Table Input Variable setting, enter the decision input variable's name that receives the Request variable data. Ensure to enter the decision input variable's name, not its label.
Optionally do one of the following to edit or delete a mapped outbound data variable pairing:
Repeat steps 3 through 7 as necessary for each Request variable to map to a Decision Table.
Follow these steps to map Decision Table output variable data to Request data after evaluating business rules:
Select the connector from the Process model in which to map variable data routing.
Ensure that the Configuration panel displays. If not, show it. Panels to configure this element display.
In the Table Output Variable setting, enter the name of the output decision variable from the Decision Table that sends data to the Request variable. Ensure to enter the decision output variable's name, not its label.
In the Set Request Variable setting, enter the Request variable's name that receives the output decision variable data.
Optionally do one of the following to edit or delete a mapped outbound data variable pairing:
Repeat steps 3 through 7 as necessary for each Request variable to map to a Decision Table.
A Process node represents a component of a Process model, whether that is a BPMN element or a connector. Process Modeler automatically assigns a unique value to each Process node added to a Process model. A Process 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 Decision Task connector:
Select the Decision Task connector 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 Decision Task connector's identifier to a unique value from all nodes in the Process model and then press Enter.
Customize and send documents for signatures by fully integrating DocuSign’s eSignature functionality into your Processes.
Add a DocuSign connector from one of the following locations in Process Modeler:
Object Panel: Located to the left of the Process Modeler canvas, the Object Panel contains various process model objects.
Follow these steps to add a DocuSign connector from the Object panel to the Process model:
Click the DocuSign object from one of the following sections:
Pinned Objects: The DocuSign object appears in the Pinned Objects section when it is pinned.
Click the location in the Process model to place this connector. Follow these guidelines when placing this connector:
Follow these steps to add a DocuSign connector from the Object bar to the Process model:
Click the DocuSign object's icon. This object's 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. Follow these guidelines when placing this connector:
The DocuSign connector has the following panels that contain settings:
DocuSign Template panel
Document for Signature panel
Response Options panel
Loop Characteristics panel
Documentation panel
Advanced panel
A connector name is a human-readable reference for a Process model control. Process Modeler automatically assigns the name of a Process model connector with its connector type. However, a connector's name can be changed.
Follow these steps to edit the name for a DocuSign connector:
Select the DocuSign connector from the Process model in which to edit its name.
Expand the DocuSign Template panel if it is not presently expanded. The Name setting displays.
In the Name setting, edit the selected connector's name and then press Enter.
Ensure the following before configuring the settings described in this section:
Your organization uses a DocuSign eSignature account.
You created a template for the document in which this DocuSign connector is to solicit signatures. This template must be configured with at least one role.
You created a DocuSign app that uses this DocuSign template.
Your ProcessMaker Platform settings for DocuSign are configured with the DocuSign app integration and secret keys that use this DocuSign template. Your DocuSign settings must also be configured with the DocuSign server and authorized access to that server to authenticate your DocuSign app's integration and secret keys.
Contact your ProcessMaker Administrator for assistance if necessary.
Follow these steps to select a Template ID and recipient role(s):
Select the DocuSign connector from the Process model in which to edit its name.
Expand the Document for Signature panel. Settings for this panel display.
Placeholder recipient roles created in DocuSign must be configured in Process Designer.
From the Select a Type drop-down menu for each role, select one of the following options:
User: Select the User option to email the document to a selected user. The Send to User setting displays. From the Send to User setting, select which user serves as that role. The email address associated with this user account is used to send the document for eSignature. This is a required setting when the User option is selected.
Requester: Select Requester to email the document to the Request starter.
User ID: Select User ID to email the document to a user based on a Variable Name value as entered into a Screen during a previous Task in that Request. For example, if a Line Input control in a Screen has the Variable Name setting value of UserId
that contains a user's ID, then use that value to thereby send the document for eSignature. When this option is selected, the Send to User ID setting displays. The email address associated with this user account is used to send the document for eSignature. This is a required setting when the User ID option is selected.
Email Address: Select Email Address to email the document to a non-ProcessMaker Platform user. When this option is selected, Recipient Email and Recipient Name settings display. Enter the email address and name for the intended recipient, respectively. The Recipient Email and Recipient Name settings are required when the Email Address option is selected.
Configure whether to pause a Request while awaiting user signatures and how to save the response from DocuSign.
Follow these steps to configure the response from DocuSign:
Select the DocuSign connector from the Process model in which to edit its response.
Expand the Response Options panel. Settings for this panel display.
From the Wait for Signature setting, select one of these options:
Yes: Select Yes to wait for the user to sign this document. When this option is selected, the Request pauses and does not resume until the document is signed.
No: Select No to continue the Request irrespective of whether the user signs this document. This is the default option.
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.
Describe the connector'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 connector is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
Follow these steps to edit the description for a connector:
Select the connector 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.
All identifier values for all nodes in the Process model must be unique.
Follow these steps to edit the identifier value for a connector:
Select the connector 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 connector's identifier to a unique value from all nodes in the Process model and then press Enter.
Automatically generate PDFs of Display-type Screens in a Process.
Test the PDF Generator connector output prior to production use. The third-party PDF library that this connector uses is limited in scope. Ensure that the output presents as you intend.
Add a PDF Generator connector from one of the following locations in Process Modeler:
Object Panel: Located to the left of the Process Modeler canvas, the Object Panel contains various process model objects.
Follow these steps to add a PDF Generator connector from the Object panel to the Process model:
Click the PDF Generator object from one of the following sections:
Pinned Objects: The PDF Generator object appears in the Pinned Objects section when it is pinned.
Click the location in the Process model to place this connector. Follow these guidelines when placing this connector:
Follow these steps to add a PDF Generator connector from the Object bar to the Process model:
Click the PDF Generator object's icon. This object's 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. Follow these guidelines when placing this connector:
The PDF Generator connector has the following panels that contain settings:
Configuration panel
Loop Characteristics panel
Documentation panel
Follow these steps to edit a PDF Generator connector's name:
Select the PDF Generator connector from the Process model in which to configure its settings.
In the Name setting, edit the selected connector's name and then press Enter.
If this setting does not have a value, then by default the PDF Generator connector uses the Screen's name as the PDF file name.
Follow these steps to enter the file name for the PDF that a PDF Generator connector generates:
Select the PDF Generator connector from the Process model in which to configure its settings.
In the PDF File Name setting enter the text for the file name or use mustache syntax to reference a Request variable for the file name. Use characters that Windows operating systems support.
Select the PDF Generator connector from the Process model in which to configure its settings.
Do one of the following:
From the Select a Display Screen drop-down menu, select which Screen to generate a PDF. Only Display-type Screens display from this setting.
Test the PDF Generator connector output prior to production use. The third-party PDF library that this connector uses is limited in scope. Ensure that the output presents as you intend.
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.
Describe the connector'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 connector is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
Follow these steps to edit the description for a connector:
Select the connector 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.
Automatically send emails during Requests for a Process.
When you add the Send Email connector to your Process model and then reference a Screen for email body content, ProcessMaker Platform can send emails during Requests. The Send Email connector can email a specified email address when that Send Email connector triggers in a Request's workflow.
The Send Email connector adds the following components:
Process Modeler: The Send Email connector adds the Send Email connector below the BPMN 2.0 elements in the panel to the left of the Process Modeler canvas. See the following sections in this topic:
The email recipient's name and email address can be specified in one of the following ways when configuring the Send Email connector:
Plain text
A Variable Name setting value using mustache syntax, for example {{ email_recipient }}
and {{ email_address }}
, respectively
Add a Send Email connector from one of the following locations in Process Modeler:
Object Panel: Located to the left of the Process Modeler canvas, the Object Panel contains various process model objects.
Follow these steps to add a Send Email connector from the Object panel to the Process model:
Click the Send Email object from one of the following sections:
Pinned Objects: The Send Email object appears in the Pinned Objects section when it is pinned.
Click the location in the Process model to place this connector. Follow these guidelines when placing this connector:
Follow these steps to add a Send Email connector from the Object bar to the Process model:
Click the Send Email object's icon. This object's 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. Follow these guidelines when placing this connector:
Ensure to enter email content for each Send Email element in your Process model. If email content is not specified and the Send Email previews, the following placeholder displays:
Follow these steps to preview the associated Email Content from a Send Email Connector element:
Select the Send Email connector element to preview the associated email content. Available options display above the selected element.
In the Preview window, you can do the following:
Click another Task or connector element to change the asset in the same preview window.
The Send Email connector has the following panels that contain settings:
Configuration panel
Loop Characteristics panel
Documentation panel
Follow these steps to configure a Send Email connector:
Select the Send Email connector from the Process model in which to configure its settings.
In the Name setting, edit the connector's name to display in the Process model and then press Enter.
Follow these guidelines to specify to whom to send the email:
Determine which of the following this email recipient is:
Primary email recipient: If this is a primary email recipient, then configure the To settings below.
Carbon copy recipient: To send a carbon copy of this email to a recipient, then configure the Cc settings below.
Blind carbon copy recipient: To send a blind carbon copy of this email to a recipient, then configure the Bcc settings below.
From the Recipient Type setting, select from which recipient type to determine this email recipient. Select from these options:
Users and Groups: Send this email to user(s) or group(s). When this option is selected, the Users and Groups setting displays.
Choose from one of the following options below to select the recipient(s):
Users: Select a user(s) from the available list to send the email.
Groups: Select a group(s) from the available list to send the email.
Request Starter: Send this email to the user who started this Request.
Participants: Send this email to all users participating in this 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
.
Repeat sub-steps 1 through 5 above for each email recipient type to receive this email.
From the Email Server drop-down menu, select which email server that sends the email to the recipient(s). The Default Email Server option is the default. If additional email servers are configured from the Email Default Settings tab in Settings, then additional email server options display in the Email Server drop-down menu.
In the Subject setting, enter the subject of the email the Send Email connector sends.
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, enter the text that displays as the email body.
Display Screen:
Do one of the following:
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.
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.
Follow these guidelines:
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 9 and 10 to add additional files.
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.
Describe the connector'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 connector is configured. Edit information by using the What-You-See-Is-What-You-Get (WYSIWYG) rich text editor.
Follow these steps to edit the description for a connector:
Select the connector 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 Send Email Connector:
Select the Send Email Connector 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 Send Email Connector's identifier to a unique value from all nodes in the Process model and then press Enter.
Ensure that the Object panel is visible. If not, click the Add icon from the Object bar at the bottom.
Object Category: The Actions By Email object appears in the Object Category section when it is not pinned.
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Ensure that the Actions By Email object is pinned to the Object bar. If not, pin it.
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Ensure that the Configuration panel displays. If not, show it. The Actions By Email configuration settings display.
In the Options setting, enter the list of options available to the email recipient when making the decision. The options configured here display below the body of the email. Add options in the order they are to display from top to bottom in the email.
Click the plus buttonfrom the same line where is the Options label. The Add Option screen displays.
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 connector 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 Object panel is visible. If not, click the Add icon from the Object bar at the bottom.
Object Category: The Data Connector object appears in the Object Category section when it is not pinned.
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Ensure that the Data Connector object is pinned to the Object bar. If not, pin it.
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays.
Expand the Data Connector panel if it is not presently expanded, and then locate the Select a Data Connector setting.
Locate the Select a Resource setting.
Locate the Outbound Configuration setting.
Locate and click theicon. The Add Option screen displays.
Expand the Data Connector panel if it is not presently expanded. The Response Mapping setting displays.
Click theicon to add a JSON object to which to map data from the data source. The Source and Set to Request Variable settings display to add the JSON source name and its variable, respectively, for the JSON object.
Click the Delete iconto delete a mapped response from the Response Mapping setting.
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 Callback panel if it is not presently expanded. The Wait for server callback setting displays, which is disabled by default.
In the Variable Name for Callback URL setting, enter the URL that the data source calls to trigger a callback to the Data Connector. This URL may be stored in a Request variable that must be encapsulated using mustache syntax.
In the Response Variable Name setting, enter the Request variable name within mustache syntax that stores the response from the data source. If the response is JSON, the Request variable stores the response as a JSON object. Otherwise, the Request variable stores the response as text.
In the Accepted methods setting, toggle the GET and/or POST methods as the callback to retrieve and/or send data, respectively.
Basic Authentication: Select the Basic Authentication option to configure basic authentication. When selected, the Username and Password settings display.
In the Allow Access From setting, enter the server URLs from where the Data Connector accepts callbacks. If a server URL is not included in the Allow Access From setting, then the Data Connector does not accept the response.
Click the Deleteicon to delete an added server URL.
Click the Addicon to add an additional server URL.
Expand the Error Handling panel if it is not presently expanded. The Timeout 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 connector 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 Object panel is visible. If not, click the Add icon from the Object bar at the bottom.
Object Category: The Decision Task object appears in the Object Category section when it is not pinned.
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Ensure that the Decision Task object is pinned to the Object bar. If not, pin it.
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Click the Preview icon . A preview window displays on the right-side of the Process Modeler.
Click the icon to open the Decision Table Editor to edit the Decision Table.
Click the icon to close the preview window.
Ensure that the Configuration panel displays. If not, show it. The Name setting displays.
An element configured in this mode shows the Loop icon in Process Modeler.
A connector configured in this mode shows the Multi-instance (Parallel) icon in Process Modeler.
A connector configured in this mode shows the Multi-instance (Sequential) iconin Process Modeler.
Expand the Decision Tables panel. The Tables to run setting displays.
Click the icon to expand the Tables to run setting. The Add Decision Table setting displays.
Click Save. The selected Decision Table displays in the Tables to run setting. If no conditions are specified to run this Decision Table, Always displays below the Decision Table name. Otherwise, the conditional expression displays.
Expand the Decision Tables panel. The Tables to run setting displays the selected Decision Tables to run.
Click the icon for the Decision Table in which to change its settings. The Edit Decision Table setting displays with the currently configured settings to run that Decision Table.
Click Save. The selected Decision Table displays in the Tables to run setting. If no conditions are specified to run this Decision Table, Always displays below the Decision Table name. Otherwise, the conditional expression displays.
Expand the Decision Tables panel. The Tables to run setting displays the selected Decision Tables to run.
Click the icon for the Decision Table in which to delete from the connector. A confirmation message displays.
Expand the Variable Mapping panel. The Outbound Data setting displays.
Click the icon to expand the Outbound Data setting. The Map to Column setting displays.
Click Save. The mapped variables display in the Outbound Data setting.
Edit a mapped outbound data variable pairing: Click the icon for the mapped variable pairing in which to change its settings.
Delete a mapped outbound data variable pairing: Click the icon for the mapped variable pairing in which to delete. A confirmation message displays. Click Confirm to delete the mapped variable pairing.
Expand the Variable Mapping panel if it is not already expanded. The Outbound Data and Response Mapping settings display.
From the Response Mapping setting, click the icon to expand the Outbound Data setting. The Configured Returned Data setting displays.
Click Save. The mapped variables display in the Response Mapping setting.
Edit a mapped variable response pairing: Click the icon for the mapped variable pairing in which to change its settings.
Delete a mapped variable variable pairing: Click the icon for the mapped variable pairing in which to delete. A confirmation message displays. Click Confirm to delete the mapped variable pairing.
provides a service to digitally sign legally-binding documents including contracts, account openings, and invoices. You require a DocuSign eSignature account, and its accompanying token, to use the DocuSign connector in your Process models.
See the how to get a DocuSign eSignature app integration and secret key with which to configure ProcessMaker Platform to use a DocuSign eSignature template, and then configure a DocuSign connector.
See the permissions or ask your Administrator for assistance.
Object Bar: Located at the bottom of the Process Modeler canvas, the Object Bar contains Process model objects, which are easy accessible.
Ensure that the Object panel is visible. If not, click the Add icon from the Object bar at the bottom.
Object Category: The DocuSign object appears in the Object Category section when it is not pinned.
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See .
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Ensure that the DocuSign object is pinned to the Object bar. If not, it.
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See .
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
element
element
element
element
element
.
.
.
.
.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
Select a DocuSign Template ID referencing the document for which an eSignature is required and select recipient roles for users to sign the document. For more information on how to create a DocuSign template and create recipient roles, refer to .
See this .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
From the Template ID setting, select the DocuSign template that references the document to send for eSignature. The template list populates from your DocuSign server specified in the . If you do not see your templates here, review the DocuSign eSignature templates in your DocuSign account. Note that you may need to ask your Administrator for assistance.
After a DocuSign template is selected, recipient roles populate from DocuSign. For guidance on how to define recipient roles, see.
Click the settingsicon to view or edit a Role. Named recipient roles created in DocuSign display with predefined values which cannot be edited in Process Designer.
Process Manager: Select Process Manager to email the document to the owner of the Process. The Process Manager understands the Process design and workflow dynamics to troubleshoot Request routing incidents. .
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
In the Output Variable setting, enter the in which to save the response from DocuSign.
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.
A Process's entered documentation displays by selecting the .
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 connector 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.
A Process node represents a component of a Process model, whether that is a BPMN element or a . Process Modeler automatically assigns a unique value to each Process node added to a Process model. A Process 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.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
The PDF Generator can automatically generate PDFs of Display-type during Requests. Use the PDF Generator connector in your Process models when you want to provide a printable copy of a Display-type Screen, such as for Request summaries or purchase order receipts.
When the PDF Generator connector successfully generates the PDF during an in-progress Request, the PDF output can be downloaded from the Files tab in its Request summary. The PDF Generator by default names the PDF output the same as the Screen from which the PDF was generated unless the name is configured via text or by referencing a Request variable using . If the PDF Generator successfully generates the PDF, the PDF output remains available from that Request's summary regardless of that Request's status.
See the permissions or ask your Administrator for assistance.
Object Bar: Located at the bottom of the Process Modeler canvas, the Object Bar contains Process model objects, which are easy accessible.
Ensure that the Object panel is visible. If not, click the Add icon from the Object bar at the bottom.
Object Category: The PDF Generator object appears in the Object Category section when it is not pinned.
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See .
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Ensure that the PDF Generator object is pinned to the Object bar. If not, it.
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See .
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
element
element
element
element
element
.
.
.
.
.
.
Ensure that the Configuration panel displays. If not, . The Name setting displays. This is a required setting.
Enter the file name for the PDF that a PDF Generator connector generates. Optionally use to reference a Request variable as the PDF's file name. Using a Request variable to determine the PDF file name allows one PDF Generator connector to generate multiple iterations of a Display-type in a loop without each PDF named identically.
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 PDF File Name setting.
Follow these steps to select from which Display-type to generate a PDF:
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 Select a Display Screen setting.
Click the Create a new screen link. A new browser window opens to . After creating the Screen, the Select a Display Screen drop-down menu automatically populates with the created Screen. Otherwise, be sure to select the new Screen in the Select a Display Screen 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.
Ensure that the Configuration panel displays. If not, . Panels to configure this element display.
A Process's entered documentation displays by selecting the .
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 connector 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.
Screens Builder: The Send Email connector adds a new Screen type called Email. Select the Email Screen type when . See .
A value, specifically {{ _user.fullname }}
and {{ _user.email }}
, respectively
See the permissions or ask your Administrator for assistance.
Object Bar: Located at the bottom of the Process Modeler canvas, the Object Bar contains Process model objects, which are easy accessible.
Ensure that the Object panel is visible. If not, click the Add icon from the Object bar at the bottom.
Object Category: The Send Email object appears in the Object Category section when it is not pinned.
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See .
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Ensure that the Send Email object is pinned to the Object bar. If not, it.
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See .
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
element
element
element
element
element
.
.
.
.
.
After a Send Email connector element is and , you may preview the Email content, which allows you to interact with and verify the Email content in the same Process Modeler.
Click the Preview icon . A preview window displays on the right-side of the Process Modeler.
Click the icon to open the to edit the associated Email-type Screen.
Click the icon to close the preview window.
.
Your email provider may enforce a limit on the number of the email recipients allowed for each message. For example, limits to 100 recipients.
Ensure that the Configuration panel displays. If not, . Settings to configure the Send Email connector display.
Click the icon beside the type of email recipient to send this email. The Recipient Type setting displays.
To configure a different user or group currently selected, clickthe icon.
To remove an email recipient that is currently added, click theicon.
User ID: Send this email to a user based on the value of a . 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.
Alternatively, enter a Request variable in that contains a comma delimited string of multiple email addresses.
Process Manager: Send this email to the Process Manager assigned in the .
Optionally, click theicon for a configured email recipient, and then place that recipient into a different email recipient type. For example, move a configured recipient from the To setting and place that user into the Bcc setting.
From the Body setting, ensure that the Plain Text option is selected.
Select the Display Screen option to select an Email-type from which to display its content as the email body. Follow these steps:
From the Body setting, ensure that the Display Screen option is selected.
Click the Create a new screen link. A new browser window opens to . After creating the Screen, the drop-down menu automatically populates with the created Screen. Otherwise, be sure to select the new Screen in the drop-down menu below the Display Screen option.
Optionally, click the Open Screen link to view and/or edit your selected Screen. Note that your user account must have appropriate permissions to view and/or edit the selected Screen.
Optionally, click the +File button to specify the files to attach to this email notification. The Attach File settings displays. This is a required setting.
In the URL setting, enter the URL referencing an attached file to be accessed from a Web address. This is a required setting.
Click Save. The URL referencing the file displays.
In the Request Variable Name setting, enter a Request variable name without the . This variable must already be linked to a 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.
Request Array: Select the Request Array option to attach multiple files. The Request Array Variable Name and Variable in Array settings display.
In the Request Array Variable Name setting, enter an array-type Request variable. This variable must already be linked to aoption enabled in the same Request. When the Request is in-progress, any files uploaded using this File Upload control are attached to this email.
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.
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.
A Process's entered documentation displays by selecting the .
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 connector 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.
Send automatic notifications to Slack channels during Requests.
When you add the Slack Notification connector to your Process model and then select to which Slack channel to send a notification, ProcessMaker Platform can automatically send notifications via Slack during Requests.
Before using the Slack Notification connector in your Process models, your ProcessMaker Platform instance must be granted access to your Slack workspace by building a Slack App. Ask your Slack administrator to help you with the following:
Otherwise, when configuring the Slack Notification connector, the following ProcessMaker Platform error displays: Request failed with status code 404.
Add a Slack Notification connector from one of the following locations in Process Modeler:
Object Panel: Located to the left of the Process Modeler canvas, the Object Panel contains various process model objects.
Object Bar: Located at the bottom of the Process Modeler canvas, the Object Bar contains pinned Process model objects, which are easy accessible.
Follow these steps to add a Slack Notification connector from the Object panel to the Process model:
Click the Slack Notification object from one of the following sections:
Pinned Objects: The Slack Notification object appears in the Pinned Objects section when it is pinned.
Click the location in the Process model to place this connector. Follow these guidelines when placing this connector:
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.
Follow these steps to add a Slack Notification connector from the Object bar to the Process model:
Click the Slack Notification object's icon. This object's 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. Follow these guidelines when placing this connector:
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.
The Slack Notification connector has the following panels that contain settings:
Loop Characteristics panel
Documentation panel
The Slack Notification connector has the following settings in the Configuration panel:
A connector name is a human-readable reference for a Process model control. Process Modeler automatically assigns the name of a Process model connector with its connector type. However, a connector's name can be changed.
Follow these steps to edit the name for a Data Connector connector:
Select the Slack Notification connector from the Process model in which to edit its name.
In the Name setting, edit the selected connector's name and then press Enter.
Select to which Slack channel to send the notification. Slack channels are only available for the Slack workspace that your ProcessMaker instance is granted access.
Follow these steps to select to which Slack channel to send the notification:
Select the Slack Notification connector 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.
From the Select a Slack Channel drop-down menu, select the Slack channel to send the notification.
Follow these steps to enter the Slack notification message to send:
Select the Slack Notification connector 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 Input Your Message setting, enter the notification message and then press Enter.
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.
Describe the connector'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 connector 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.
Follow these steps to edit the description for a connector:
Select the connector 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.
Integrate ProcessMaker IDP into your business Processes.
IDP connector integrates ProcessMaker IDP into ProcessMaker Platform. ProcessMaker IDP is ProcessMaker's intelligent document processing (IDP) solution. Remember before working correctly with IDP Connectors, your administrator must configure IDP Settings.
Add an IDP connector from one of the following locations in Process Modeler:
Object Panel: Located to the left of the Process Modeler canvas, the Object Panel contains various process model objects.
Object Bar: Located at the bottom of the Process Modeler canvas, the Object Bar contains pinned Process model objects, which are easy accessible.
Follow these steps to add an IDP connector from the Object panel to the Process model:
Click the IDP object from one of the following sections:
Pinned Objects: The IDP object appears in the Pinned Objects section when it is pinned.
Click the location in the Process model to place this connector. Follow these guidelines when placing this connector:
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.
Follow these steps to add an IDP connector from the Object bar to the Process model:
Click the IDP object's icon. This object's 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. Follow these guidelines when placing this connector:
Optionally place this connector between two existing Process model objects already connected with a Sequence Flow element. See Place an Object Between Two Process Model Objects Already Connected with a Sequence Flow Element.
The IDP connector has the following panels that contain settings:
Loop Activity panel
Advanced panel
A connector name is a human-readable reference for a Process model control. Process Modeler automatically assigns the name of a Process model connector with its connector type. However, a connector's name can be changed.
Follow these steps to edit the name for an IDP connector:
Select the IDP connector from the Process model.
During a Request, an IDP connector references a Request variable that stores the documents for processing. This Request variable may be linked to a File Upload control, where the documents were uploaded during a Task.
Follow these steps to enter the name of the Request variable that stores the documents to be processed by this IDP connector:
In the Variable Name setting, enter the Request variable name that stores the documents for processing without using mustache syntax, then press Enter.
Select or enter the document type the IDP connector uses to process the documents. This setting does not refer to a file type, such as PDF
or DOCX
. Instead, this setting refers to the DOCUMENT_TYPE
domain in ProcessMaker IDP that has been previously trained to process documents in your Dossier. Note that this setting requires the value inDOCUMENT_TYPE
Domain's Name setting, not its Pretty Name setting value.
Follow these steps to select a document type:
Do one of the following:
Select the Use Request Variable option, and enter a Request variable that contains a reference to the document type. Reference this Request variable without using mustache syntax.
Ensure that the Use Request Variable setting is not selected, then choose a document type from the drop-down list. The name of the document type must already exist in ProcessMaker IDP. This setting does not create a new file type. For more information, see IDP Settings.
Select the folder where ProcessMaker IDP should store the processed documents. Follow these steps to configure a destination folder:
Do one of the following:
Select the Use Request Variable option, and enter a Request variable that contains a reference to the destination folder in IDP where to upload the file. Otherwise, if the folder does not exist, it creates a new one in the IDP server. Reference this Request variable without using mustache syntax.
Ensure that the Use Request Variable setting is not selected, then choose a destination folder from the drop-down list. These folders already exist in ProcessMaker IDP and are configured in the destination folder settings for IDP.
Use the Loop Characteristics panel settings to specify how to perform multiple instances of this connector. The following loop modes are available for this connector:
No Loop Mode: Select the No Loop Mode option to perform this connector's function only once.
Loop: Select the Loop option to sequentially repeat this connector's function multiple times until an exit condition is True
. This is useful when a function 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 connector's function is repeated until the exit condition is True
or the maximum iterations limit is reached.
At any given time, only one instance of the connector 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 function does not complete, workflow pauses.
All active instances are terminated if an interrupting boundary-type event element triggers.
ProcessMaker IDP does not allow multiple documents of the same name in the one folder. Therefore, an IDP connector cannot send more than one copy of a document to a folder while in a loop mode. To address this issue, use a different IDP connector to process the same document to a different ProcessMaker IDP folder.
Multi-instance (Parallel): Select the Multi-instance (Parallel) option to perform this connector'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 connector 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 function that each contains data from its respective array index.
All instances begin simultaneously when this connector triggers; however, they perform their function independently of each other.
The function 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 connector's function multiple times sequentially a fixed number of times or until an exit condition is True
. This is useful when sequentially repeating a function multiple times but with a different set of data each time. This loop mode has the following characteristics:
Instances of the function 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 function that each contains data from its respect array index.
At any given time, only one instance of the function 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 function 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 connector:‌
Select the connector from the Process model in which to specify multiple instance characteristics. 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 function is performed only once.
From the Loop Mode setting, select one of the following options to perform this connector's function 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.
A Process node represents a component of a Process model, whether that is a BPMN element or a connector. Process Modeler automatically assigns a unique value to each Process node added to a Process model. A Process 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 IDP connector:
Select the IDP connector 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 IDP connector's identifier to a unique value from all nodes in the Process model and then press Enter.
Ensure that the Object panel is visible. If not, click the Add icon from the Object bar at the bottom.
Object Category: The Slack Notification object appears in the Object Category section when it is not pinned.
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Ensure that the Slack Notification object is pinned to the Object bar. If not, pin it.
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool 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 Select a Slack Channel setting.
Expand the Configuration panel if it is not presently expanded, and then locate the Input Your Message setting.
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 connector 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 Object panel is visible. If not, click the Add icon from the Object bar at the bottom.
Object Category: The IDP object appears in the Object Category section when it is not pinned.
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Ensure that the IDP object is pinned to the Object bar. If not, pin it.
If a Pool element is in your Process model, the connector cannot be placed outside of the Pool element.
Click the Show Configuration button in the upper right of the Process Modeler canvas to view the Configuration panel.
In the Name setting, edit the selected connector's name and then press Enter.
Expand the Configuration panel if it is not presently expanded, and then locate the Variable Name setting.
Click the initials of your user account in the lower-left in ProcessMaker IDP, and then select the Go to ProcessMaker IDP Admin option.
Click the Domains option from the left navigation pane.
Expand the Configuration panel if it is not presently expanded, and then locate the Select Document Type setting.
Expand the Configuration panel if it is not presently expanded, and then locate the Select Destination setting.
An element configured in this mode shows the Loop icon in Process Modeler.
A connector configured in this mode shows the Multi-instance (Parallel) icon in Process Modeler.
A connector configured in this mode shows the Multi-instance (Sequential) iconin Process Modeler.