Request Data Type PMQL Properties

Use these ProcessMaker Query Language (PMQL) properties for Request PMQL search queries.

Overview

The following ProcessMaker Query Language (PMQL) properties apply to the Request data type to perform PMQL search queries from any of the pages accessible from the Requests top menu option. Selecting any PMQL search result displays the Request summary for that result.

completed: Request's Completion Datetime

completed property represents when the Request completes.

Datetime Format

Enter the datetime in the PMQL search query within quotation marks in the following format: YYYY-MM-DD HH:MM:SS using 24-hour time. Example: "2020-07-01 14:25:15".

NOW Keyword

Use the NOW keyword to dynamically compare the current datetime with a specified number of chronological units. Use the Less Than operator (<) followed by the number of chronological units to search for Requests of that age. Note that the interval unit of time is singular. PMQL supports the following units of time:

  • second

  • minute

  • hour

  • day

See Example 2 how this property can apply to Service Level Agreement (SLA) contract compliance.

created: Request's Creation Datetime

created property represents when the Request was created.

The created property is similar to the started property, in that when a Request starts, it is created. The created property applies to when our API creates a Request, while the started property pertains to when a user uses the user interface to start a Request.

Datetime Format

Enter the datetime in the PMQL search query within quotation marks in the following format: YYYY-MM-DD HH:MM:SS using 24-hour time. Example: "2020-07-01 14:25:15".

NOW Keyword

Use the NOW keyword to dynamically compare the current datetime with a specified number of chronological units. Use the Less Than operator (<) followed by the number of chronological units to search for Requests of that age. Note that the interval unit of time is singular. PMQL supports the following units of time:

  • second

  • minute

  • hour

  • day

data object: Search Request Data for Specific Request Information

Use the data JSON object to search for Request data associated with the sought Request(s). The data JSON object represents Request data: each Request's JSON data model contains the accumulation of all JSON objects and arrays for that Request. The data JSON object also contains the record data for a Collection. The key names for each JSON object or array derive from the Variable Name setting values in the Screens used for Tasks in each Request or any data injected into that Request's JSON data model by Scripts run via Script Task elements or calls to the RESTful Application Program Interface (API).

Using the data JSON object in PQML search queries helps answer the question "Which Request(s) have specific information in them that I seek?" Use operators to compare the value for a particular Screen control to find Requests that only contain the value(s) you seek. For example:

  • Search for Requests that apply to a specific customer in a Loan Request Process.

  • Search for Requests in a Purchase Request Process in which a purchase request amount is greater than $500 but less than $10,000.

  • Search for which registered conference attendees that were required to enter their job title are similar to "Product Manager," such as "Project Manager."

To determine what the Variable Name setting is for a control that stores Request information you seek, do one of the following:

  • View the Screen for the Task in which Request participants enter the information you seek, and then make note of the pertinent control's Variable Name setting. Note that your user account or group membership must have the Screens: View Screens permission.

  • View the Data tab in the summary for a completed Request to view the data from a completed Request, and then use the specific key name (represented in red-colored text) to search Request information from that control. Spaces are allowed between operators. Example: data.last_name = "Canera". Note that your user account or group membership must have the Requests: Edit Request Data permission. Ask your Administrator if you do not see the Data tab in completed Requests.

The data JSON object precedes the Variable Name setting value, as noted above. Use JSON dot notation to reference sub-properties in the referenced Screen control if necessary.

id: Request ID Number

id property represents the Request ID number associated with the sought Request's Process as displayed in the # column of Request pages.

This id property only applies to Request-related PMQL search queries, and is distinct from the id property for the Task data type or for the id property for the Collection data type.

modified: Datetime Request Was Last Modified

modified property represents when the Request was last modified. A Request modifies when its JSON object model is changed from a Script, a user action, an application program interface (API) call, or any other means.

Datetime Format

Enter the datetime in the PMQL search query within quotation marks in the following format: YYYY-MM-DD HH:MM:SS using 24-hour time. Example: "2020-07-01 14:25:15".

NOW Keyword

Use the NOW keyword to dynamically compare the current datetime with a specified number of chronological units. Use the Less Than operator (<) followed by the number of chronological units to search for Requests of that age. Note that the interval unit of time is singular. PMQL supports the following units of time:

  • second

  • minute

  • hour

  • day

participant: Request Participant by User Name

participant property represents the user name(s) of the person(s) that have participated in the sought Request. Request participants display in the Participants column of Request pages.

Enter the participant property value in quotation marks. Example: "lcanera". The property value is not case-sensitive.

process_id: Process ID Number Associated with the Request

process_ID property represents the Process ID number associated with the sought Request(s).

Process IDs do not display in the Processes page. However, if you have Process permissions to edit Process models, then determine the Process ID by doing the following:

  1. View your Processes. The Processes page displays.

  2. From the Web browser address bar, note the number immediately after modeler/. This number is the Process ID to use with the process_id property.

request: Request Name

request property represents the name of the sought Request(s).

Request names display in the Name column of Request pages. The Name column displays the Process name associated with the Request.

Enter the request property value in quotation marks. Example: "ProcessName". The property value is not case-sensitive.

requester: Requester's User Name

requester property represents the user name of the person who started the sought Request (called the Request starter).

Enter the requester property value in quotation marks. Example: "lcanera". The property value is not case-sensitive.

started: Datetime Request Started

started property represents when the Request starts.

The started property is similar to the created property, in that when a Request starts, it is created. The created property applies to when our API creates a Request, while the started property pertains to when a user uses the user interface to start a Request.

Datetime Format

Enter the datetime in the PMQL search query within quotation marks in the following format: YYYY-MM-DD HH:MM:SS using 24-hour time. Example: "2020-07-01 14:25:15".

NOW Keyword

Use the NOW keyword to dynamically compare the current datetime with a specified number of chronological units. Use the Less Than operator (<) followed by the number of chronological units to search for Requests of that age. Note that the interval unit of time is singular. PMQL supports the following units of time:

  • second

  • minute

  • hour

  • day

status: Request Status

status property represents the status(es) for the sought Request(s).

Enter the status property value in quotation marks. Example: "in progress". Values for the status property are not case-sensitive.

Use the following values for the status property:

  • In Progress: The sought Request is in-progress.

  • Completed: The sought Request is completed. Using the "completed" value is identical to using the completed property.

  • Canceled: The sought Request has been canceled.

  • Error: The sought Request has an error.

Last updated

© Copyright 2000-2024 ProcessMaker Inc. All rights reserved.