ProcessMaker API Documentation
ProcessMaker Examples

Search Records in a Collection

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

Search Records in a Collection

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

ProcessMaker Package Required

The Collections package must be installed.

Permissions Required

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.

Furthermore, 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.

Follow these steps to search records in a Collection:

  1. View the records for the Collection that you want to search.

  2. In the PMQL field, enter your ProcessMaker Query Language (PMQL) parameters that compose your record search. See Collection Data Type PMQL Properties.

  3. Click the Search buttonto search the 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, save and share the record search by clicking the Save Search button. See Save and Share a Record Search.

Related Topics