Follow examples that use Process Design to guide and inspire your own ProcessMaker implementations.
Follow an example that uses the Exclude Data setting for Web Entries in Form Task elements.
Intended audience: Process designers, Web designers, graphic designers, software developers
Tags: Exclude Data, Web Entry, Form Task
This example demonstrates how to configure Web Entry in Form Tasks. This Web Entry uses the Exclude Data setting to hide sensitive data, such as when displaying a code.
Follow these guidelines to use the Exclude Data setting for a Web Entry in a Form Task element:
Design a Form-type Screen with two Line Input controls and a Submit Button control.
Design a Process with the following elements:
Start Event element
Form Task element
Form Task element using Web Entry
Assign your created Screen to the first and second Form Task elements.
Configure the Web Entry in the second Form Task element as follows:
In the Mode setting, select Anonymous.
In the Completed Action setting, select Screen.
In the Screen For Completed setting, select a Screen after the Web Entry Screen submission.
In the Exclude Data setting, click the plus icon.
Enter the variable that will not display in the Web Entry Screen. For this example, it is Code
.
Start a Request of this Process.
Follow examples of how to configure Conditional Start Events with Global Data Expression Syntax.
Conditional events are triggered when an external condition is enabled or disabled. The data that can be used to assert conditions can be divided into two groups:
Request Data, which is all the request’s variables.
In Intermediate Conditional Event elements we can use both Request and Global Data. Conditional Start Event elements use Global Data only.
Start a Request when the current year is 2022: date(“Y”) == 2022
Start a Request every time that the current minute is 2: date("i") % 2 == 0
Start a Request when the environment variable API_TIMEOUT is set to a time that is greater than 30000: env(“API_TIMEOUT”) > 30000
Start a Request when the email server has an SMTP configuration: env(“MAIL_DRIVER”) == “smtp”
Start a Request when the third node and the first Request of a Process is triggered: getActiveTaskAt('node_3', 1) != null
The syntax allows you to navigate through attributes using the dot notation. Then, start a Request when the Task with ID node_3
of Request 1 is assigned to a user from Argentina:
getActiveTaskAt('node_3',1).user.country == “AR”
Start a Request when user 1 has firstname test
: lowercase(user(1).firstname) == “test”
Start a Request when a Process ID 86 is present in the database: process(86) != null
Start a Request if the Process 86 description is set to Outage
: process(86).description == “Outage”
Access the Process's Request information. For example, start a Request when Process 86 has one or more Requests: process(86).requests.count()>0
Start a Request when the last added Request is assigned to a user with ID 2: process(86).requests.last().user_id == 2
Start a Request when the Request 1000 is created: request(1000) != null
All elements of Request data can be accessed using arrays. For example, start a Request when Request 1 stock is less than 100: request(1).data['stock'] < 100
Start a Request when Request 1 has a user with username admin
assigned to it: request(1).data[”_user”][”username”] == “admin”
Start a Request when Request 1 is created later than the first day of 2023: request(1).created_at > '2023-01-01'
Start a Request when user 1 has firstname TEST
: uppercase(user(1).firstname) == “TEST”
Start a Request when user 1 changes its username to anonymous
: user(1).username == “anonymous”
Syntax allows the use of regular expressions. For example, starts a Request when the user 1 firstname starts with Admin
: user(1).firstname matches "/^Admin*/" == 1
Follow an example that uses the Allow Query String Data setting for Web Entries in Start Event elements.
Intended audience: Process designers, Web designers, graphic designers, software developers
Tags: Embed Code, Allow Query String Data, Web Entry, Start Event
Design a Process with the following elements:
Assign your created Screen to the Start Event element as Web Entry and the Form Task element.
Configure the Web Entry in the Start Event element as follows:
In the Mode setting, select Anonymous.
In the Screen Associated setting, select a Screen to display for the Web Entry Task.
In the Completed Action setting, select Screen.
In the Screen For Completed setting, select a Screen that displays after the Web Entry Task is submitted.
Select the Allow query string data setting to automatically save your string data information when running a Request. Otherwise, additional information in the URL is not stored.
Start a Request of this Process.
Below is an example of an HTML file with the embedded code.
Use the Variable Name setting values for the Line Input controls as Code and Name respectively as shown below. For this example, exclude the value for the Line Input control that has the Variable Name setting Code
.
End Event element
In the Web Entry URL setting, click Copy to use the URL when starting a Request for this Process.
When opening the Web Entry URL, the Screen does not display the Line Input control's value that has the Variable Name setting Code
.
Global Data, which is all the data external to a request such as the server time, user data, or other requests data. ProcessMaker publishes some functions with the that allow access to the most relevant global data. For more information about these functions, see .
The following examples use functions in the Condition setting of the .
This example demonstrates how to configure . Save your query string information in the by using the Allow query string data setting. This use case can be useful when sharing a Web Entry with multiple participating stakeholders: the shared query string data is stored for different countries as this example demonstrates. If you do not want to show the URL information that could result complex to the users, with this use case you can embed the Web Entry in a HTML file.
Follow these guidelines to use the Allow query string data setting for a Web Entry in a element:
Design a Screen with two controls and a control.
Use the Variable Name setting values for the Line Input controls as Code and Name respectively as shown below. For this example, exclude the value for the Line Input control that has the Variable Name setting Code
.
element using Web Entry
element
element
In the Web Entry URL setting, click Copy to use the URL to start a Request.
When starting a Request through this Start Event element using the Allow query string data setting in this example, the Web Entry uses the following URL https://{ServerURL}/webentry/15/node_9?country=usa
. {ServerURL}
is the name of the ProcessMaker Platform instance. The information after the quotation mark country=usa
stores in the Data section as follows:
Follow an example that uses the Enable Password Protect setting for Web Entries in Start Event elements.
Intended audience: Process designers, Web designers, graphic designers, software developers
Tags: Exclude Data, Web Entry, Start Event
This example demonstrates how to configure Web Entry in Start Events. This example demonstrates enhanced security by using the Enable Password Protect setting in the Start Event element's Web Entry that requires the Request starter to enter a password to display the Web Entry Screen. This use case can be useful to update this secure-level password every week, for example.
Follow these guidelines to use the Enable Password Protect setting for a Web Entry in a Start Event element:
Design a Form-type Screen with two Line Input controls and a Submit Button control.
Design a Process with the following elements:
Start Event element using Web Entry
Form Task element
Assign your created Screen to the Start Event element as Web Entry and the Form Task element.
Configure the Web Entry in the Start Event element as follows:
In the Mode setting, select Anonymous.
In the Screen Associated setting, select a screen to display for the Web Entry.
In the Completed Action setting, select Screen.
In the Screen For Completed setting, select a screen after the Web Entry screen submit.
Check the Enable Password Protect setting, the Password Protect setting displays.
In the Password Protect setting, enter a password.
Start a Request of this Process.
Use the Variable Name setting values for the Line Input controls as Code and Name respectively as shown below. For this example, exclude the value for the Line Input control that has the Variable Name setting Code
.
End Event element
In the Web Entry URL setting, click Copy to use the URL to start a Request.
When starting a Request through this Start Event element using the Enable Password Protect option, the Web Entry URL displays the Protected screen to enter the configured password.