Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
ProcessMaker Query Language (PMQL) properties are the building blocks to search Request, Task, and Collection record information.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Use the search results for a Saved Search, send or schedule reports of those search results, or enable notifications of changes to search results.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Schedule an interval in which to email stakeholders reports for a Saved Search's results.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Create charts of Saved Searches to visualize search results in a variety of types and styles.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Use PMQL to search through Requests, Tasks, and Collection records in your ProcessMaker Platform Spring 2023 instance.
Search and Save Requests, Tasks, and Collection records in your ProcessMaker Platform instance.
Search ProcessMaker Platform data quickly by entering natural language phrases or questions pertaining to that information.
Global Natural Language Search gives you quick access to search Request, Task, and Collection data. From any page within ProcessMaker Platform, and using English and most non-English languages, enter everyday words and phrases in the Global Natural Language Search bar without using PMQL syntax.
Follow these steps to search Request, Task, Collection data in ProcessMaker Platform:
Log on to ProcessMaker Platform.
Click the Global Search bar. The following displays:
Search result: The Search result section displays search results after you have entered a phrase or question. If you have not made a current search, the following message displays: Nothing searched yet.
Click a search result. ProcessMaker Platform displays the search result, and the
ProcessMaker Query Language (PMQL) parameters for your Request, Task, or Collection record search from the platform page where the search was made. For more information about searching with PMQL, see Search PMQL. Optionally save this criteria as a Saved Search.
Locate the Global Search bar at the top-right of the platform.
Recently searched: The Recently searched section displays recent searches. You can click a recent search to quickly filter data, or clear the recent searches by clicking Clear. Otherwise, if there are no recent searches, the following message displays: The history is empty.
Next to the magnifying glass, enter an instruction in which to search data. For example, enter show me collections
or show Requests started by Louis Canera
. The Search result section loads all available search results. Search using English and most non-English languages.
Understand what ProcessMaker Query Language (PMQL) is.
ProcessMaker Query Language (PMQL) is a custom language to search ProcessMaker Platform data. Similar in ways to search query language (SQL), which is a standard language for storing, manipulating and retrieving data in databases, use PMQL to find Requests, Tasks, and Collection record information.
Use PMQL in the following ways:
Requests: Perform advanced searches to find Request summaries.
Tasks: Perform advanced searches through your Tasks.
Collection records: Search through the records in a Collection.
To understand how to use PQML, understand the basic concepts how to compose a PMQL search query:
Syntax: Syntax specifies how to compare, combine, exclude, or group the "building blocks" of a PMQL search query. An example of a comparative operator is to compare if the last name of a Request participant is (or is not) "Canera".
Data types: Data types specify which type of ProcessMaker Platform data to search. There are three data types in PMQL: Request
, Task
, and Collection
.
Properties: Properties are the "building blocks" from which to compose PMQL queries regardless of which data type a PMQL query applies. Some PMQL properties are a Process name, Request or Task status, who started a Request (also known as the Request starter), Request participants, and dates associated with Requests, Tasks, or Collection records.
Understand the standard SQL syntax from which to search ProcessMaker Platform data using ProcessMaker Query Language (PMQL).
LOWER
Function to Disregard Case Sensitivity in Strings and Request VariablesPMQL queries are case sensitive in regard to comparative and logical operators. If querying for a string or the value of a Request variable name, PMQL returns results only if the case exactly matches your query. Use the lower
function to disregard case-sensitivity evaluation by lower-casing strings and Request variable names. The lower
function is useful for when you are unsure of the case sensitivity of the comparing string or Request variable name.
lower(RequestVariable)
where RequestVariable
is the Request variable name
lower(data.job_title) LIKE "prod%" OR lower(data.job_title) LIKE "proj%"
PMQL operators such as AND
, OR
, and LIKE
are not case-sensitive. PMQL operators are capitalized in this document for easier readability.
Spaces are allowed between operators. Example: data.last_name = "Canera"
LIKE
Operator for Wildcard Pattern MatchingUse the LIKE
operator, then include wildcards %
or _
within the quotation marks ("
) of your search parameter.
The LIKE
operator is not case sensitive. However, this operator is capitalized in this document for easier readability.
The %
wildcard represents zero, one, or more characters. The _
wildcard represents exactly one character.
request LIKE "P%"
finds Requests associated with all Processes that begin with P
.
status LIKE "c%"
finds Requests with both Completed and Canceled statuses.
data.last_name LIKE "Ca%"
finds all values from Requests that begin with Ca
in the last_name
Request variable.
data.last_name LIKE "Ca___"
finds all values from Requests that begin with Ca
and those that match three following characters in the last_name
Request variable.
task LIKE "T%"
finds all Tasks that begin with T
.
See the following properties for more examples how to use the LIKE
operator:
Use the LIKE
operator with the %
wildcard to find text in a specified JSON array within Request data. Consider the following JSON array in Request data that contains two JSON objects. Each JSON object contains the first name, last name, and email address.
Use the following PMQL search query to find both persons in Request data based on the string company
. PMQL finds the string company
regardless of what string precedes or follows the sought pattern because the %
wildcard disregards all content in the JSON array preceding and following that pattern.
IN
and NOT IN
Operators for Array ValuesThe values are specified as a comma-delimited list, surrounded by square brackets and each value in quotation marks.
See the following examples:
Find for completed or erroneous Tasks where the Request Date is not 2021-07-01
or 2021-05-01
:
(status IN ["Completed", "Error"]) AND data.date NOT IN ["2021-07-01", "2021-05-01"]
Find for completed or erroneous Requests where the Request Date is 2021-07-01
or 2021-05-01
:
(status IN ["Completed", "Error"]) AND data.date IN ["2021-07-01", "2021-05-01"]
Find for completed or in progress Requests where the participant is admin
or Melissa
. The last modified is equal or major to 2020-07-01 00:00:00
. participant IN ["admin", "Melissa"] AND status NOT IN ["Completed", "In Progress"] AND modified >= "2020-07-01 00:00:00"
CAST
Function to Convert Data TypesThe CAST
function is a standard SQL syntax that PMQL supports for specific data types.
The CAST
function is not case sensitive. However, this function is capitalized in this document for easier readability.
The CAST
function converts data from one data type to another. PMQL supports the CAST
function for the following data types:
Text: If the Request data stores the Request variable in the PMQL query as an integer (such as 2
), convert that value to text ("2").
Number: If the Request data stores the Request variable in the PMQL query as text (such as "2"), convert that value to a number (2
). For example, use the CAST
function in a PMQL query to perform a numerical comparison to the Experience
Request variable that stores a job candidate's experience in an industry to find job candidates with two (2) years of experience or greater, use the following PMQL query: CAST(data.Experience as number) >= 2
.
See the following properties for examples:
NOW
Keyword to Perform Temporal Comparisons from NowThe NOW
keyword is not case sensitive. However, this keyword is capitalized in this document for easier readability.
The NOW
keyword represents the current datetime. Use the NOW
keyword in PMQL search queries to find Requests or Tasks in the following ways:
Dynamically compare the age of a Request or Task from the current datetime based on when the sought Request or Task was created or last modified. PMQL supports the following intervals of time:
second
minute
hour
day
Perform arithmetic operations on dates by using the following syntax:
date
operator
+
or -number
interval
where:
date
represents the date
operator
represents the comparative operator
+
or -
represents the addition or subtraction (respectively) from the date
number
represents the number to add or subtract from the date
interval
is the interval of time
Use the following PMQL query search query to find Requests for ProcessName
that are not more than two (2) days old:
Find Requests from ProcessName
in which its Request participants are 25 years old or younger by only having their date of birth in a Request variable called DOB
, use the following PQML search parameter:
Calculate the date of birth by subtracting 9125 days from the current datetime (365 * 25 = 9125).
ProcessMaker Query Language () builds upon standard search query language (SQL) syntax to use properties unique to ProcessMaker Platform. PMQL supports the following SQL syntax:
PMQL supports the following operators in and between each search criterion. The example for each comparative or logical operator assumes that the PMQL query searches against Request data for a Request variable (such as last_name
, experience
, and job_title
). See why data.
precedes each Request variable in each example.
for the Request
data type
for the Task
data type that includes an example how to
for the Task
data type
for the Task
data type
for the Collection
data type
See Example 2 for the for the Task
data type for another example.
Use the IN
operator to search for data where the value of the specified is one of multiple specified values.
Inversely, use the NOT IN
operator to search for data where the value of the specified is not one of multiple specified values.
for the Request
data type
for the Collection
data type
See . See also the following property examples:
for the Request
data type
for the Request
data type
for the Task
data type
for the Task
data type
for the Task
data type
for the Task
data type
for the Task
data type
for the Task
data type
for the Task
data type
for the Task
data type
for the Collection
data type
Dynamically determine a chronological value of a Request variable from Request data as part of the PMQL search query. See .
Save and share search parameters related to Requests, Tasks and Collections.
Operator Description | Syntax | Example |
Equal to |
|
|
Not equal to |
|
|
Less than |
|
|
Greater than |
|
|
Less than or equal to |
|
|
Greater than or equal to |
|
|
Search multiple required properties (logical operator) |
|
|
Search for any of multiple properties (logical operator) |
|
|
Group multiple logical operators | n/a |
|
Pattern matching |
|
ProcessMaker Query Language (PMQL) data types indicate the type of ProcessMaker Platform data to find: for Requests, Tasks, or Collection records.
ProcessMaker Query Language (PMQL) uses three data types. A data type specifies to which ProcessMaker Platform data the PMQL syntax applies. Syntax indicates how to interpret (parse) that data.
Request
When performing PMQL search queries from any of the pages accessible from the Requests top menu option, PMQL uses the Request
data type to apply PMQL syntax. Selecting any PMQL search result displays the Request summary for that result.
The Request
PMQL data type can use the following PMQL properties:
Task
When performing PMQL search queries from any of the pages accessible from the Tasks top menu option, PMQL uses the Task
data type to apply PMQL syntax. Selecting any PMQL search result displays the Task summary for that result.
The Task
PMQL data type can use the following PMQL properties:
Collection
The Collection
PMQL data type can use the following PMQL properties:
Use special characters, such as &, within PMQL searches when getting Request, Task, or Collection data.
Perform ProcessMaker Query Language (PMQL) searches in ProcessMaker Platform's Application Program Interface (API) calls using any properties of the following data types:
Learning this powerful tip how to perform PMQL searches via API calls allows you to perform PMQL searches without using the ProcessMaker user interface. However, having experience making API calls, which is an advanced skill most often performed by software developers and administrators, makes understanding this tip easier.
Understanding how to perform API calls is outside the scope of this topic.
Use special characters, such as &
, within PMQL searches when getting Request, Task, or Collection data while calling a ProcessMaker Platform API endpoint. To do so, special characters used in API calls must be Uniform Resource Identifier (URI) compliant.
For example, the following API call that gets Collection records from Collection ID 2
that contain tables & chairs
in their names does not work because after the property collection data.name
there are specials characters such as the =
, "
, space
, and &
.
pm_server_name
represents the name of your ProcessMaker Platform instance.
Follow these steps to make that includes a special character in a ProcessMaker Platform API call:
Ensure that your Administrator has created client authentication for your user account. If not, contact your Administrator.
Visit a Website that converts special characters to be URI-compliant, such as OnlineWebToolKit.
Copy the special character(s) in your ProcessMaker Platform API endpoint call into the URI converter Website, and then click to encode the special character(s) to be URI-compliant.
Referencing the example above, copy all the content after data.name
from the API endpoint URL to encode it. The encoding tool converts the characters ="tables & chairs"
to %3D%22tables%20%26%20chairs%22
.
Paste the URI-encoded special character(s), and then replace the non-encoded special character(s) in your API endpoint URL.
Referencing the example above, replace the ="tables & chairs"
in the ProcessMaker Platform API endpoint URL with %3D%22tables%20%26%20chairs%22
as follows:
https://pm_server_name/api/1.0/collections/collection/2/records?pmql=data.Name%3D%22tables%20%26%20chairs%22
Call the ProcessMaker Platform API endpoint that now includes the URI-encoded special character(s).
Use these ProcessMaker Query Language (PMQL) properties for Collection record PMQL search queries.
The following ProcessMaker Query Language (PMQL) properties apply to the Collection
data type to perform PMQL search queries from any of the pages accessible from the Collections sidebar icon in the Admin top menu option. PMQL search queries apply to records within the displayed Collection. Selecting any PMQL search result displays the Collection record for that result.
created
: Record's Creation Datecreated
property represents when the record was created from the currently displayed Collection.
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
KeywordUse 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
Purpose of the search: Find Collection records created on or after March 14, 2020.
Purpose of the search: Find Collection records created one day ago for newly registered Freshmen students in which their academic interests include engineering-related majors except software engineering.
This example uses the data
object. The data
object stores the accumulated data from Screen controls used to create and edit records in its Collection by referencing the controls' Variable Name setting values.
A Select List control in which its Variable Name setting value is AcademicInterests
stores multiple options in a JSON object that each Freshman student selected as academic interests.
Note the following:
This example uses the AND
operator to require multiple property values for the search.
This example uses LIKE
operator with the %
wildcard to search for any Task name that includes the characters engineering
as an academic interest, but excludes those records with software
preceding any academic interest.
PMQL search queries are case sensitive. This example uses the lower
function to ensure all options from AcademicInterests
are evaluated regardless of their case sensitivity.
data
object: Search Collection Data for Specific Record InformationUse the data
JSON object to search for sought Collection records. The data
object stores the accumulated data from Screen controls used to create and edit records in its Collection by referencing the controls' Variable Name setting values.
All JSON objects and arrays within the JSON object named data
is the accumulation of data for each Collection. Each Request also stores its Request data in a data
JSON object. The key names for each JSON object or array derive from the Variable Name setting values in the Screens used for that Collection or any data injected into that Collection's JSON data model by Scripts or calls to the RESTful Application Program Interface (API).
Using the data
JSON object in PQML search queries helps answer the question "Which Collection records have specific information in them that I seek?" Use operators to compare the value for a particular Screen control to find records that only contain the value(s) you seek.
To determine what the Variable Name setting is for a control that stores Collection record information you seek, view the Screen that contains the control into which the sought data was entered and/or edited. Collections use as many as two Screens: one into which to enter data when a record in that Collection is created, and one from which record data is edited. The same Screen may be used for both purposes. Note that your user account or group membership must have the Screens: View Screens permission.
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.
Purpose of the search: Find Collection records in which Business majors have enrolled in at least 18 credits this semester.
When submitting which courses to enroll that semester, each student must enter the following information into a Screen that becomes data in that Collection record when that Screen is submitted:
A Select List control of which its Variable Name setting is Major
stores the JSON object value for the option that each student selects as a major.
A Line Input control of which its Variable Name setting is TotalCredits
stores as an integer the sum of all credits that the student selected for enrollment.
Note the following:
This example uses the AND
operator to require multiple property values for the search.
Purpose of the search: Find Collection records in which employment candidates had programming experience in at least JavaScript and Python and had "Manager" in a job title.
When submitting a job application, each candidate must enter the following information into a Screen that becomes data in that Collection record when that Screen is submitted:
A Select List control of which its Variable Name setting is CodingLanguages
stores the JSON object value of programming languages in which the employment candidate has experience.
A Loop control contains a Line Input control that stores the job title for each position the employment candidate held. The Variable Name setting values for each control are Jobs and JobTitle, respectively.
id
: Collection Record ID Numberid
property represents the ID number for the sought record(s) from the currently displayed Collection.
This id property only applies to Collection record-related PMQL search queries, and is distinct from the id
property for the Request
data type or for the id
property for the Task
data type.
Purpose of the search: Find Collection records that are newer than record ID 7.
Purpose of the search: Find Collection records newer than Task ID 7 that were created after March 14, 2020.
Note the following:
This example uses the AND
operator to require multiple property values for the search.
This example uses the created
property to search for which Collections were created by a particular date. Note that PMQL interprets strings in the format YYYY-MM-DD HH:MM:SS
as dates and can be used in comparative queries if that string is in quotation marks ("2020-03-14 00:00:00"
).
modified
: Datetime Record Last Modifiedmodified
property represents when the record was last modified from the currently displayed Collection. A record modifies when the contents of the a record changes from any of the following:
A record is manually changed by a user that has permission to edit records in that record's Collection.
A Script adds or modifies data in a record.
A record is modified via the RESTful API.
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
KeywordUse 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
Purpose of the search: Find Collection records modified less than 30 minutes ago.
Note that this example uses the NOW
keyword to represent the current datetime, and then uses the Less Than operator (<
) to determine the datetime 30 minutes ago that the applicable Collection records were modified. Note that the unit of chronological measurement (minute
) is singular.
Purpose of the search: Find Collection records modified one day ago associated with students whose graduation year is 2022 and who last met their advisor more than six months ago.
This example uses the data
object. The data
object stores the accumulated data from Screen controls used to create and edit records in its Collection by referencing the controls' Variable Name setting values. The following Screen controls store data that this PMQL search query references:
GraduationYear: The GraduationYear
control stores at which year a student graduates. This value is stored as a string.
AdvisorMeetingDate: The AdvisorMeetingDate
control stores at which date a student met with her or his advisor.
Note the following:
This example uses the AND
operator to require multiple property values for the search.
This example uses the CAST
function to convert the string to a number for comparison in the PMQL search.
Use these ProcessMaker Query Language (PMQL) properties for Request PMQL search queries.
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 Datetimecompleted
property represents when the Request completes.
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
KeywordUse 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.
Purpose of the search: Find completed Requests for the Purchase Request Process between February 3, 2020, and February 10, 2020.
This example uses the AND
operator to search for multiple required property values.
This example uses the request
property. The request
property value ("Purchase Request Process"
) is not case-sensitive.
Purpose of the search: Find completed Requests for the "SLA for Purchase Request Process" that started on or after March 1, 2020, but did not complete on or prior to March 4, 2020, for purchase orders submitted through the New York or Chicago branches that are at least $10 million.
This example uses the data
object that represents Request data. The following Request variables store Request data that this PMQL search query references:
Branch: The Branch
Request variable stores to which company branch office a purchase request was submitted. Different branch offices might have different Service Level Agreement (SLA) contract requirements for which they must comply. For example, the New York and Chicago offices must complete a purchase request within three (3) days; the Charlotte office must complete requests within five (5) days.
TotalCost: The TotalCost
Request variable stores the total amount for the purchase request.
This example uses the OR
operator to search for any of multiple properties within an AND
operator to find those Requests associated with either the New York or Chicago branches.
Use a PMQL search query similar to this example to monitor which Requests completed past the sanctioned time period a SLA contract allows. In this example, if a Request completes three (3) days or later from when it starts for high-profile purchase requests and/or for flagship offices, then a company executive can apologize to the client for the late service delivery.
created
: Request's Creation Datetimecreated
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.
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
KeywordUse 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
Purpose of the search: Find Requests for the Employee Onboarding Process that were created on or after July 1, 2020.
Note the following:
This example uses the AND
operator to search for multiple required property values.
This example uses the request
property. The request
property value ("Employee Onboarding Process"
) is not case-sensitive.
Purpose of the search: Find created Requests for the Student Enrollment Process that have been canceled or encountered an error.
Note the following:
This example uses multiple operators: AND
and OR
. The AND
operator searches for multiple required properties while the OR
operator within one of the AND
operators searches for any of multiple property values.
This example uses the status
property that uses the canceled
and error
values.
data
object: Search Request Data for Specific Request InformationUse 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.
Purpose of the search: Find Requests that the business customer named Acme Products submitted in a Loan Request Process.
When submitting a business loan request, the business must enter the business's name into a Line Input control of which its Variable Name setting is BusinessName
.
Note the following:
The examples for the data
object use the AND
operator to require all properties in the PMQL search query to be required.
These examples also use the request
property. The request
property value (such as"Loan Request Process"
) is not case-sensitive.
Purpose of the search: Find Requests associated with the Purchase Request Process in which the total purchase request cost amount is greater than $500 but less than $10,000.
A Line Input control of which its Variable Name setting is TotalCost
stores the total cost amount of the purchase request. This example uses two AND operators, one which determines the cost range.
id
: Request ID Numberid
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.
Purpose of the search: Find Requests that are newer than Request ID 5.
Purpose of the search: Find Requests newer than Request ID 5 but older or the same as Request ID 10.
This example uses the AND
operator to require multiple property values for the search.
modified
: Datetime Request Was Last Modifiedmodified
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.
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
KeywordUse 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
Purpose of the search: Find Requests for the Student Enrollment Process that were modified on or after July 1, 2020 but before July 8, 2020.
Note the following:
This example uses the AND
operator to search for multiple required property values.
This example uses the request
property. The request
property value ("Student Enrollment Process"
) is not case-sensitive.
Purpose of the search: Find modified Requests for the Student Enrollment Process for Seniors in all Engineering-related majors except Mechanical Engineering in which their grade point average (GPA) is or less than 2.5.
Note that PMQL search queries are case sensitive. This example uses the data
object that represents Request data. The following Request variables store Request data that this PMQL search query references:
Grade: The Grade
Request variable stores which grade for each student is this year.
Major: The Major
Request variable stores the major for each student.
GPA: The GPA
Request variable stores the GPA for each student as a string. To do a numerical comparison, this example uses the CAST
function to convert the text to a number.
participant
: Request Participant by User Nameparticipant
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.
Purpose of the search: Find Requests that started two days ago associated with the Account Opening Process in which lcanera
and jlowell
have participated.
Note the following:
This example uses the AND
operator to search for multiple required property values.
This example uses the request
property. The request
property value ("Account Opening Process"
) is not case-sensitive.
This example uses 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 chronological unit of measurement is singular (day
).
Purpose of the search: Find all Requests for Processes with IDs 10 and 12 except those in which bfrizzel
has participated.
Note that this example uses the process_id
property, which is the Process's ID number.
process_id
: Process ID Number Associated with the Requestprocess_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:
View your Processes. The Processes page displays.
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.
Purpose of the search: Find Requests associated with Process IDs are 3 and 7. This example uses the OR
operator to search for any of multiple properties.
Purpose of the search: Find Requests that exclude those for Process ID 5. This example uses the Not Equal To operator (!=
) to exclude Process ID 5.
request
: Request Namerequest
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.
Purpose of the search: Find all Requests associated with the Loan Approval Process.
Purpose of the search: Find in-progress Requests associated with the Loan Approval Process and are at least three days old.
Note the following:
This example uses the status
property. The status
property values (such as "in progress"
) are not case-sensitive.
This example uses the NOW
keyword to represent the current datetime, and then uses the Less Than operator (<
) to determine the datetime two days ago. Note that the unit of chronological measurement (day
) is singular.
requester
: Requester's User Namerequester
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.
Purpose of the search: Find all Requests started by either jlowell
or sparkles
. This example uses the OR
operator to search for any of multiple properties.
Purpose of the search: Find canceled Requests started by either jlowell
or sparkles
on or after July 1, 2020 associated with Processes that contain "Course" followed by any five characters in its name.
Note the following:
This example uses multiple operators: AND
and OR
. The AND
operator searches for multiple required properties while the OR
operator within one of the AND
operators searches for any of multiple property values.
This example uses the started
property to search for when Requests started by a particular date. Note that PMQL interprets strings in the format YYYY-MM-DD HH:MM:SS
as dates and can be used in comparative queries if that string is in quotation marks ("2020-01-01 00:00:00"
).
This example uses the request
property. The request
property value ("Course_____"
) is not case-sensitive.
This example uses the LIKE
operator: functioning as a wildcard, each underscore character (_
) represents one wildcard character up to the number of underscores in the string that is in quotation marks.
started
: Datetime Request Startedstarted
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.
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
KeywordUse 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
Purpose of the search: Find Requests for the Travel Request Process that started on or after January 1, 2020, but before March 1, 2020.
Note the following:
This example uses the AND
operator to search for multiple required property values.
This example uses the request
property. The request
property value ("Travel Request Process"
) is not case-sensitive.
Purpose of the search: Find Requests for the Travel Request Process that started after March 1, 2020, in which their expected travel cost is at least $1,500, the departure date is later than March 7, 2020, and the return date is later than March 14, 2020. This example uses the data
object that represents Request data.
Note the following:
TotalCost: The TotalCost
Request variable stores the calculated total cost of the travel request.
Departure: The Departure
Request variable stores the requested departure date.
Return: The Return
Request variable stores the requested return date from travel.
status
: Request Statusstatus
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.
Purpose of the search: Find completed Requests associated with the Student Enrollment Process in which the either lcanera
or bfrizzel
are Request participants.
Note the following:
This example uses multiple operators: AND
and OR
. The AND
operator searches for multiple required properties while the OR
operator within one of the AND
operators searches for any of multiple property values.
This example uses the request
property. The request
property value ("Student Enrollment Process"
) is not case-sensitive.
This example uses the participant
property. The participant
property value (such as "lcanera"
) is not case-sensitive.
Purpose of the search: Find completed Requests associated with the University Admission Process that completed at or prior to June 15, 2020.
Note that PMQL interprets strings in the format YYYY-MM-DD HH:MM:SS
as dates and can be used in comparative queries if that string is in quotation marks ("2020-06-15 00:00:00"
).
Use these ProcessMaker Query Language (PMQL) properties for Task PMQL search queries.
The following ProcessMaker Query Language (PMQL) properties apply to the Task
data type to perform PMQL search queries from any of the pages accessible from the Tasks top menu option. Selecting any PMQL search result displays the Task summary for that result.
completed
: Datetime Task Completedcompleted
property represents when the Task completes. The completed
property applies to Form Task, Manual Task, and/or Script Task elements from the Request that created the sought Task(s).
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
KeywordUse 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
Purpose of the search: Find completed Tasks named Student Registration in the Student Enrollment Process that completed after they were due three days ago.
Note the following:
This example uses the AND
operator to require multiple property values for the search.
This example uses the task
property. The task
property value ("Student Registration"
) is not case-sensitive.
This example uses the request
property. The request
property value ("Student Enrollment Process"
) is not case-sensitive.
This example uses the NOW
keyword to represent the current datetime, and then uses the Less Than operator (<
) to determine the datetime four (4) days ago for completed Tasks that completed later than when they were due three (3) days ago. Note that the unit of chronological measurements (day
) is singular.
Purpose of the search: Find completed Tasks named Submit Employment Application in the Candidate Review Process in which employment candidates had programming experience in at least JavaScript and Python and had "Manager" in a job title.
This example uses the LIKE
operator to find text in a specified JSON array within Request data. For example, PMQL finds the string JavaScript
in the key name CodingLanguages
regardless of what string precedes or follows the sought pattern because the %
wildcard before and after the sought pattern disregards all content in the JSON array preceding and following that pattern, respectively.
This example uses the data
object that represents Request data. The following Request variables store Request data that this PMQL search query references:
CodingLanguages: The CodingLanguages
Request variable stores one or more selections from a Select List control of programming languages in which the employment candidate has experience. The Request data stores the Select List control selection(s) in a JSON array that contains both the value and content for each option in the Select List control.
JobTitle: The JobTitle
Request variable stores the job title for each position the employment candidate held. A Loop control called Jobs
contains a set of controls to enter information about each position the candidate held, among them being a Line Input control called JobTitle
.
created
: Task's Creation Datetimecreated
property represents when the Request creates the Task. The created
property applies to Form Task, Manual Task, and/or Script Task elements from the Request that created the sought Task(s).
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
KeywordUse 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 Examples 1 and 2 how this property can apply to Service Level Agreement (SLA) contract compliance.
Purpose of the search: Find created Tasks from two hours ago named Package Purchased Items in the Fulfill Purchase Delivery Process that started less than 30 minutes ago.
Note the following:
This example uses the AND
operator to require multiple property values for the search.
This example uses the task
property. The task
property value ("Package Purchased Items"
) is not case-sensitive.
This example uses the request
property. The request
property value ("Fulfill Purchase Delivery Process"
) is not case-sensitive.
This example uses the started
property to find those Tasks that started 30 minutes ago.
This example uses the NOW
keyword to represent the current datetime, and then uses the Less Than operator (<
) to determine the datetime two (2) hours ago and 30 minutes ago that the applicable Task(s) was created and started, respectively. Note that the unit of chronological measurements (hour
and minute
) are singular.
Use a PMQL search query similar to this example to monitor how much time passes from when a Task was created and that Task starts. A PMQL query similar to this example can determine which Tasks are being started later than the sanctioned time period a Service Level Agreement (SLA) contract allows from when that Task was created. For example, if a SLA contract states that a Task applicable to the contract must start within 1.5 hours from when its Request creates it, use a PMQL search query similar to this example to find only those Tasks that started less than 30 minutes ago, therefore longer than the 1.5 hours allowed by the SLA contract.
Purpose of the search: Find created Tasks associated with the Node Identifier setting value node_6
in Requests associated with Process ID 12 from two hours ago that have completed less than 30 minutes ago.
Note the following:
This example uses the element_id
property to reference the Node Identifier setting value (node_6
) from the Process model for the sought Task's element.
This example uses the process_id
property to reference the Process ID number (12
) associated with the sought Task(s).
This example uses the completed
property. The completed
property value compares the datetime that the Task completed.
Use a PMQL search query similar to this example to monitor how much time passes from when a Task was created and that Task completes. A PMQL query similar to this example can determine which Tasks are being completed later than the sanctioned time period a Service Level Agreement (SLA) contract allows from when that Task was created. Unlike Example 1 that identifies the Task to monitor by its name, this example identifies the Task by its Node Identifier setting value in a specified Process model. Otherwise, this example serves a similar purpose to monitor SLA contract compliance as does Example 1.
data
object: Search Request Data for Specific Request InformationUse the data
JSON object to search for Request data associated with the sought Task(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 for Tasks 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.
Purpose of the search: Find in-progress Tasks named Approve Semester Courses in the Student Enrollment Process in which Business majors have enrolled in at least 18 credits this semester.
When submitting which courses to enroll that semester, each student must enter the following information into a Screen that becomes Request data when that Screen is submitted:
A Select List control of which its Variable Name setting is Major
stores the JSON object value for the option that each student selects as a major.
A Line Input control of which its Variable Name setting is TotalCredits
stores as an integer the sum of all credits that the student selected for enrollment.
Note the following:
This example uses the AND
operator to require multiple property values for the search.
This example uses the status
property. The status
property values (such as "in progress"
) are not case-sensitive.
This example uses the task
property. The task
property value ("Approve Semester Courses"
) is not case-sensitive.
This example uses the request
property. The request
property value ("Student Enrollment Process"
) is not case-sensitive.
Purpose of the search: Find completed Tasks named Submit Leave Request in the Leave Request Process in which the reason those employees requested leave was illness between the dates March 15, 2020, and April 30, 2020.
When submitting a leave request, each employee must select from one of several options in a Checkbox control to indicate the reason for the leave request. The Checkbox control has a Variable Name setting of LeaveType
; the option that indicates the reason is for medical leave has an option value of Medical
. Therefore, to find those completed Tasks in which the reason for leave is illness, use the following in the PMQL search query: data.LeaveType = "Medical"
. The PMQL search query is case sensitive.
Note the following:
This example uses the completed
property. Each use of the completed
property compares the datetime that the Task completed.
PMQL interprets strings in the format YYYY-MM-DD HH:MM:SS
as dates and can be used in comparative queries if that string is in quotation marks ("2020-03-15 00:00:00"
).
due
: Datetime Task Is or Was Duedue
property represents when the Task is or was due. The due
property applies to Form Task, Manual Task, and/or Script Task elements from the Request that created the sought Task(s).
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
KeywordUse 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
See Example 2 how this property can apply to Service Level Agreement (SLA) contract compliance.
Purpose of the search: Find Tasks named Loan Review that are due in two days for the Loan Approval Process.
Note the following:
This example uses the AND
operator to require multiple property values for the search.
This example uses the task
property. The task
property value ("Loan Review"
) is not case-sensitive.
This example uses the request
property. The request
property value ("Loan Approval Process"
) is not case-sensitive.
This example uses the NOW
keyword to represent the current datetime, and then uses the Greater Than operator (>
) to determine the datetime two (2) days from now for due Tasks. Note that the unit of chronological measurements (day
) is singular.
Purpose of the search: Find Tasks that completed 20 minutes ago that were past due for Requests associated with process ID 25.
Note the following:
This example uses the completed
property. The completed
property compares the datetime that the Task completed. Since the PMQL search query finds completed Tasks past due, the due
property uses the Greater Than operator (>
) to find Tasks that were due later than 20 minutes ago.
This example uses the process_id
property with a value of 25
to find Requests associated with that Process.
element_id
: Task Node Identifier from the Process Modelelement_id
property is the Node Identifier setting value from the Process model for the sought Task's element. The element_id
property applies to Form Task, Manual Task, and/or Script Task elements from the Process model that started the sought Task(s).
Enter the node identifier value in the PMQL search query within quotation marks. The node identifier value is not case-sensitive. Example: "node_15"
.
if you have Process permissions to edit Process models, then determine the Node Identifier setting value for a Form Task, Manual Task or Script Task element by doing the following:
Select the Form Task, Manual Task, or Script Task element from the Process model from which to include in the PMQL search query. Panels to configure this element display.
Expand the Advanced panel if it is not presently expanded. The Node Identifier setting value displays.
See Example 2 how this property can apply to Service Level Agreement (SLA) contract compliance.
Purpose of the search: Find in-progress Tasks associated with the Node Identifier setting value node_4
in Requests associated with Process ID 10.
Note the following:
This example uses the AND
operator to require multiple property values for the search.
This example uses the status
property. The status
property values (such as "in progress"
) are not case-sensitive.
This example uses the process_id
property with a value of 10
to find Requests associated with that Process.
Purpose of the search: Find in-progress Tasks associated with the Node Identifier setting value node_4
in Requests associated with Process ID 10 that started two days ago.
Note the following:
This example uses the started
property in conjunction with the NOW
keyword, described below.
This example uses the NOW
keyword to represent the current datetime, and then uses the Less Than operator (<
) to determine the datetime two (2) days ago that the applicable Task(s) started. Note that the unit of chronological measurement (day
) is singular.
Use a PMQL search query similar to this example to monitor which started Tasks are at risk of completing past the sanctioned time period a Service Level Agreement (SLA) contract allows. For example, if a SLA contract states that a Task applicable to the contract must complete within three (3) days from when it starts, use a PMQL search query similar to this example to find only those Tasks that started two days ago to determine which are at risk of not complying with the SLA contract.
id
: Task ID Numberid
property represents the Task ID number for the sought Task(s). The id
property applies to Form Task, Manual Task, and/or Script Task elements from the Request that started the sought Task(s).
This id property only applies to Task-related PMQL search queries, and is distinct from the id
property for the Request
data type or for the id
property for the Collection
data type.
Purpose of the search: Find Tasks that are newer than Task ID 5.
Purpose of the search: Find Tasks newer than Task ID 5 but older or the same as Task ID 10.
This example uses the AND
operator to require multiple property values for the search.
modified
: Datetime Task Last Modifiedmodified
property represents when the Task was last modified. A Task modifies when the JSON object model to which that Task applies is changed from a Script, a user action, an application program interface (API) call, or any other means. The modified
property applies to Form Task, Manual Task, and/or Script Task elements from the Request that created the sought Task(s).
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
KeywordUse 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
Purpose of the search: Find Tasks modified 20 minutes ago named Loan Information in the Loan Application Process.
Note the following:
This example uses the AND
operator to require multiple property values for the search.
This example uses the task
property. The task
property value ("Loan Information"
) is not case-sensitive.
This example uses the request
property. The request
property value ("Loan Application Process"
) is not case-sensitive.
This example uses the NOW
keyword to represent the current datetime, and then uses the Less Than operator (<
) to determine the datetime 20 minutes ago that the applicable Task(s) were modified. Note that the unit of chronological measurement (minute
) is singular.
Purpose of the search: Find any Task modified between 30 minutes ago and one hour which have "approval" in its name from Requests associated with Process ID 25.
Note the following:
This example uses the process_id
property to reference the Process ID number (25
) associated with the sought Task(s).
This example uses the LIKE
operator with the %
wildcard to search for any Task name that includes the characters approval
in its name.
process_id
: Process ID Number Associated with the Taskprocess_ID
property represents the Process ID number associated with the sought Task(s). The process_ID
property applies to Form Task, Manual Task, and/or Script Task elements from the Process model associated with the Process ID that started the sought Task(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:
View your Processes. The Processes page displays.
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.
Purpose of the search: Find Tasks associated with Process IDs are 3 and 7.
This example uses the OR
operator to search for any of multiple properties.
Purpose of the search: Find Tasks that exclude those for Process ID 5. This example uses the Not Equal To operator (!=
) to find all Tasks except those associated with Process ID 5.
request
: Request Name Associated with the Taskrequest
represents the Request's name associated with the sought Task(s). The request
property applies to Form Task, Manual Task, and/or Script Task elements from the Process model that started the sought Task(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: "Request Name"
. The property value is not case-sensitive.
See Example 2 how this property can apply to Service Level Agreement (SLA) contract compliance.
Purpose of the search: Find completed Tasks started from either the Residential Loan Approval Process or the Business Loan Approval Process.
Note the following:
This example uses the AND
operator to search for multiple required property values.
This example uses the OR
operator to search for any of multiple properties within an AND
operator to find Tasks for either the "Residential Loan Approval Process" or "Business Loan Approval Process" Requests.
This example uses the status
property. The status
property values (such as "completed"
) are not case-sensitive.
Purpose of the search: Find in-progress Tasks started one hour ago for the Purchase Order Fulfillment Process for which the purchase order amount is at least $10,000 for Acme Corporation.
Note that this example uses the NOW
keyword to represent the current datetime, and then uses the Less Than operator (<
) to determine the datetime one hour ago that the applicable Task(s) started. Note that the unit of chronological measurement (hour
) is singular, even if the sought Task(s) is more than one hour old.
This example uses the data
object that represents Request data. The following Request variables store Request data that this PMQL search query references:
TotalPurchase: The TotalPurchase
Request variable stores the total purchase request amount, including applicable taxes.
Customer: The Customer
Request variable stores the business name for which the purchase order fulfillment applies.
Use a PMQL search query similar to this example to track which started Tasks are at risk of completing past the sanctioned time period a Service Level Agreement (SLA) contract allows. For example, if a SLA contract states that a Task applicable to the contract must complete within two (2) hours from when it starts for specific customers and/or for specific purchase order amounts, use a PMQL search query similar to this example to find only those Tasks that an hour ago to determine which are at risk of not complying with the SLA contract.
started
: Datetime Task Startedstarted
property represents when the Task starts. The started
property applies to Form Task, Manual Task, and/or Script Task elements from the Request that started the sought Task(s).
The started
property is similar to the created
property, in that when a Task starts, it is created. The created
property applies to when our API creates a Task, while the started
property pertains to when a user uses the user interface to start a Task.
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
KeywordUse 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
Purpose of the search: Find in-progress Tasks named Submit Purchase Request that started on July 1, 2020, for the Purchase Request Process.
Note the following:
This example uses the AND
operator to search for multiple required property values.
This example uses the task
property. The task
property value ("Submit Purchase Request"
) is not case-sensitive.
This example uses the status
property. The status
property values (such as "in progress"
) are not case-sensitive.
This example uses the request
property. The request
property value ("Purchase Request Process"
) is not case-sensitive.
Purpose of the search: Find completed Tasks named Purchase Authorization that started three days ago associated with the Purchase Request Process for which the approved total purchase amount was more than $100,000.
Note that this example uses the NOW
keyword to represent the current datetime, and then uses the Less Than operator (<
) to determine the datetime three (3) days ago that the applicable Task(s) started. Note that the unit of chronological measurement (day
) is singular.
This example uses the data
object that represents Request data. The following Request variables store Request data that this PMQL search query references:
Approve: The Approve
Request variable stores whether a Checkbox control is selected in the Form Task that approves a submitted purchase request. Since this example requires only approved purchases, this PMQL search query includes only Approve
values of true
that a Checkbox control stores when it is selected upon Task submission. The property value is not case-sensitive.
TotalPurchase: The TotalPurchase
Request variable stores the total purchase request amount, including applicable taxes.
status
: Task Statusstatus
property represents the Task status. The status
property applies to Form Task, Manual Task, and/or Script Task elements from the Request that started the sought Task(s).
Task status displays in the Status column of Task pages.
Enter the status
property value in quotation marks. Example: "in progress"
. The property value is not case-sensitive.
Purpose of the search: Find in-progress Tasks for the Travel Request Process.
Note the following:
This example uses the AND
operator to search for multiple required property values.
This example uses the request
property. The request
property value ("Travel Request Process"
) is not case-sensitive.
Purpose of the search: Find in-progress Tasks for the Travel Request Process for which the business travel destination is to any municipality named Dallas except that in Texas to leave three (3) days from today.
Note that this example uses the NOW
keyword to represent the current datetime, and then uses the Greater Than operator (>
) to determine the datetime three days from now that the requested business travel is to occur as requested in the LeaveDate
Request variable. Note that the unit of chronological measurement (day
) is singular.
This example uses the data
object that represents Request data. The following Request variables store Request data that this PMQL search query references:
DestinationMunicipality: The DestinationMunicipality
Request variable stores to which municipality business travel is requested.
DestinationState: The DestinationState
Request variable stores to which state business travel is requested.
LeaveDate: The LeaveDate
Request variable stores at which datetime business travel is requested.
task
: Task Nametask
property represents the Task name. The task
property applies to Form Task, Manual Task, and/or Script Task elements from the Request that started the sought Task(s).
Task names display in the Task column of Task pages.
Enter the task
property value in quotation marks. Example: "TaskName"
. The property value is not case-sensitive.
Purpose of the search: Find completed Tasks named Review Risk Rating.
Note the following:
This example uses the AND
operator to search for multiple required property values.
This example uses the status
property. The status
property values (such as "in progress"
) are not case-sensitive.
Purpose of the search: Find in-progress Tasks that contain the word "review" in its name for Requests associated with process ID 12.
Note the following:
This example uses the LIKE
operator with the %
wildcard to search for any Task name that includes the characters review
in its name.
This example uses the process_id
property with a value of 12
to find Requests associated with that Process.
Understand what the Saved Search package does in ProcessMaker Platform.
You may schedule a regular interval in which to email reports for either your own Saved Searches or those shared with you.
Saved Searches are available to all users in the organization on the following pages when the Saved Search package is installed in that ProcessMaker Platform instance:
Request-related pages
Task-related pages
By default, Saved Searches do not display the number of items that correspond to each Saved Search when viewing the names of Saved Seaches from the left sidebar. If your ProcessMaker Platform instance requires the number of Saved Search items display, submit a Support ticket.
Saved Searches have the following attributes regarding configuring and sharing Saved Searches:
Hide Saved Searches: You may hide your own Saved Searches. Hiding a Saved Search only hides that Saved Search from the left sidebar of your Request- and Task-related pages. Shared recipients of that Saved Search may still use it to view search results using your Saved Search's parameters.
Delete Saved Searches: You may delete your Saved Searches. However, in doing so, they are no longer shared with those users and/or groups with which you have shared them. The recipients of your shared Saved Search will no longer be able to use it to quickly view search results using your Shared Search's parameters.
Request-related Saved Searches: Saved Searches associated with Requests display only in the left sidebar of Request-related pages.
Task-related Saved Searches: Saved Searches associated with Tasks display only in the left sidebar of Task-related pages.
Charts use the data results from the Saved Search to visualize those results in a variety of chart types and styles. Chart data may be filtered by using an optional PMQL query that further filters the data from that Saved Search to visualize minute data.
The Charts tab displays charts created for a Saved Search.
Configure the following types of Saved Search charts:
View the data details of a Saved Search's result in tabular format based on the type of Saved Search.
An image represents each Saved Search from the left sidebar, but only display on pages associated with its type. Saved Searches are organized by type:
If a Saved Search has been shared with you, you may not change the type of information that displays in its results.
While viewing a Saved Search, use the Search function to locate data in that Saved Search. Locate data using the following methods:
Perform a plain-text search for data in that Saved Search.
Saved Searches that pertain to Requests display on the following Requests pages:
An image represents each Saved Search from the left sidebar. Saved Search icons display below the icons to access the default Requests pages.
Follow these steps to view results from a Saved Search pertaining to Requests:
Go to a Request-related page.
Click the image that represents the Saved Search. The results for that Saved Search display.
Below are results for a Request-related Saved Search.
Saved Searches that pertain to Tasks display on the following Tasks pages:
Self Service page.
An image represents each Saved Search from the left sidebar. Saved Search icons display below the icons to access the default Tasks pages.
Follow these steps to view results from a Saved Search pertaining to Tasks:
Go to a Task-related page.
Click the image that represents the Saved Search. The results for that Saved Search display.
Below are results for a Task-related Saved Search.
Follow these steps to view results from a Saved Search pertaining to records in a Collection:
Click the Admin option from the top menu. The Users page displays.
Click the image that represents the Saved Search. The results for that Saved Search display.
Below are results for a Saved Search related to records in a Collection.
From the # column, click the Request number associated with the Process displaying in the Name column to view its summary. This number represents the sequential occurrence of that Process.
From the Task column, click the Task name that you want to view.
If there are no search results from the Saved Search, the following message displays: No Data Available.
See .
When performing PMQL search queries from any Collection accessible from the Collections sidebar iconin the Admin top menu option, PMQL uses the Collection
data type to apply PMQL syntax. PMQL search queries apply to records within the displayed Collection. Selecting any PMQL search result displays the Collection record for that result.
Click the Open Modeler iconto edit the Process model associated with the sought Requests. Process Modeler displays.
Ensure that the Hide Menus buttonis not enabled. See Maximize the Process Modeler Canvas View.
Click the Open Modeler iconto edit the Process model associated with the sought Requests. Process Modeler displays.
The must be installed to use Saved Searches.
Use the Saved Searches package to save and share search parameters associated with , and . In doing so, you manage the search parameters for your Saved Searches. You may share your own Saved Searches with other and/or . Recipients of your shared Saved Searches can only use your Saved Search to view its search results, but cannot modify your Saved Searches' parameter settings you configured. The name for a Saved Search does not need to be unique. Therefore, multiple Saved Searches may have the same name when your own Saved Search and one shared with you have the same name.
Similar to , , and , filter the data that for a Saved Search using ProcessMaker Query Language ().
Click the Edit Saved Searches iconfrom the left sidebar in any of the Requests, Tasks, or Collections pages to view the Edit Saved Searches page. The Edit Saved Searches page displays both your own Saved Searches as well as those that others have shared with you for that search type. For example, clicking the Edit Saved Searches icon from the left sidebar of any of the Requests pages only displays Request-type Saved Searches. See .
An icon represents each Saved Search that the user selects when . Saved Searches display above the My Saved Searches icon. Click the Expand sidebar iconat the bottom of the left sidebar on any of the Requests, Tasks, or Collections pages to view the names for each Saved Search. Click the Collapse sidebar icon to hide the Saved Search names.
Configure your Saved Searches: You and your own Saved Searches. Those that you share with others can only view its search results using the parameters configured in your Saved Searches.
Schedule to email reports of your Saved Search results: You may to email reports for the search results for one of your own Saved Searches. Each schedule can email the report in .CSV
or .XLSX
format.
Collection-related Saved Searches: Saved Searches associated with display on the left sidebar of Collection pages. Note that the must be installed for Collections to be available.
Charts help visualize your Saved Search results. Though you can , nothing distills that data like a customized chart. Create and configure two-dimensional charts to visualize Saved Search results after selecting a Saved Search. You may create customized charts regardless of whether you created the Saved Search or if it was shared with you.
designers may also embed Saved Search charts into - and -type Screens using the .
Bar (horizontal or vertical): Visualize Saved Search results in or bars.
Line: Visualize Saved Search results as to show how those results trend.
Pie: Visualize Saved Search results as .
Doughnut: Visualize Saved Search results similar to the pie chart style .
Count: Display a .
See .
To view the data details for a , the must be installed.
You may also view the data details for a Saved Search associated with a . Use Saved Searches in Collections to search for records in a Collection. To use Collections, the must be installed.
Regardless of whether you a Saved Search or if it has been shared with you, you may view the data details of that search result that is based on the ProcessMaker Query Language () parameters configured in that Saved Search.
-related Saved Searches are accessed from Requests pages.
-related Saved Searches are accessed from Tasks pages.
Saved Searches for records are accessed from the Collections sidebar iconin the Admin top menu option. (Your user account or group membership must have the "Collections: View Collections" permission to view the list of Collections unless your user account has the Make this user a Super Admin setting selected. See the permissions or ask your Administrator for assistance. Lastly, your user account or group membership must have the View from a Collection's configuration to view that Collection's records. See or ask the manager of that Collection for assistance.)
Columns that display in the tabular-formatted results for a Saved Search can be customized by the that created the Saved Search. See the following topics:
To quickly view how many search results pertain to each Saved Search that either you have created or have been shared with you, click the logo that displays from the left sidebar to expand that sidebar. View at a glance how many items pertain to each Saved Search as well as Saved Searches for that type.
Perform a query based on a , or Saved Search.
To view results for a , the must be installed.
My Requests page. See .
In Progress page. See .
Completed page. See .
All Requests page. See . (Note that your user account must have the to view the All Requests page.)
.
To from search results, do one of the following:
Click the Open Request iconfor the Request to view its summary.
To view results for a , the must be installed.
To Do page. See .
Completed page. See .
.
To view a from search results, do one of the following:
Click the Open Task iconfor the Task name that you want to view.
To view search results for a , the must be installed. Likewise, to create, share, or view Saved Searches for records in a Collection, the must also be installed.
Your user account or group membership must have the "Collections: View Collections" permission to view the list of Collections unless your user account has the Make this user a Super Admin setting selected. See the permissions or ask your Administrator for assistance.
Furthermore, your user account or group membership must have the View from a Collection's configuration to view that Collection's records. See or ask the manager of that Collection for assistance.
Saved Searches that pertain to records in a Collection display from the Collections iconin the left sidebar after selecting the Admin top menu option. An image represents each Saved Search from the left sidebar. Saved Search icons display above the icons to access Collections.
Ensure that you are to ProcessMaker Platform.
Click the Collections iconfrom the left sidebar. The Collections page displays the Collections that you are allowed to view.
.
To view a Collection record from search results, click the Edit iconfor the record you want to edit.
To from search results, do one of the following:
Click the Open Request iconfor the Request to view its summary.
To view a from search results, do one of the following:
Click the Open Task iconfor the Task name that you want to view.
To view a Collection record from search results, click the Edit iconfor the record you want to edit.
Use the setting to filter the Saved Search's search results that display.
, including how to sort columns or how many items display per page.
View Saved Searches that have been shared with you for a specific type of Saved Search.
To view Saved Searches shared with you, the Saved Searches package must be installed.
Follow these steps to view Saved Searches shared with you for a specific type of Saved Search:
Click the Shared with Me tab. Saved Searches shared with you display.
The Shared With Me tab displays the following information in tabular format about Saved Searches that have been shared with you for that Saved Search type:
Name: The Name column displays the name of the Saved Search. The icon beside the Saved Search's name displays from the left sidebar for that Saved Search's type. For example, the icons that display in the image above display in Request-related pages.
Created By: The Created By column displays the user's avatar who created the Saved Search. Hover your cursor over the user's avatar to view that person's full name.
Modified: The Modified column displays the date and time the Saved Search was last modified by the user that created the Saved Search. A Saved Search can only be modified by the user that created it. The time zone setting to display the time is according to the ProcessMaker Platform Platform instance unless your user profile's Time zone setting is specified.
Created: The Created column displays the date and time the Saved Search was created. The time zone setting to display the time is according to the ProcessMaker instance unless your user profile's Time zone setting is specified.
Use the Search field to filter Saved Searches that display.
If there are no Saved Searches, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Manage your own Saved Searches for each specific type of Saved Search.
Saved Searches are organized by their type:
Request-related Saved Searches are accessed from Requests pages. These Saved Searches are available to all users when the Saved Searches package is installed. See View Request-Type Saved Search Results.
Task-related Saved Searches are accessed from Tasks pages. These Saved Searches are available to all users when the Saved Searches package is installed. See View Task-Type Saved Search Results.
Saved Searches for Collection records are accessed from the Collections page. (Your user account or group membership must have the "Collections: View Collections" permission to view the list of Collections unless your user account has the Make this user a Super Admin setting selected. See the Collections permissions or ask your Administrator for assistance. Lastly, your user account or group membership must have the View record permission from a Collection's configuration to view that Collection's records. See Configure a Collection or ask the manager of that Collection for assistance.) See View Collection Record Saved Search Results.
To manage your own Saved Searches, the Saved Searches package must be installed.
You can view and manage your own Saved Searches that you have created. A Saved Search can only be managed by the user that creates it unless that user has the Make this user a Super Admin setting enabled for that user account; see Manage Saved Searches. This setting is generally reserved for Administrators and is not available to most users.
To quickly configure a specific Saved Search that you have created, follow these steps:
Click the image from the left sidebar that represents your own Saved Search. Though Saved Searches shared with you also display from the left sidebar, you cannot configure these Saved Searches. The search results for that Saved Search displays.
The Edit Saved Searches page displays the following information in tabular format about your Saved Searches and those which have been shared with you for that Saved Search type:
Name: The Name column displays the name of the Saved Search. The icon beside the Saved Search's name displays from the left sidebar for that Saved Search's type. For example, the icons that display in the image above display in Request-related pages.
Created By: The Created By column displays the user's avatar who created the Saved Search. Hover your cursor over the user's avatar to view that person's full name.
Modified: The Modified column displays the date and time the Saved Search was last modified by the user that created the Saved Search. A Saved Search can only be modified by the user that created it. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Created: The Created column displays the date and time the Saved Search was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Use the Search field to filter Saved Searches that display.
If there are no Saved Searches, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Show or hide your own Saved Searches from displaying in the left sidebar of Request- and Task-related pages.
Hiding a Saved Search only hides it from the left sidebar for its specific Saved Search type. For example, toggling visibility of a Request-related Saved Search only affects the left sidebar on Request-related pages. Shared recipients of a Saved Search may still use that Saved Search to view search results.
Showing a Saved Search only hides it from the left sidebar for its specific Saved Search type. For example, toggling visibility of a Request-related Saved Search only affects the left sidebar on Request-related pages. Shared recipients of a Saved Search may still use that Saved Search to view search results.
Follow these steps to show one of your hidden Saved Searches:
You may hide only one of your own Saved Searches. Hiding a Saved Search only hides it from the left sidebar for its specific Saved Search type. For example, toggling visibility of a Request-related Saved Search only affects the left sidebar on Request-related pages. Shared recipients of a Saved Search may still use that Saved Search to view search results.
Follow these steps to hide one of your own Saved Searches:
Create and share a Saved Search with users and/or groups so that they can take advantage of your search parameters.
Follow these steps to create and share a Saved Search:
In the Name setting, enter the name of your Saved Search. Since this name displays from the left sidebar of the Requests/Tasks/Collections pages, ensure that this is a descriptive name based on the PMQL parameters that compose the search. This name is helpful for yourself and those with whom you share this Saved Search to know for what this Saved Search's results are. The Saved Search name does not need to be unique. Therefore, multiple Saved Searches may have the same name when your own Saved Search and one shared with you have the same name. This is a required setting.
Follow these guidelines to select an image that represents the Saved Search results. Saved Searches associated with Requests display from the left sidebar of Requests pages. Saved Searches associated with Tasks display from the left sidebar of Tasks pages. Saved Searches associated with Collection records display from the left sidebar of Collections pages.
Follow these steps to select an image that ProcessMaker Platform provides to represent the Saved Search:
Click the Search drop-down menu.
Select the image to represent your Saved Search.
Follow these steps to select a custom image to represent the Saved Search:
Locate the icon to represent your Saved Search. The icon must not be larger than two (2) kilobytes or the following message displays below the Search setting: The custom icon file is too large. File size must be less than 2KB..
Click the Save button.
Filter all the Saved Search's results to find its data details.
Follow these steps to search for a Saved Search's result:
Enter in the Search setting the text to filter Saved Searches using the Saved Search's name that displays in the Name column.
As you enter text into the Search field, search results display that match your entered text.
If there are no search results, the following message displays: No Data Available.
Click the Edit Saved Searches iconfrom the left sidebar of pages associated with that Saved Search type. The My Saved Searches tab of the Edit Saved Searches page displays your Saved Searches associated by its specific type.
Click the Edit Saved Searches iconfrom the left sidebar of pages associated with that type.
Click the Edit Saved Searches iconfrom the left sidebar of pages associated with that Saved Search type. The My Saved Searches tab of the Edit Saved Searches page displays your Saved Searches associated by its specific type. Below are Saved Searches for the Request type.
Click the Configure Saved Search button. The configuration settings for your Saved Search displays. See Configure a Saved Search.
Toggle to hide or show your own Saved Searches by using the Hide Saved Searchand Show Saved Searchicons. Hidden Saved Searches do not display in the left sidebar specific to the context from which the Edit Saved Searches icon was selected. See Hide or Show Your Own Saved Searches.
Click the Configure icon. See Configure a Saved Search.
Click the Delete icon. See Delete a Saved Search.
To hide or show , the must be installed.
You may show or hide your own Saved Searches. However, you cannot show or hide Saved Searches which have been shared with you. You can only control visibility of Saved Searches that you have .
Visible Saved Searches display above the Edit Saved Searches icon.
. The Edit Saved Searches page displays.
Click the Show Saved Search icon for the hidden Saved Search. The Saved Search is visible from the left sidebar for that type of Saved Search, indicated by full visibility of that Saved Search in the Edit Saved Searches page.
. The Edit Saved Searches page displays.
Click the Hide Saved Search icon for one of your Saved Searches. The Saved Search is hidden, indicated by diminished visibility of that Saved Search in the Edit Saved Searches page.
To create and share , the must be installed.
You may also create and share Saved Searches when using . Use Saved Searches in Collections to search for records in a Collection. To use Collections, the must be installed.
If you are saving record searches from a Collection, your user account or group membership must have the "Collections: View Collections" permission to view the list of Collections unless your user account has the Make this user a Super Admin setting selected. See the permissions or ask your Administrator for assistance.
Furthermore, your user account or group membership must have the View from a Collection's configuration to view that Collection's records. See or ask the manager of that Collection for assistance.
Enter the advanced search criteria using ProcessMaker Query Language () parameters for your , , or record search. It is this criteria from which the Saved Search settings are based. See the following topics for how to compose PMQL search parameters in an advanced search:
Click the Save Search button. The Save Search screen displays.
Click the Upload Custom Icon icon.
From the Share With Users drop-down menu, select with which to share your Saved Search by selecting the person's full name. Multiple users may be added, one at a time, to this setting. You may click the Remove iconfor a user to remove that user from the Share With Users drop-down menu. These selected users will see your Saved Search with the image you selected from the left sidebar for pages associated with its search type.
From the Share With Groups drop-down menu, select with which to share your Saved Search by selecting the group. Multiple groups may be added, one at a time, to this setting. You may click the Remove iconfor a group to remove that group from the Share With Groups drop-down menu. Members of a group added to the Share With Groups drop-down menu will see your Saved Search from the left sidebar for pages associated with its search type with the image you selected.
Use the Search function to filter all the results for a .
Use for the most accurate means by which to locate specific Requests.
To search for a , the must be installed.
.
Configure one of your own Saved Searches.
To configure a Saved Search, the Saved Searches package must be installed.
You may configure only one of your own Saved Searches, not one which has been shared with you. Configure a Saved Search regardless of whether it is visible or hidden.
Follow these steps to select the Saved Search to configure:
View the Shared Searches for a specific Saved Search type. The Edit Saved Searches page displays.
Refer to the following sections to configure your Saved Search. These configuration sections may be configured independently of one another:
Follow these steps to configure basic settings for your Saved Search:
Edit the following information in the Configuration tab about your Saved Search as necessary:
Name: In the Name setting, edit the name of your Saved Search. Since this name displays from the left sidebar of Requests/Tasks pages, ensure that this is a descriptive name based on the ProcessMaker Query Language (PMQL) parameters that compose the search. This name is helpful for yourself and those with whom you share this Saved Search to know for what this Saved Search's results are. This is a required setting.
Image: Follow these guidelines to select an image that represents the Saved Search results. Saved Searches associated with Requests display from the left sidebar of Requests pages, while those associated with Tasks display from the left sidebar of Tasks pages.
Select an image from ProcessMaker Platform to represent the Saved Search:
Click the Icon drop-down menu.
Select any of the images that ProcessMaker Platform provides.
Select a custom image to represent the Saved Search:
Click the Upload Custom Icon button to the right of the Icon drop-down menu. The file browser window displays.
Locate the icon on your local computer or network to represent the Saved Search. The icon must not be larger than 2 kilobytes large or the following message displays below the Choose File button: The file is too large. File size must be less than 2KB when base64 encoded..
PMQL: In the PMQL setting, edit the ProcessMaker Query Language (PMQL) parameters if necessary. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
Click Save.
Follow these steps to configure how information displays for your Saved Search:
Select the Saved Search to configure. The Configuration tab displays.
Note the following when configuring how Saved Search results display in tabular format:
The informational components in the Active Columns column display in the order that these informational components display in tabular format. Informational components at the top of the Active Columns column display left-most in the column order; components at the bottom of the Active Columns column display right-most in the column order.
It may be helpful to understand how ProcessMaker Platform analyzes completed Request data for Request-type Saved Searches. To derive that Request information, view the Data tab in the summary for a completed Request to view the data from a completed Request. The key names (represented in red-colored text) represent Request data. 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 Request summaries.
The columns as configured in the Active Columns column determine how Saved Search results can be visualized in charts: these columns are options when configuring the chart series, category, and metric settings for a chart. Active columns in a Saved Search's results that represent dates, numbers, and/or unique text results are recommended as settings when configuring a Saved Search chart.
Follow these guidelines to select which column(s) display information in the Saved Search results:
Remove a column that displays information in the Saved Search results:
Add and configure a column that displays information in the Saved Search results:
Drag the informational component from the Available Columns column to the Active Columns column, and then place the informational component in the order from top-to-bottom that you want that informational component to display in search results. Informational components at the top of the Active Columns column display left-most in the column order; components at the bottom of the Active Columns column display right-most in the column order.
Informational components that are not defaults can be configured to display a label and what the informational component represents.
Configure how a column displays information in the Saved Search results:
In the Label setting, edit the column label that displays in search results (if necessary).
In the Field setting, edit the key name that represents the Request data (if necessary). data.
represents that what follows derives from Request information. To derive that Request information if it is necessary to change the Field setting value, 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) in the following syntax, where RequestData
represents the key name: data.RequestData
. 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.
Use the Sortable toggle key to adjust whether the column can be sorted in search results.
Click Save.
Add a custom column to include additional information in the Save Search results:
In the Label setting, enter the column label that displays in search results.
In the Field setting, enter the key name that represents the Request data. data.
represents that what follows derives from Request information. To derive that Request information, 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) in the following syntax, where RequestData
represents the key name: data.RequestData
. 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.
Use the Sortable toggle key to adjust whether the column can be sorted in search results.
Click Save.
Sort the order that columns display in Save Search results:
Reset the columns in the Saved Search to the default layout:
Click Confirm.
Click Save after you configure all your Saved Search settings.
Follow these steps to configure with which users to share your Saved Search:
Select the Saved Search to configure. The Configuration tab displays.
Follow these guidelines to select with which users to share your Saved Search:
Adjust the toggle key for each user that you want to share your Saved Search. When the toggle key is enabled, that user can use your Saved Search, but cannot configure, hide, or delete it.
Enter in the Search setting the text to filter users by their full name.
Click Save.
Follow these steps to configure with which groups to share your Saved Search:
Select the Saved Search to configure. The Configuration tab displays.
Follow these guidelines to select with which groups to share your Saved Search:
Adjust the toggle key for each user that you want to share your Saved Search. When the toggle key is enabled, all members of that group can use your Saved Search, but none can configure, hide, or delete it.
Enter in the Search setting the text to filter groups.
Click Save.
Email stakeholders in your Saved Search's data details as a report.
Email a report of the currently displayed search results for a Saved Search to one or more email recipients. In doing so, those search results are emailed as a comma-separated values (.CSV
) file that can be opened in a spreadsheet editor. Email recipients receive the Saved Search results as an attachment to the email. Separate multiple email recipients using commas.
Follow these steps to email a report of search results for a Saved Search:
In the Send to setting, enter the email address(es) for the email recipients to receive the report. Separate multiple email recipients using commas.
In the Email Subject setting, enter the email subject of your report to which the report will be attached.
In the Email Body setting, enter the email body content for your report.
From the File Format setting, select which file format to email the report:
CSV: Email the report as a comma-separated value (CSV) file.
XLSX: Email the report as a Microsoft Excel open XML format spreadsheet.
Click Send. Email recipients receive the Saved Search results as an attachment to the email.
Receive notifications when a Saved Search's results change.
Below are other examples to receive a notification when the Saved Search results change:
Saved Search notifications can be enabled only for your own Saved Searches. Saved Searches by default send notifications when a Saved Search's results change.
Follow these steps to enable notifications when the results for your Saved Search changes:
Saved Search notifications can be disabled only for your own Saved Searches.
Follow these steps to disable notifications when the results for your Saved Search changes:
Delete a Saved Search that you no longer use or want to share with others.
When deleting a Shared Search, it is no longer shared with those users and/or groups with which you have shared them. The recipients of your shared Saved Search will no longer be able to use it to quickly view search results using your Shared Search's parameters. Your Saved Search will be removed from the left sidebar of the Requests/Tasks pages.
Deleting a Saved Search from the Edit Saved Searches page cannot be undone.
Follow these steps to delete one of your own Saved Searches:
Click Confirm.
Click the Configure iconfor your Saved Search. The Configuration tab displays.
Select the Saved Search to configure. The Configuration tab displays. Use the Configuration tab to configure basic settings for your Saved Search.
Click the Columns tab. Use the Columns tab to customize how the Saved Search results display in tabular format from the Data tab. The Active Columns column displays the currently selected or default columns to present the Saved Search's search results in tabular format. The Available Columns column displays optional informational components to display the Saved Search's search results. These available options are based on ProcessMaker Platform's analysis of the Saved Search results.
From the Active Columns column, click the Remove iconfor the informational component not to display in the Saved Search's search results. The removed informational component moves to the bottom of the Available Columns column.
Click the Configuration iconfor the informational component placed from the Available Columns column. Note that columns that do not have the Configuration icon are default columns that cannot be configured, but only removed from the tabular data in search results.
The Configure screen for that informational component displays.
Use the Add Custom Column screen to add a custom column to include an informational component that ProcessMaker Platform's analysis of completed Requests for the Saved Search's selected Process did not provide. Click the Add Custom Column button at the bottom of the Available Columns column. The Create Custom Column screen displays.
Sort the informational components in the Active Columns column in the order that they are to display in the Saved Search's search results. To do so, click theicon for an informational component, drag it, and then place it into the order the column is to display in search results. Do not drag the information component to the Available Columns column, or it will no longer be included as a column that displays information in search results.
If it is necessary to reset the columns in your Saved Search to the default layout, click the Reset to Default button. Doing so displays the Reset to Default screen.
Click the Shared with Users tab.
Click the Shared with Groups tab.
To email a report of a data details, the must be installed.
in which to email its search results.
Click the Send Report button. The Email Report screen displays.
Receive a each time search results change based on your parameters. For example, suppose that you have a Saved Search for all in-progress for a particular , such as for a Purchase Request Process. Each time a Request starts for that Process, your Saved Search results change. If your Saved Search is configured to send notifications each time your Saved Search results change, you receive a notification.
If your Saved Search parameters include when a new is available, receive a notification.
If a record ID in a Collection changes, receive a notification. Note that the must be installed to use Collections.
Saved Search notifications can be or only for your own Saved Searches. Saved Searches by default send notifications when a Saved Search's results change.
To enable for a , the must be installed.
See the permission or ask your Administrator for assistance.
in which to enable notifications for its changed results.
Click the Enable Notifications buttonto enable notifications for this Saved Search.
To disable for a , the must be installed.
in which to disable notifications for its changed results.
Click the Disable Notifications buttonto disable notifications for this Saved Search.
To delete a , the must be installed.
Furthermore, for that Saved Search will no longer occur.
You may delete a Saved Search that you . Delete a Saved Search regardless of whether it is or .
. The Edit Saved Searches page displays.
Click the Delete icon for one of your Saved Searches. The Caution screen displays to confirm the deletion of the Saved Search.
Understand how ProcessMaker Platform schedules emailed reports of a Saved Search's results.
To schedule reports for a Saved Search's results, the Saved Searches package must be installed.
Schedule an interval in which to email reports of a Saved Search's search results. Multiple reports can be scheduled for the same Saved Search, thereby sending reports to different stakeholders in the search results at different intervals. For example, schedule to send your subordinates a daily report of a Saved Search's search results, but send executives a weekly report.
Only the user that created the Saved Search may configure report email scheduling.
Additionally to emailing a report once for the currently displayed search results, in a scheduled interval you may do the following:
Use an Email-type Screen instead of a manually entered email body.
Send a Microsoft Excel spreadsheet (.XLSX
file type) instead of a comma-separated values .CSV
) file.
Email recipients receive the Saved Search results as an attachment to the email. The email recipients for each scheduled report do not vary each time the report is sent. Separate multiple email recipients using commas. If you need to vary the email recipients for scheduled reports, create different schedules for each set of emailed recipients.
Pause or resume the scheduled interval to email reports of a Saved Search.
To schedule reports for a Saved Search's results, the Saved Searches package must be installed.
Only the user that created the Saved Search may pause report email scheduling.
Follow these steps to pause emailing scheduled reports of a Saved Search's search results:
View the scheduled intervals to email reports of a Saved Search's results. The Scheduled Reports page displays for that Saved Search.
Only the user that created the Saved Search may resume report email scheduling.
Follow these steps to resume emailing scheduled reports of a Saved Search's search results:
View the scheduled intervals to email reports of a Saved Search's results. The Scheduled Reports page displays for that Saved Search.
View all the schedules configured to email reports of a Saved Search.
To view the schedules to email reports of a Saved Search's results, the Saved Searches package must be installed.
Follow these steps to view the schedules to email reports of a Saved Search's results:
View the search results for a Saved Search in which to view its schedules to email reports.
The Scheduled Reports page displays the following information in tabular format about the intervals in which to email reports for this Saved Search:
Subject: The Subject column displays the email subject of the report. Email recipients see this setting in their email clients when they receive a report.
To: The To column displays the email address(es) for the email recipients of the report.
Scheduled: The Scheduled column displays the scheduled interval when to email reports.
Last Sent: The Last Sent column displays when the last report was emailed. If this scheduled interval has not emailed a report, this column displays Never Sent for this scheduled interval.
Click the Add Scheduled Report button. See Schedule an Interval to Email Reports.
If there are no scheduled reports, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Schedule an interval to regularly email reports of a Saved Search's results.
To schedule reports for a Saved Search's results, the Saved Searches package must be installed.
Only the user that created the Saved Search may configure report email scheduling.
Follow these steps to schedule an interval to email reports of a Saved Search's search results:
View the schedules to email reports of a Saved Search's results. The Scheduled Reports page displays for that Saved Search.
From the Day of the week setting, select the day of the week in which to email the report of the Saved Search's results. Only one day may be selected. If multiple days are required, then create another schedule that sends the report on a different day.
In the Time setting, enter the time in which to email the report.
In the Send To setting, enter the email address(es) for the email recipients to receive the report. Separate multiple email recipients using commas.
In the Email Subject setting, enter the email subject of your report to which the report will be attached.
From the Email Body option, do one of the following:
In the Email Body setting, enter the email body content for your report. Email recipients see this setting in their email clients when they receive a report.
From the File Format option, select one of the following options to specify the format of the emailed report that is attached to the email:
CSV: Select the CSV option to email the report in .CSV
format.
XLSX: Select the XLSX option to email the report in .XLSX
format.
Click Save.
Delete a schedule, thereby stopping a regular interval to email reports of a Saved Search's results.
Deleting a schedule stops the regular interval to email reports of that Saved Search's results. Deleting a schedule cannot be undone.
Only the user that created the Saved Search may delete report email scheduling.
Follow these steps to delete a scheduled interval to email reports of a Saved Search's search results:
Click Confirm.
Edit the scheduled interval to email reports of a Saved Search's results.
Only the user that created the Saved Search may edit report email scheduling.
Follow these steps to edit a scheduled interval to email reports of a Saved Search's search results:
Edit the following settings for the scheduled report as necessary:
From the Day of the week setting, select the day of the week in which to email the report of the Saved Search's results. Only one day may be selected. If multiple days are required, then create another schedule that sends the report on a different day.
In the Time setting, edit the time in which to email the report.
In the Send To setting, edit the email address(es) for the email recipients to receive the report. Separate multiple email recipients using commas.
In the Email Subject setting, edit the email subject of your report to which the report will be attached.
From the Email Body option, do one of the following:
In the Email Body setting, enter the email body content for your report.
From the File Format option, select one of the following options to specify the format of the emailed report that is attached to the email:
CSV: Select the CSV option to email the report in .CSV
format.
XLSX: Select the XLSX option to email the report in .XLSX
format.
Click Update.
See examples of the different chart types you can create for your Saved Searches.
Customize charts to include the series and/or categories from the both PMQL query parameters and the columns configured in the detailed data view of that Saved Search. For example, if your Saved Search included a custom column called Countries to display how many Requests have started based on a Request variable value called Countries
, that Request variable may also be used as a series or category in a chart in that Saved Search.
The Charts tab displays charts created for a Saved Search.
See the following sections:
See the following example chart as reference for the following terms ProcessMaker Platform uses in Saved Search charts:
Hover your cursor over a data point to see what that data represents.
Filter data that displays in a chart by hiding attributes of that data via the chart's legend. Consider the following chart that shows the number of Requests by status type per day of the week to visualize how many Requests exist for the "Account Process".
This chart contains three keys in the legend that displays at the top of the chart. Each key in the chart legend represents a data marker in the visualized chart data.
To not display the Requests that have an error, click the Error key in the chart's legend. The strike-through text style displays over the Error key in the chart legend that indicates this data marker is hidden from the chart. The other data markers in the chart automatically adjust to show their data points using the chart's current units of measurement. Click the Error key again from the legend to show this chart data marker again.
See the following Saved Search chart types:
The vertical-style bar chart visualizes Saved Search results in vertical bars. The following vertical-style bar chart shows the number of Requests by status per agency. In this example, data markers are stacked: data markers overlay on one another in the x- and y-axis such that all Request status types display on each other for each agency. Furthermore, this example displays the data marker represents when hovering the cursor over that marker.
The line chart visualizes Saved Search results as data points on a line to show how those results trend. The following line chart shows the number of Requests by status type per day of the week.
The pie chart visualizes Saved Search results as relational proportions between data. The following pie chart shows the number of Requests by status type for the Loan Process.
The list chart displays the raw data or a pivot table for a Saved Search.
The following list chart shows the raw data for Loan Requests.
When a List chart displays a pivot table for a Saved Search, click a column header to pivot how the Saved Search results display.
The following chart shows a pivot table of the number of started Requests by the day of the week for Account Openings.
Click the Pause iconfor the schedule to pause emailing reports at that interval.
Click the Unpause iconfor the schedule to resume emailing reports at that interval. The next report emails at its next scheduled interval.
Click the Scheduled Reports button. The Scheduled Reports page displays for that Saved Search.
Click the Pause iconto suspend the schedule of emailed reports for that Saved Search's results.
Click the Unpause iconto resume the schedule of emailed reports for that Saved Search's results. Note that this icon only displays if a schedule is paused.
Click the Edit icon. See Edit a Scheduled Interval to Email Reports.
Click the Delete icon. See Delete a Scheduled Interval to Email Reports.
Click the Add Scheduled Report button. The Schedule Report screen displays.
Select the Would you like to use a custom Email Screen? option. A drop-down menu displays from which you can select an Email-type Screen that will display its contents as the email body. Note that the Send Email package must be installed to have the Email-type Screen and send emails of scheduled reports.
To delete a scheduled interval to email reports of a results, the must be installed.
Use the Pause iconto suspend the schedule of emailed reports for that Saved Search's results. You may then click the Play iconto resume the schedule if necessary. This is an alternative from permanently deleting the schedule.
. The Scheduled Reports page displays for that Saved Search.
Click the Delete iconfor the schedule in which to delete. The Caution screen displays to confirm the deletion of the schedule.
To edit a scheduled interval to email reports of a results, the must be installed.
. The Scheduled Reports page displays for that Saved Search.
Click the Edit iconfor the schedule in which to edit. The Schedule Report screen displays.
Select the Would you like to use a custom Email Screen? option. A drop-down menu displays from which you can select an -type that will display its contents as the email body. Note that the must be installed to have the Email-type Screen and send emails of scheduled reports.
Charts help visualize your Saved Search results. Though you can , nothing distills that data like a customized chart. Create and configure two-dimensional charts to visualize Saved Search results after selecting a Saved Search. You may create customized charts regardless of whether you created the Saved Search or if it was shared with you.
Charts use the data results from the Saved Search to visualize those results in a variety of chart types and styles. Chart data may be filtered by using an optional query that further filters the data from that Saved Search to visualize minute data.
designers may also embed Saved Search charts into - and -type Screens using the .
Understand how ProcessMaker Platform defines components in a Saved Search chart. Note that Saved Search charts are visualizations of Saved Search results. The data and how that data presents in a Saved Search chart derive from the columns presented in the of that Saved Search.
A chart category optionally aggregates the chart by an additional measurement as indicated by the chart . The chart category represents the column from the Saved Search tabular data for applicable chart types. In the , the chart category additionally aggregates by Request status.
A data marker represents one visualization in the chart data. In the , two data markers are visible. Data markers can be stacked: data markers overlay on one another in the x- and y-axis. The data markers in the are not stacked.
A data point represents a point in a line chart's data that shows trending. Data points only apply to line charts. Each visible in the has four (4) data points.
A key is an item in the . Each key in the chart legend represents a in the visualized chart data. Keys that have strike-through text style are hidden in the visualized chart data. In the , there are three keys in the chart legend. The data marker for the Error-status Requests is hidden.
The chart legend identifies how the in the chart are represented. Chart legends may be displayed on the top, bottom, left, or right of the visualized data. In the , the chart legend is at the top of the chart.
The chart metric indicates the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. Aggregation is represented by the Y-axis for applicable chart types. In the , the chart metric is the Request ID as displayed in the # column of Saved Search detailed data view, and then aggregated by the sum of all Requests by status.
The chart series indicates how to group the Saved Search tabular-formatted results. The series groups the chart content by the units of measurement in the X-axis for applicable chart types. In the , the series is "how many Requests start by day of the week."
The horizontal-style bar chart visualizes Saved Search results in horizontal bars. The following horizontal-style bar chart shows the number of that start for the Account Process per day of the week.
The doughnut chart visualizes Saved Search results as relational proportions between data similar to the but with the inner portion removed. The following doughnut chart shows the number of Requests by status type for the Loan Process.
The count chart displays a single data metric on a canvas. The following count chart shows how many records are in the "Department" .
When a List chart displays the raw data for a Saved Search, the chart contents display similarly to the Saved Search results from which the chart is based. Click the Open Record iconto display the specific data in the list chart for that Saved Search.
View all the charts created for a Saved Search.
To view the charts created for a Saved Search's results, the Saved Searches package must be installed.
Follow these steps to view the charts for a type of Saved Search:
View the search results for a Saved Search in which to view its charts. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays a maximum of ten (10) charts created for this Saved Search. If there are no charts for this Saved Search, the following message displays: No Charts Created: Add a chart to visualize the data from your Saved Search results.
Edit a Saved Search chart that has been created.
Follow the steps below only to edit a horizontal bar, vertical bar, line, pie, or doughnut chart types. Settings for the count and list chart types vary from the steps described below. See the following sections for steps to edit their chart types:
Follow these steps to edit a horizontal bar, vertical bar, line, pie, or doughnut chart types for a Saved Search:
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Edit the following settings as necessary:
In the Name setting, edit the name of the chart. This is a required setting.
From the Chart Type group, select one of the following chart types to visualize the results of this Saved Search:
Bar (Horizontal) is the default chart type.
Click the Source tab to configure from which Saved Search's results to visualize in the chart. The Source tab settings vary depending on the chart type selected from the General tab.
Edit the following settings as necessary:
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
Click the Display tab to configure the appearance and style of the Saved Search chart. The Display tab settings vary depending on the chart type selected from the General tab.
This step shows the settings for the Horizontal Bar, Vertical Bar, Line, Pie, or Doughnut chart:
Edit the following settings as necessary:
From the Color Scheme setting, select the color palette from which to display the chart.
From the Legend setting, select where to place the legend in respect to the chart from the following options:
None: The chart legend does not display.
Top: The legend displays above the chart. This is the default option.
Bottom: The legend displays below the chart.
Left: The legend displays to the left of the chart.
Right: The legend displays to the right of the chart.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Saved Chart.
Follow these steps to edit a count chart type for a Saved Search:
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Edit the following settings as necessary:
In the Name setting, edit the name of the chart. This is a required setting.
Bar (Horizontal) is the default chart type.
Click the Source tab to configure from which Saved Search's results to visualize in the chart.
Edit the following settings as necessary:
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
Click the Display tab to configure the appearance and style of the Saved Search chart. The Display tab settings vary depending on the chart type selected from the General tab. This step shows the settings for the Count chart.
Edit the following settings as necessary:
From the Background Color setting, select a color as the background for the count chart canvas.
From the Icon setting, select an icon to display beside to the left of the count chart metric. The Line Chart icon is the default icon.
In the Label setting, optionally enter a label to describe the count chart metric instead of the metric's default label.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Saved Chart.
Follow these steps to edit a list chart type for a Saved Search:
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Edit the following settings as necessary:
In the Name setting, edit the name of the chart. This is a required setting.
From the Chart Type group, select the list chart type to visualize the results of this Saved Search.
Bar (Horizontal) is the default chart.
Click the Source tab to configure from which Saved Search's results to visualize in the chart. The Source tab settings vary depending on the chart type selected from the General tab.
Edit the following settings as necessary:
Enable the Select Pivot Table toggle key to edit a list chart from which any column header in the chart may be selected to sort the raw data.
The Select Pivot Table is disabled by default.
If the Select Pivot Table toggle key is enabled, the following settings display:
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
Click the Display tab to configure the appearance and style of the Saved Search chart.
This step shows the settings for the List chart.
Follow this step if the Select Pivot Table toggle key is enabled from the Source tab:
From the Background Color setting, select a color as the background for the list chart canvas.
Follow these steps if the Select Pivot Table toggle key is disabled from the Source tab:
From the Background Color setting, select a color as the background for the list chart canvas.
Enable the Make rows clickable toggle key to allow anywhere within a list chart row to redirect to the corresponding Request, Task or Collection record depending from which type of Saved Search the list chart derives its data. The Make rows clickable toggle key is disabled by default.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Saved Chart.
Create a chart based on the results of a Saved Search to visualize those results.
Follow the steps below only to create a horizontal bar, vertical bar, line, pie, or doughnut chart types. Settings for the count and list chart types vary from the steps described below.
See the following sections for steps to create their chart types:
Follow these steps to create a horizontal bar, vertical bar, line, pie, or doughnut chart types for a Saved Search:
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
In the Name setting, enter the name of the chart. This is a required setting.
From the Chart Type group, select one of the following chart types to visualize the results of this Saved Search:
Bar (Horizontal) is the default chart type.
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
From the Color Scheme setting, select the color palette from which to display the chart.
From the Legend setting, select where to place the legend in respect to the chart from the following options:
None: The chart legend does not display.
Top: The legend displays above the chart. This is the default option.
Bottom: The legend displays below the chart.
Left: The legend displays to the left of the chart.
Right: The legend displays to the right of the chart.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Created Chart.
Follow these steps to create a count chart type for a Saved Search:
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
In the Name setting, enter the name of the chart. This is a required setting.
Bar (Horizontal) is the default chart type.
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
Click the Display tab to configure the appearance and style of the Saved Search chart.
From the Background Color setting, select a color as the background for the count chart canvas.
From the Icon setting, select an icon to display beside to the left of the count chart metric. The Line Chart icon is the default icon.
In the Label setting, optionally enter a label to describe the count chart metric instead of the metric's default label.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Created Chart.
Follow these steps to create a list chart type for a Saved Search:
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
In the Name setting, enter the name of the chart. This is a required setting.
Bar (Horizontal) is the default chart type.
Enable the Select Pivot Table toggle key to create a list chart from which any column header in the chart may be selected to sort the raw data. The Select Pivot Table is disabled by default. If the Select Pivot Table toggle key is enabled, the following settings display:
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
Click the Display tab to configure the appearance and style of the Saved Search chart.
Follow this step if the Select Pivot Table toggle key is enabled from the Source tab:
Follow these steps if the Select Pivot Table toggle key is disabled from the Source tab:
From the Background Color setting, select a color as the background for the list chart canvas.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Created Chart.
To arrange the order of the charts created for a results, the must be installed.
in which to view its charts. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Hold theicon that displays to the left of the chart's title, and then drag that chart to the location on the Charts tab to display that chart.
To copy a chart, the must be installed.
in which to view its charts. The Data tab displays the data details for that Saved Search.
Click the Copy Chart iconfor the chart from which to make a copy. The copied chart uses the same name as the source chart with the word Copy appended to it.
To edit a chart, the must be installed.
in which to view its charts. The Data tab displays the data details for that Saved Search.
Click the Configure Chart icon. The General tab displays the current settings for the Saved Search chart.
Bar (Horizontal): The horizontal-style bar chart visualizes Saved Search results in horizontal bars. See .
Bar (Vertical): The vertical-style bar chart visualizes Saved Search results in vertical bars. See .
Line: The line chart visualizes Saved Search results as data points on a line to show how those results trend. See .
Pie: The pie chart visualizes Saved Search results as relational proportions between data. See .
Doughnut: The doughnut chart visualizes Saved Search results as relational proportions between data similarly to the pie chart type but with the inner portion removed. See .
Count: The count chart displays a single data metric on a canvas. See . If you select the Count chart option, see for its specific settings.
List: The list chart displays chart data in tabular format. See . If you select the List chart option, see for its specific settings.
This step shows the settings for the Horizontal Bar, Vertical Bar, Line, Pie, or Doughnut chart.
From the Series setting, select how to group the chart data. The groups the chart content by the units of measurement in the X-axis for applicable chart types. See . Options that display in the Series drop-down menu derive from the columns configured from the Saved Search tabular data as displayed from the Data tab of this Saved Search. The default configurable columns vary for each type of Saved Search. The Recommended indicator for Saved Search results represent dates, numbers, and/or unique text results and are recommended when configuring the chart series. This is a required setting for applicable charts.
From the Category setting, optionally select a secondary measurement by which to aggregate the chart series. See . The Category setting does not apply to count charts. Options and their recommendations that display in the Category setting are the same as those in the Series setting.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See .
In the Query setting, optionally enter a ProcessMaker Query Language () query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
Enable the Stacked toggle key to stack the chart's data markers: overlay the data markers one another in the x- and y-axis. See .
To edit a chart for a results, the must be installed.
in which to edit this chart type. The Data tab displays the data details for that Saved Search.
Click the Configure Chart icon. The General tab displays the current settings for the Saved Search chart.
From the Chart Type group, select the count chart type to visualize the results of this Saved Search. The Count chart displays a single data metric on a canvas. See .
If you select the Bar (Horizontal), Bar (Vertical), Line, Pie, Doughnut chart option, see procedure for its specific settings.
If you select the List chart option, see for its specific settings.
The Source tab settings vary depending on the chart type selected from the General tab. This step shows the settings for the Count chart.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See .
In the Query setting, optionally enter a ProcessMaker Query Language () query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
To edit a chart for a results, the must be installed.
in which to edit this chart type. The Data tab displays the data details for that Saved Search.
Click the Configure Chart icon. The General tab displays the current settings for the Saved Search chart.
If you select the Bar (Horizontal), Bar (Vertical), Line, Pie, Doughnut chart option, see procedure for its specific settings.
If you select the Count chart option, see for its specific settings.
This step shows the settings for the List chart.
From the Series setting, select how to group the chart data. The groups the chart content by the units of measurement in the X-axis for applicable chart types. See . The Series setting does not apply to count charts. Options that display in the Series drop-down menu derive from the columns configured from the Saved Search tabular data as displayed from the Data tab of this Saved Search. The default configurable columns vary for each type of Saved Search. The Recommended indicator for Saved Search results represent dates, numbers, and/or unique text results and are recommended when configuring the chart series. This is a required setting for applicable charts.
From the Category setting, optionally select a secondary measurement by which to aggregate the chart series. See . The Category setting does not apply to count charts. Options and their recommendations that display in the Category setting are the same as those in the Series setting.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See .
In the Query setting, optionally enter a ProcessMaker Query Language () query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
Enable the Display link toggle key to display a link that, when clicked, redirects to the corresponding Request, Task or Collection record depending from which type of Saved Search the list chart derives its data. The link displays as the Open Record iconat the end of each row. The Display link toggle key is enabled by default.
To create a chart for a results, the must be installed.
in which to create a chart. The Data tab displays the data details for that Saved Search.
Click the +Chart button. The Create Chart screen displays the General tab.
Bar (Horizontal): The horizontal-style bar chart visualizes Saved Search results in horizontal bars. See .
Bar (Vertical): The vertical-style bar chart visualizes Saved Search results in vertical bars. See .
Line: The line chart visualizes Saved Search results as data points on a line to show how those results trend. See .
Pie: The pie chart visualizes Saved Search results as relational proportions between data. See .
Doughnut: The doughnut chart visualizes Saved Search results as relational proportions between data similarly to the pie chart type but with the inner portion removed. See .
Count: The count chart displays a single data metric on a canvas. See . If you select the Count chart option, see for its specific settings.
List: The list chart displays chart data in tabular format. See . If you select the List chart option, see for its specific settings.
Click the Source tab to configure from which Saved Search's results to visualize in the chart.
From the Series setting, select how to group the chart data. The groups the chart content by the units of measurement in the X-axis for applicable chart types. See . Options that display in the Series drop-down menu derive from the columns configured from the Saved Search tabular data as displayed from the Data tab of this Saved Search. The default configurable columns vary for each type of Saved Search. The Recommended indicator for Saved Search results represent dates, numbers, and/or unique text results and are recommended when configuring the chart series. This is a required setting for applicable charts.
From the Category setting, optionally select a secondary measurement by which to aggregate the chart series. See . The Category setting does not apply to count charts. Options and their recommendations that display in the Category setting are the same as those in the Series setting.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See .
In the Query setting, optionally enter a ProcessMaker Query Language () query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
Click the Display tab to configure the appearance and style of the Saved Search chart.
Enable the Stacked toggle key to stack the chart's data markers: overlay the data markers one another in the x- and y-axis. See .
To create a chart for a results, the must be installed.
in which to create this chart type. The Data tab displays the data details for that Saved Search.
Click the +Chart button. The Create Chart screen displays the General tab.
From the Chart Type group, select the Count chart type to visualize the results of this Saved Search. The Count chart type displays a single data metric on a canvas. See .
If you select the Bar (Horizontal), Bar (Vertical), Line, Pie, or Doughnut options, see for their specific settings to create those chart types.
If you select the List chart option, see for its specific settings.
Click the Source tab to configure from which Saved Search's results to visualize in the chart.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See .
In the Query setting, optionally enter a ProcessMaker Query Language () query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
To create a chart for a results, the must be installed.
in which to create this chart type. The Data tab displays the data details for that Saved Search.
Click the +Chart button. The Create Chart screen displays the General tab.
From the Chart Type group, select the List chart type to visualize the results of this Saved Search. The List chart type displays chart data in tabular format. See .
If you select the Bar (Horizontal), Bar (Vertical), Line, Pie, or Doughnut options, see for their specific settings to create those chart types.
If you select the Count chart option, see for its specific settings.
Click the Source tab to configure from which Saved Search's results to visualize in the chart.
From the Series setting, select how to group the chart data. The groups the chart content by the units of measurement in the X-axis for applicable chart types. See . The Series setting does not apply to count charts. Options that display in the Series drop-down menu derive from the columns configured from the Saved Search tabular data as displayed from the Data tab of this Saved Search. The default configurable columns vary for each type of Saved Search. The Recommended indicator for Saved Search results represent dates, numbers, and/or unique text results and are recommended when configuring the chart series. This is a required setting for applicable charts.
From the Category setting, optionally select a secondary measurement by which to aggregate the chart series. See . The Category setting does not apply to count charts. Options and their recommendations that display in the Category setting are the same as those in the Series setting.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See .
In the Query setting, optionally enter a ProcessMaker Query Language () query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
From the Background Color setting, select a color as the background for the list chart canvas.
Enable the Display link toggle key to display a link that, when clicked, redirects to the corresponding Request, Task or Collection record depending from which type of Saved Search the list chart derives its data. The link displays as the Open Record iconat the end of each row. The Display link toggle key is enabled by default.
Enable the Make rows clickable toggle key to allow anywhere within a list chart row to redirect to the corresponding Request, Task or Collection record depending from which type of Saved Search the list chart derives its data. The Make rows clickable toggle key is disabled by default.
Delete a Saved Search chart.
To delete a Saved Search chart, the Saved Searches package must be installed.
Follow these steps to delete a Saved Search chart:
View the search results for a Saved Search in which to view its charts. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Click Confirm. The following message displays: The chart was deleted.
Click the Configure Chart icon. The General tab displays.
Click the Delete button. The Caution screen displays to confirm the deletion of the Saved Search chart.