Reference Magic Variables in ProcessMaker Assets
ProcessMaker uses a set of Magic Variables that you may reference in ProcessMaker Query Language (PMQL) queries and in your ProcessMaker assets, such as ProcessMaker Scripts and Screens.
ProcessMaker uses a schema-less JSON data model from which to read, write, and store Request data. Since the JSON data model is schema-less (meaning that it does not require a specific schema or structure from which ProcessMaker assets must conform), the JSON data model is structured from the JSON objects in ProcessMaker assets used in a Request: the Variable Name setting values in a ProcessMaker Screen or Request variables a ProcessMaker Script creates. When an in-progress Request routes through the Process, Request data aggregates into the JSON data model, thereby becoming Request data.
However, ProcessMaker uses a set of Magic Variables that become part of the JSON data model for all Requests. ProcessMaker uses these Magic Variables to store ProcessMaker user, Process, and Request related data for all Requests. During an in-progress Request, these ProcessMaker Magic Variables are updated. All ProcessMaker Magic Variables are preceded by an underscore (_) character in the JSON data model.
ProcessMaker users that have the Requests: Edit Request Data permission may view the JSON data model for a completed Request. This JSON data model displays from the Data tab in a completed Request's summary. Below is an example.
Use ProcessMaker Magic Variables in a variety of ways in ProcessMaker and in ProcessMaker assets.
Reference ProcessMaker Magic Variables to compose ProcessMaker Query Language (PMQL) advanced queries for Request searches and Task searches. See the following topics:
Your ProcessMaker user account or group membership must have the following permissions to edit a ProcessMaker Script unless your user account has the Make this user a Super Admin setting selected:
Scripts: Edit Scripts
Scripts: View Scripts
See the ProcessMaker Scripts permissions or ask your ProcessMaker Administrator for assistance.
​Mock ProcessMaker Magic Variable values while mocking Request data during testing to ensure your ProcessMaker Script runs as you intended.
Your ProcessMaker user account or group membership must have the following permissions to edit a ProcessMaker Screen control unless your user account has the Make this user a Super Admin setting selected:
Screens: Edit Screens
Screens: View Screens
See the ProcessMaker Screens permissions or ask your ProcessMaker Administrator for assistance.
Reference ProcessMaker Magic Variables in ProcessMaker Screens in the following ways:
​Rich Text controls: Reference a ProcessMaker Magic Variable's value in a Rich Text control through the Rich Text Content setting.
​Computed Properties: Reference a ProcessMaker Magic Variable's value from a computed Property. Use JavaScript to return a ProcessMaker Magic Variable's value, then store it in a computed Property.
Below is an example that contains all ProcessMaker Magic Variables. Each contains a value as it might be read from the Data tab in a completed Request summary. This example indicates the JSON structure for each ProcessMaker Magic Variable.
{"_user": {"id": 1,"fax": "723.743.8058 x00631","cell": "585.620.0749","city": "Donnaland","email": "[email protected]","media": [],"phone": "1-316-934-1911 x762","state": "WV","title": "Customer Service Representative","avatar": "","postal": "97304-3230","status": "ACTIVE","address": "8547 Marielle Hills","country": "US","fullname": "admin admin","language": "en","lastname": "admin","timezone": "America/Los_Angeles","username": "admin","birthdate": "1962-10-23","firstname": "admin","created_at": "2019-07-19T08:13:13-07:00","deleted_at": null,"expires_at": null,"updated_at": "2019-07-19T08:14:35-07:00","loggedin_at": "2019-07-19T08:14:35-07:00","datetime_format": "m/d/Y H:i","is_administrator": true},"_request": {"id": 1,"name": "Pet adoption","status": "ACTIVE","process": {"id": 1,"name": "Pet adoption","status": "ACTIVE","user_id": 1,"created_at": "2019-03-25T10:50:46-07:00","deleted_at": null,"updated_at": "2019-07-19T08:15:18-07:00","description": "Pet rescue","cancel_screen_id": null,"pause_timer_start": 0,"process_category_id": 1,"has_timer_start_events": false},"user_id": 1,"created_at": "2019-07-19T08:15:24-07:00","process_id": 1,"updated_at": "2019-07-19T08:15:24-07:00","callable_id": "ProcessId","initiated_at": "2019-07-19T08:15:24-07:00"}}
Below are descriptions of each ProcessMaker Magic Variable. Since these descriptions are outlined in tabular format, they do not imply how they are structured in the JSON data model. Refer to the example in the Example of All Magic Variables section to see how each JSON object is structured in the overall JSON data model.
The _user Magic Variable contains data about the current ProcessMaker user assigned a Task element or Manual Task element during an in-progress Request. Use JSON dot notation to reference specific data in a Magic Variable. Example: _user.fullname. If a Magic Variable contains no data, null is the value.
Magic Variable Name | Description |
| Identifier for the ProcessMaker user in that ProcessMaker instance. Automatically increments for each created ProcessMaker user. |
| Fax number as entered into the ProcessMaker user's profile. |
| Cell number as entered into the ProcessMaker user's profile. |
| City as entered into the ProcessMaker user's profile. |
| Email address as entered into the ProcessMaker user's profile. |
| ​ |
| Telephone number as entered into the ProcessMaker user's profile. |
| State, region, or province as selected in the ProcessMaker user's profile. |
| Job title as entered into the ProcessMaker user's profile. |
| Image reference for the ProcessMaker user's avatar as entered into the ProcessMaker user's profile. |
| Business postal code as entered into the ProcessMaker user's profile. |
| Status of the ProcessMaker user's account (active or inactive). |
| Business address as entered into the ProcessMaker user's profile. |
| Full name of the ProcessMaker user as entered into the ProcessMaker user's profile. |
| Language to display ProcessMaker labels as selected in the ProcessMaker user's profile. |
| Time zone as selected in the ProcessMaker user's profile. |
| User name for the ProcessMaker user as entered into the ProcessMaker user's profile. |
| Birth date for the ProcessMaker user. This is not entered into a user profile. |
| First name for the ProcessMaker user as entered into the ProcessMaker user's profile. |
| Datetime the ProcessMaker user account was created. |
| Datetime the ProcessMaker user account was deleted, if applicable. |
| Datetime the ProcessMaker user account expires, if applicable. |
| Datetime the ProcessMaker user account was updated, if applicable. |
| Datetime the ProcessMaker user logged on to the account, if applicable. |
| Datetime format setting as selected in the ProcessMaker user's profile. |
| Indicates if the ProcessMaker user account is granted the Make this user a Super Admin option. |
The _request Magic Variable contains data about the current Request or Process during an in-progress Request. Use JSON dot notation to reference specific data in a Magic Variable. Example: _request.process.name. If a Magic Variable contains no data, null is the value.
Magic Variable Name | Description |
| Request identifier for its associated Process. Automatically increments for each Request instance. |
| Name of the Process associated with the Request. |
| Status of the Request. |
| Identifier for the Process associated with the Request. Automatically increments for each Process created in the ProcessMaker instance. |
| Name of the Process associated with the Request. |
| Status of the Process associated with the Request. |
| Identifier for the ProcessMaker user that created the Process associated with the Request. |
| Timedate the Process associated with the Request was created. |
| Timedate the Process associated with the Request was archived. |
| Timedate the Process associated with the Request was updated. |
| Description of the Process that is associated with the Request. |
| Identifier for the Display-type ProcessMaker Screen that is selected to display when a Request is canceled. |
| Start Event Timer setting (in minutes) to start a Request. |
| Identifier for the Process Category associated with the Request. Automatically increments for each Process Category created in the ProcessMaker instance. |
| Indicates that the Process associated with the Request has at least one Start Timer Event element. |
| Identifier for the ProcessMaker user assigned the Task/Manual Task at that moment in the Request. |
| Datetime the ProcessMaker user account was create that is associated with the |
| Identifier associated with the Process in the ProcessMaker instance. Automatically increments for each Process created in that ProcessMaker instance. |
| Datetime the Process associated with the Request was last updated, if applicable. |
| Callable identifier for the Process associated with the Request. |
| Datetime the Request was started. |
