ProcessMaker API Documentation
Script Central

Search for a Task

Search for any Task that has been assigned to you.

Overview

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

Basic Search for a Task

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

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

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

    If not, then click the Basic Search button.

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

    • Request: From the Request setting, select one or more Processes associated with a Request as part of the search criteria. Type into the Request setting to filter Processes associated with Requests 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.

    • Task: From the Task setting, select one or more Task names as part of the search criteria. Type into the Task setting to filter Tasks that display in that setting's drop-down menu. To remove a Task 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 Task 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 Tasks that are in progress or not started as part of your search criteria. Tasks that are in progress are included by default when searching for Tasks on the To Do page.

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

      • Self service: Include Tasks that you can assign to yourself, but have not yet been assigned. Self service Tasks are included by default when searching for Tasks on the Self Service page.

  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 Task search by clicking the Save Search button. See Save and Share Request- and Task-Related Searches.

View a Request Summary Associated with a Task

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

  • From the Request column, click the Request to view its summary.

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

Advanced Search for a Task

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

Basic Task 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 Task using PMQL:

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

  2. Ensure that the advanced search setting is displaying on the Tasks 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 PMQL Syntax for Tasks.

    Below is an example of a valid advanced Task search:

    (request = "Tax Return Process" OR request = "Modify Document Process") AND (task = "Customer Documents" OR task = "Loan Request") AND (status = "In Progress" OR status = "Completed") AND (data.last_name = "Canera") AND (updated_at < NOW -2 day)

  4. Click the Search buttonto search for Tasks 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 Task search by clicking the Save Search button. See Save and Share Request- and Task-Related Searches.

View a Request Summary Associated with a Task

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

  • From the Request column, click the Request to view its summary.

  • 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