ProcessMaker API Documentation
Script Central

Search Records in a Collection

Use PMQL to filter all records in your ProcessMaker Collection to find that one you need.

Search Records in a ProcessMaker Collection

Use the Search function to filter all ProcessMaker Collections from the Collections page based on your entered text.

ProcessMaker Package Required

The Collections package must be installed in your ProcessMaker instance. The Collections package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Collections package can be installed in your ProcessMaker instance.

Permissions Required

Your ProcessMaker user account or group membership must have the "Collections: View Collections" permission to view the list of ProcessMaker Collections unless your user account has the Make this user a Super Admin setting selected. See the ProcessMaker Collections permissions or ask your ProcessMaker Administrator for assistance.

Furthermore, your ProcessMaker 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 ProcessMaker Collection for assistance.

Follow these steps to search records in a ProcessMaker Collection:

  1. ‚ÄčView the records for the ProcessMaker Collection that you want to search.

  2. In the PMQL field, enter your ProcessMaker Query Language (PMQL) parameters that compose your record search. See PMQL Syntax for ProcessMaker Collections.

    Below is an example of a valid record search:

    (request = "Process Name 1" OR request = "Process Name 2") AND (status = "Canceled" OR status = "Error") AND (requester = "Username1" OR requester = "Username2") AND (participant = "Username3" OR participant = "Username4" AND (data.last_name= "Canera") AND (updated_at < NOW -2 day)

  3. Click the Search buttonto search the ProcessMaker Collection's records based on your entered criteria. If there is no search criteria in the PMQL field when the Search button is clicked, the following message displays: Search query is empty. Please add search attributes or PMQL before saving.

  4. Optionally, if the Save Searches package is installed in your ProcessMaker instance, save and share the record search by clicking the Save Search button. See Save and Share a Record Search.

Related Topics