ProcessMaker API Documentation
Script Central

Search for a Request

Search for any Request in which you started or have been a participant.

Overview

Do basic or advanced searches for Requests. To do basic or advanced searches for Requests, view one of the following Requests pages:

Basic Search for a Request

Follow these steps to do a basic search for a Request:

  1. View one of the Requests pages described in the Overview of this topic.

  2. Ensure that the basic search settings are displaying on the Requests page you are viewing.

    If not, then click the Basic Search button.

  3. Use Request data to search for Requests based on the following criteria:

    • Process: From the Process field, select one or more Process names associated with a Request as part of the search criteria. Type into the Process setting to filter Processes that display in that setting's drop-down menu. To remove a Process that is currently selected, click theicon for that selection or click Enter when the drop-down is visible.

    • Status: From the Status setting, select one or more Request statuses as part of the search criteria. Type into the Status setting to filter statuses that display in that setting's drop-down menu. To remove a status that is currently selected, click theicon for that selection or click Enter when the drop-down is visible.

      Search using one or more of the following Request statuses:

      • In progress: Include Requests that are in progress as part of your search criteria. Requests that are in progress are included by default when searching for Requests on the In Progress page.

      • Completed: Include Requests that are completed as part of your search criteria. Requests that are completed are included by default when searching for Requests on the Completed page.

      • Error: Include Requests that are in error as part of your search criteria.

      • Canceled: Include Requests that have been canceled as part of your search criteria.

    • Requester: From the Requester setting, select one or more Requesters as part of your search criteria. A Requester is a ProcessMaker user who starts a Request. The currently logged on ProcessMaker user is included by default when searching for Requests on the My Requests page. Type into the Requester setting to filter requesters that display in that setting's drop-down menu. To remove a Requester that is currently selected, click theicon for that selection or click Enter when the drop-down is visible.

    • Participants: From the Participants setting, select one or more Request participants as part of your search criteria. Type into the Participants setting to filter Request participants that display in that setting's drop-down menu. To remove a Request participant that is currently selected, click theicon for that selection or click Enter when the drop-down is visible.

  4. Click the Search buttonto search for Requests based on your entered criteria.

  5. Optionally, if the Save Searches package is installed in your ProcessMaker instance, save and share the Request search by clicking the Save Search button. See Save and Share Request- and Task-Related Searches.

View a Request Summary

To view a Request summary, do one of the following:

  • 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.

  • Click the Open Request iconfor the Request that you want to view its summary.

Super-Charge Search: Save Searches and Share Them With Others

See Saved Searches.

No Search Results?

If there are no search results, the following message displays: No Data Available.

Advanced Search for a Request

Use the ProcessMaker Query Language (PMQL) to compose an advanced search for Requests.

Basic Request searches also use PMQL, but basic searches provide a user interface. Configure a basic search, and then click the Advanced Search buttonto see the PMQL. This may help you learn how to use PMQL.

Follow these guidelines to do an advanced search for a Request using PMQL:

  1. View one of the Requests pages described in the Overview of this topic.

  2. Ensure that the advanced search setting is displaying on the Requests page you are viewing.

    If not, then click the Advanced Search button.

  3. In the PMQL setting, enter your PMQL parameters that compose your advanced search. See Request Data Type PMQL Properties.

  4. Click the Search buttonto search for Requests based on your entered criteria. If there is no search criteria in the PMQL setting when the Search button is clicked, the following message displays: Search query is empty. Please add search attributes or PMQL before saving.

  5. Optionally, if the Save Searches package is installed in your ProcessMaker instance, save and share the Request search by clicking the Save Search button. See Save and Share Request- and Task-Related Searches.

View a Request Summary

To view a Request summary, do one of the following:

  • 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.

  • Click the Open Request iconfor the Request that you want to view its summary.

Super-Charge Search: Save Searches and Share Them With Others

See Save and Share Request- and Task-Related Searches.

No Search Results?

If there are no search results, the following message displays: No Data Available.

Related Topics