ProcessMaker API Documentation
Script Central

View the Data Details of a Saved Search's Result

View the data details of a Saved Search's result in tabular format based on the type of Saved Search.

Overview

ProcessMaker Package Required

To view the data details for a Saved Search, the Saved Searches package must be installed in your ProcessMaker instance. The Saved Search package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Saved Search package can be installed in your ProcessMaker instance.

Optional ProcessMaker Package

You may also view the data details for a Saved Search associated with a ProcessMaker Collection. Use Saved Searches in ProcessMaker Collections to search for records in a Collection. To use ProcessMaker Collections, 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.

Regardless of whether you created 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 (PMQL) parameters configured in that Saved Search.

An image represents each Saved Search on the left sidebar, but only display on pages associated with its type. Saved Searches are organized by type:

  • Request-related Saved Searches are accessed from Requests pages.

  • Task-related Saved Searches are accessed from Tasks pages.

  • Saved Searches for ProcessMaker Collection records are accessed from the Collections page. (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. Lastly, 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.)

Columns that display in the tabular-formatted results for a Saved Search can be customized by the ProcessMaker user that created the Saved Search. See the following topics:

If a Saved Search has been shared with you, you may not change the type of information that displays in its results.

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

View Request-Type Saved Search Results

ProcessMaker Package Required

To view results for a Saved Search, the Saved Searches package must be installed in your ProcessMaker instance. The Saved Searches package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Saved Searches package can be installed in your ProcessMaker instance.

Saved Searches that pertain to Requests display on the following Requests pages:

An image represents each Saved Search on 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:

  1. Go to a Request-related page.

  2. Click the image that represents the Saved Search. The results for that Saved Search display.

Create charts of Saved Search results to visually analyze results.

View a Request Summary from Search Results

To view a Request summary from search results, 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 to view its summary.

Below are results for a Request-related Saved Search.

Results for a Request-related Saved Search

View Task-Type Saved Search Results

ProcessMaker Package Required

To view results for a Saved Search, the Saved Searches package must be installed in your ProcessMaker instance. The Saved Searches package is not available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how the Saved Searches package can be installed in your ProcessMaker instance.

Saved Searches that pertain to Tasks display on the following Tasks pages:

An image represents each Saved Search on 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:

  1. Go to a Task-related page.

  2. Click the image that represents the Saved Search. The results for that Saved Search display.

Create charts of Saved Search results to visually analyze results.

View a Task Summary from Search Results

To view a Task and its summary from search results, do one of the following:

  • From the Task column, click the Task name that you want to view.

  • Click the Open Task iconfor the Task name that you want to view.

Below are results for a Task-related Saved Search.

Search results for a Task-related Saved Search

View ProcessMaker Collection Record Saved Search Results

ProcessMaker Packages Required

To view search results for a Saved Search, the Saved Searches package must be installed in your ProcessMaker instance. Likewise, to create, share, or view Saved Searches for records in a ProcessMaker Collection, the Collections package must also be installed. Neither of these packages are available in the ProcessMaker open-source edition. Contact ProcessMaker Sales or ask your ProcessMaker sales representative how these packages 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.

Saved Searches that pertain to records in a ProcessMaker Collection display on the Collections page. An image represents each Saved Search on the left sidebar. Saved Search icons display above the icons to access ProcessMaker Collections.

Follow these steps to view results from a Saved Search pertaining to records in a ProcessMaker Collection:

  1. Click the Collections option from the top menu. The Collections page displays the ProcessMaker Collections that you are allowed to view.

  2. Click the image that represents the Saved Search. The results for that Saved Search display.

Create charts of Saved Search results to visually analyze results.

View a ProcessMaker Collection Record from Search Results

To view a ProcessMaker Collection record from search results, click the Edit iconfor the record you want to edit.

Below are results for a Saved Search related to records in a ProcessMaker Collection.

Search results related to ProcessMaker Collection records

View a Request Summary from Search Results

To view a Request summary from search results, 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 to view its summary.

View a Task Summary from Search Results

To view a Task and its summary from search results, do one of the following:

  • From the Task column, click the Task name that you want to view.

  • Click the Open Task iconfor the Task name that you want to view.

View a ProcessMaker Collection Record from Search Results

To view a ProcessMaker Collection record from search results, click the Edit iconfor the record you want to edit.

Search for a Saved Search's Search Result

Use the Search setting to filter the Saved Search's search results that display.

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

Display Information the Way You Want It

Control how tabular information displays, including how to sort columns or how many items display per page.

Related Topics