Loading...
Loading...
Use the search results for a Saved Search, send or schedule reports of those search results, or enable notifications of changes to search results.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Schedule an interval in which to email stakeholders reports for a Saved Search's results.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Create charts of Saved Searches to visualize search results in a variety of types and styles.
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Save and share search parameters related to Requests, Tasks and Collections.
View Saved Searches that have been shared with you for a specific type of Saved Search.
To view Saved Searches shared with you, the Saved Searches package must be installed.
Follow these steps to view Saved Searches shared with you for a specific type of Saved Search:
Click the Shared with Me tab. Saved Searches shared with you display.
The Shared With Me tab displays the following information in tabular format about Saved Searches that have been shared with you for that Saved Search type:
Name: The Name column displays the name of the Saved Search. The icon beside the Saved Search's name displays from the left sidebar for that Saved Search's type. For example, the icons that display in the image above display in Request-related pages.
Created By: The Created By column displays the user's avatar who created the Saved Search. Hover your cursor over the user's avatar to view that person's full name.
Modified: The Modified column displays the date and time the Saved Search was last modified by the user that created the Saved Search. A Saved Search can only be modified by the user that created it. The time zone setting to display the time is according to the ProcessMaker Platform Platform instance unless your user profile's Time zone setting is specified.
Created: The Created column displays the date and time the Saved Search was created. The time zone setting to display the time is according to the ProcessMaker instance unless your user profile's Time zone setting is specified.
Use the Search field to filter Saved Searches that display.
If there are no Saved Searches, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Click the Edit Saved Searches iconfrom the left sidebar of pages associated with that Saved Search type. The My Saved Searches tab of the Edit Saved Searches page displays your Saved Searches associated by its specific type.
Filter all the Saved Search's results to find its data details.
Use the Search function to filter all the results for a Saved Search.
Use ProcessMaker Query Language (PMQL) for the most accurate means by which to locate specific Requests.
To search for a Saved Search, the Saved Searches package must be installed.
Follow these steps to search for a Saved Search's result:
Enter in the Search setting the text to filter Saved Searches using the Saved Search's name that displays in the Name column.
As you enter text into the Search field, search results display that match your entered text.
If there are no search results, the following message displays: No Data Available.
Email stakeholders in your Saved Search's data details as a report.
To email a report of a Saved Search data details, the Saved Searches package must be installed.
Email a report of the currently displayed search results for a Saved Search to one or more email recipients. In doing so, those search results are emailed as a comma-separated values (.CSV
) file that can be opened in a spreadsheet editor. Email recipients receive the Saved Search results as an attachment to the email. Separate multiple email recipients using commas.
Follow these steps to email a report of search results for a Saved Search:
View the search results for a Saved Search in which to email its search results.
In the Send to setting, enter the email address(es) for the email recipients to receive the report. Separate multiple email recipients using commas.
In the Email Subject setting, enter the email subject of your report to which the report will be attached.
In the Email Body setting, enter the email body content for your report.
From the File Format setting, select which file format to email the report:
CSV: Email the report as a comma-separated value (CSV) file.
XLSX: Email the report as a Microsoft Excel open XML format spreadsheet.
Click Send. Email recipients receive the Saved Search results as an attachment to the email.
Click the Send Report button. The Email Report screen displays.
Delete a Saved Search that you no longer use or want to share with others.
To delete a Saved Search, the Saved Searches package must be installed.
When deleting a Shared Search, it is no longer shared with those users and/or groups with which you have shared them. The recipients of your shared Saved Search will no longer be able to use it to quickly view search results using your Shared Search's parameters. Your Saved Search will be removed from the left sidebar of the Requests/Tasks pages.
Furthermore, scheduled email reports for that Saved Search will no longer occur.
Deleting a Saved Search from the Edit Saved Searches page cannot be undone.
You may delete a Saved Search that you created. Delete a Saved Search regardless of whether it is visible or hidden.
Follow these steps to delete one of your own Saved Searches:
View the Shared Searches for a specific Saved Search type. The Edit Saved Searches page displays.
Click Confirm.
Click the Delete icon for one of your Saved Searches. The Caution screen displays to confirm the deletion of the Saved Search.
Edit the scheduled interval to email reports of a Saved Search's results.
To edit a scheduled interval to email reports of a Saved Search's results, the Saved Searches package must be installed.
Only the user that created the Saved Search may edit report email scheduling.
Follow these steps to edit a scheduled interval to email reports of a Saved Search's search results:
View the scheduled intervals to email reports of a Saved Search's results. The Scheduled Reports page displays for that Saved Search.
Edit the following settings for the scheduled report as necessary:
From the Day of the week setting, select the day of the week in which to email the report of the Saved Search's results. Only one day may be selected. If multiple days are required, then create another schedule that sends the report on a different day.
In the Time setting, edit the time in which to email the report.
In the Send To setting, edit the email address(es) for the email recipients to receive the report. Separate multiple email recipients using commas.
In the Email Subject setting, edit the email subject of your report to which the report will be attached.
From the Email Body option, do one of the following:
In the Email Body setting, enter the email body content for your report.
From the File Format option, select one of the following options to specify the format of the emailed report that is attached to the email:
CSV: Select the CSV option to email the report in .CSV
format.
XLSX: Select the XLSX option to email the report in .XLSX
format.
Click Update.
Click the Edit iconfor the schedule in which to edit. The Schedule Report screen displays.
Select the Would you like to use a custom Email Screen? option. A drop-down menu displays from which you can select an Email-type Screen that will display its contents as the email body. Note that the Send Email package must be installed to have the Email-type Screen and send emails of scheduled reports.
Delete a schedule, thereby stopping a regular interval to email reports of a Saved Search's results.
To delete a scheduled interval to email reports of a Saved Search's results, the Saved Searches package must be installed.
Deleting a schedule stops the regular interval to email reports of that Saved Search's results. Deleting a schedule cannot be undone.
Only the user that created the Saved Search may delete report email scheduling.
Follow these steps to delete a scheduled interval to email reports of a Saved Search's search results:
View the schedules to email reports of a Saved Search's results. The Scheduled Reports page displays for that Saved Search.
Click Confirm.
Use the Pause iconto suspend the schedule of emailed reports for that Saved Search's results. You may then click the Play iconto resume the schedule if necessary. This is an alternative from permanently deleting the schedule.
Click the Delete iconfor the schedule in which to delete. The Caution screen displays to confirm the deletion of the schedule.
View all the charts created for a Saved Search.
To view the charts created for a Saved Search's results, the Saved Searches package must be installed.
Follow these steps to view the charts for a type of Saved Search:
View the search results for a Saved Search in which to view its charts. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays a maximum of ten (10) charts created for this Saved Search. If there are no charts for this Saved Search, the following message displays: No Charts Created: Add a chart to visualize the data from your Saved Search results.
Arrange the order that multiple Saved Search charts display in the Charts tab of a Saved Search.
To arrange the order of the charts created for a Saved Search's results, the Saved Searches package must be installed.
Follow these steps to arrange the order of the charts of a Saved Search:
View the search results for a Saved Search in which to view its charts. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Hold theicon that displays to the left of the chart's title, and then drag that chart to the location on the Charts tab to display that chart.
Delete a Saved Search chart.
To delete a Saved Search chart, the Saved Searches package must be installed.
Follow these steps to delete a Saved Search chart:
View the search results for a Saved Search in which to view its charts. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Click Confirm. The following message displays: The chart was deleted.
Click the Configure Chart icon. The General tab displays.
Click the Delete button. The Caution screen displays to confirm the deletion of the Saved Search chart.
View the data details of a Saved Search's result in tabular format based on the type of Saved Search.
To view the data details for a Saved Search, the Saved Searches package must be installed.
You may also view the data details for a Saved Search associated with a Collection. Use Saved Searches in Collections to search for records in a Collection. To use Collections, the Collections package must be installed.
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 from 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.
Columns that display in the tabular-formatted results for a Saved Search can be customized by the 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.
While viewing a Saved Search, use the Search function to locate data in that Saved Search. Locate data using the following methods:
Perform a PMQL query based on a Request-, Task- or Collection-type Saved Search.
Perform a plain-text search for data in that Saved Search.
To view results for a Saved Search, the Saved Searches package must be installed.
Saved Searches that pertain to Requests display on the following Requests pages:
My Requests page. See View Your Requests That You Started.
In Progress page. See View Requests That Are In Progress.
Completed page. See View Completed Requests.
All Requests page. See View All Requests. (Note that your user account must have the Requests: View All Requests permission to view the All Requests page.)
An image represents each Saved Search from 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:
Go to a Request-related page.
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.
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.
Below are results for a Request-related Saved Search.
To view results for a Saved Search, the Saved Searches package must be installed.
Saved Searches that pertain to Tasks display on the following Tasks pages:
To Do page. See View Tasks You Need to Do.
Completed page. See View Completed Tasks.
Self Service page.
An image represents each Saved Search from 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:
Go to a Task-related page.
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.
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.
Below are results for a Task-related Saved Search.
To view search results for a Saved Search, the Saved Searches package must be installed. Likewise, to create, share, or view Saved Searches for records in a Collection, the Collections package must also be installed.
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 view results from a Saved Search pertaining to records in a Collection:
Ensure that you are logged on to ProcessMaker Platform.
Click the Admin option from the top menu. The Users page displays.
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.
Below are results for a Saved Search related to records in a Collection.
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.
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.
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.
Control how tabular information displays, including how to sort columns or how many items display per page.
Understand what the Saved Search package does in ProcessMaker Platform.
The Saved Searches package must be installed to use Saved Searches.
Use the Saved Searches package to save and share search parameters associated with Requests, Tasks and Collections. In doing so, you manage the search parameters for your Saved Searches. You may share your own Saved Searches with other users and/or groups. Recipients of your shared Saved Searches can only use your Saved Search to view its search results, but cannot modify your Saved Searches' parameter settings you configured. The name for a Saved Search does not need to be unique. Therefore, multiple Saved Searches may have the same name when your own Saved Search and one shared with you have the same name.
Similar to advanced Request searches, advanced Task searches, and Collection record searches, filter the data that for a Saved Search using ProcessMaker Query Language (PMQL).
You may schedule a regular interval in which to email reports for either your own Saved Searches or those shared with you.
Saved Searches are available to all users in the organization on the following pages when the Saved Search package is installed in that ProcessMaker Platform instance:
Request-related pages
Task-related pages
By default, Saved Searches do not display the number of items that correspond to each Saved Search when viewing the names of Saved Seaches from the left sidebar. If your ProcessMaker Platform instance requires the number of Saved Search items display, submit a Support ticket.
Saved Searches have the following attributes regarding configuring and sharing Saved Searches:
Schedule to email reports of your Saved Search results: You may create one or more schedules to email reports for the search results for one of your own Saved Searches. Each schedule can email the report in .CSV
or .XLSX
format.
Hide Saved Searches: You may hide your own Saved Searches. Hiding a Saved Search only hides that Saved Search from the left sidebar of your Request- and Task-related pages. Shared recipients of that Saved Search may still use it to view search results using your Saved Search's parameters.
Delete Saved Searches: You may delete your Saved Searches. However, in doing so, they are no longer shared with those users and/or groups with which you have shared them. The recipients of your shared Saved Search will no longer be able to use it to quickly view search results using your Shared Search's parameters.
Request-related Saved Searches: Saved Searches associated with Requests display only in the left sidebar of Request-related pages.
Task-related Saved Searches: Saved Searches associated with Tasks display only in the left sidebar of Task-related pages.
Collection-related Saved Searches: Saved Searches associated with Collections display on the left sidebar of Collection pages. Note that the Collections package must be installed for Collections to be available.
Charts help visualize your Saved Search results. Though you can customize in tabular format the data details for your Saved Searches, nothing distills that data like a customized chart. Create and configure two-dimensional charts to visualize Saved Search results after selecting a Saved Search. You may create customized charts regardless of whether you created the Saved Search or if it was shared with you.
Charts use the data results from the Saved Search to visualize those results in a variety of chart types and styles. Chart data may be filtered by using an optional PMQL query that further filters the data from that Saved Search to visualize minute data.
The Charts tab displays charts created for a Saved Search.
Screen designers may also embed Saved Search charts into Form- and Display-type Screens using the Saved Search Chart control.
Configure the following types of Saved Search charts:
Bar (horizontal or vertical): Visualize Saved Search results in horizontal or vertical bars.
Line: Visualize Saved Search results as data points on a line to show how those results trend.
Pie: Visualize Saved Search results as relational proportions between data.
Doughnut: Visualize Saved Search results similar to the pie chart style but with the inner portion removed.
Count: Display a single data metric on a canvas.
See Create Charts to Visualize Saved Search Results.
Show or hide your own Saved Searches from displaying in the left sidebar of Request- and Task-related pages.
Hiding a Saved Search only hides it from the left sidebar for its specific Saved Search type. For example, toggling visibility of a Request-related Saved Search only affects the left sidebar on Request-related pages. Shared recipients of a Saved Search may still use that Saved Search to view search results.
Showing a Saved Search only hides it from the left sidebar for its specific Saved Search type. For example, toggling visibility of a Request-related Saved Search only affects the left sidebar on Request-related pages. Shared recipients of a Saved Search may still use that Saved Search to view search results.
Follow these steps to show one of your hidden Saved Searches:
You may hide only one of your own Saved Searches. Hiding a Saved Search only hides it from the left sidebar for its specific Saved Search type. For example, toggling visibility of a Request-related Saved Search only affects the left sidebar on Request-related pages. Shared recipients of a Saved Search may still use that Saved Search to view search results.
Follow these steps to hide one of your own Saved Searches:
Understand how ProcessMaker Platform schedules emailed reports of a Saved Search's results.
Schedule an interval in which to email reports of a Saved Search's search results. Multiple reports can be scheduled for the same Saved Search, thereby sending reports to different stakeholders in the search results at different intervals. For example, schedule to send your subordinates a daily report of a Saved Search's search results, but send executives a weekly report.
Only the user that created the Saved Search may configure report email scheduling.
Additionally to emailing a report once for the currently displayed search results, in a scheduled interval you may do the following:
Send a Microsoft Excel spreadsheet (.XLSX
file type) instead of a comma-separated values .CSV
) file.
Email recipients receive the Saved Search results as an attachment to the email. The email recipients for each scheduled report do not vary each time the report is sent. Separate multiple email recipients using commas. If you need to vary the email recipients for scheduled reports, create different schedules for each set of emailed recipients.
Create and share a Saved Search with users and/or groups so that they can take advantage of your search parameters.
Follow these steps to create and share a Saved Search:
In the Name setting, enter the name of your Saved Search. Since this name displays from the left sidebar of the Requests/Tasks/Collections pages, ensure that this is a descriptive name based on the PMQL parameters that compose the search. This name is helpful for yourself and those with whom you share this Saved Search to know for what this Saved Search's results are. The Saved Search name does not need to be unique. Therefore, multiple Saved Searches may have the same name when your own Saved Search and one shared with you have the same name. This is a required setting.
Follow these guidelines to select an image that represents the Saved Search results. Saved Searches associated with Requests display from the left sidebar of Requests pages. Saved Searches associated with Tasks display from the left sidebar of Tasks pages. Saved Searches associated with Collection records display from the left sidebar of Collections pages.
Follow these steps to select an image that ProcessMaker Platform provides to represent the Saved Search:
Click the Search drop-down menu.
Select the image to represent your Saved Search.
Follow these steps to select a custom image to represent the Saved Search:
Locate the icon to represent your Saved Search. The icon must not be larger than two (2) kilobytes or the following message displays below the Search setting: The custom icon file is too large. File size must be less than 2KB..
Click the Save button.
Saved Searches for Collection records are accessed from the Collections sidebar iconin the Admin top menu option. (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. Lastly, 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.)
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 from 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.
Click the Open Request iconfor the Request to view its summary.
Click the Open Task iconfor the Task name that you want to view.
Saved Searches that pertain to records in a Collection display from the Collections iconin the left sidebar after selecting the Admin top menu option. An image represents each Saved Search from the left sidebar. Saved Search icons display above the icons to access Collections.
Click the Collections iconfrom the left sidebar. The Collections page displays the Collections that you are allowed to view.
To view a Collection record from search results, click the Edit iconfor the record you want to edit.
Click the Open Request iconfor the Request to view its summary.
Click the Open Task iconfor the Task name that you want to view.
To view a Collection record from search results, click the Edit iconfor the record you want to edit.
Click the Edit Saved Searches iconfrom the left sidebar in any of the Requests, Tasks, or Collections pages to view the Edit Saved Searches page. The Edit Saved Searches page displays both your own Saved Searches as well as those that others have shared with you for that search type. For example, clicking the Edit Saved Searches icon from the left sidebar of any of the Requests pages only displays Request-type Saved Searches. See Manage Your Own Saved Searches.
An icon represents each Saved Search that the user selects when creating the Saved Search. Saved Searches display above the My Saved Searches icon. Click the Expand sidebar iconat the bottom of the left sidebar on any of the Requests, Tasks, or Collections pages to view the names for each Saved Search. Click the Collapse sidebar icon to hide the Saved Search names.
To hide or show , the must be installed.
You may show or hide your own Saved Searches. However, you cannot show or hide Saved Searches which have been shared with you. You can only control visibility of Saved Searches that you have .
Visible Saved Searches display above the Edit Saved Searches icon.
. The Edit Saved Searches page displays.
Click the Show Saved Search icon for the hidden Saved Search. The Saved Search is visible from the left sidebar for that type of Saved Search, indicated by full visibility of that Saved Search in the Edit Saved Searches page.
. The Edit Saved Searches page displays.
Click the Hide Saved Search icon for one of your Saved Searches. The Saved Search is hidden, indicated by diminished visibility of that Saved Search in the Edit Saved Searches page.
To schedule reports for a results, the must be installed.
Use an instead of a manually entered email body.
To create and share , the must be installed.
You may also create and share Saved Searches when using . Use Saved Searches in Collections to search for records in a Collection. To use Collections, the must be installed.
If you are saving record searches from a Collection, 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 permissions or ask your Administrator for assistance.
Furthermore, your user account or group membership must have the View from a Collection's configuration to view that Collection's records. See or ask the manager of that Collection for assistance.
Enter the advanced search criteria using ProcessMaker Query Language () parameters for your , , or record search. It is this criteria from which the Saved Search settings are based. See the following topics for how to compose PMQL search parameters in an advanced search:
Click the Save Search button. The Save Search screen displays.
Click the Upload Custom Icon icon.
From the Share With Users drop-down menu, select with which to share your Saved Search by selecting the person's full name. Multiple users may be added, one at a time, to this setting. You may click the Remove iconfor a user to remove that user from the Share With Users drop-down menu. These selected users will see your Saved Search with the image you selected from the left sidebar for pages associated with its search type.
From the Share With Groups drop-down menu, select with which to share your Saved Search by selecting the group. Multiple groups may be added, one at a time, to this setting. You may click the Remove iconfor a group to remove that group from the Share With Groups drop-down menu. Members of a group added to the Share With Groups drop-down menu will see your Saved Search from the left sidebar for pages associated with its search type with the image you selected.
Manage your own Saved Searches for each specific type of Saved Search.
Saved Searches are organized by their type:
Request-related Saved Searches are accessed from Requests pages. These Saved Searches are available to all users when the Saved Searches package is installed. See View Request-Type Saved Search Results.
Task-related Saved Searches are accessed from Tasks pages. These Saved Searches are available to all users when the Saved Searches package is installed. See View Task-Type Saved Search Results.
Saved Searches for Collection records are accessed from the Collections page. (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. Lastly, 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.) See View Collection Record Saved Search Results.
To manage your own Saved Searches, the Saved Searches package must be installed.
You can view and manage your own Saved Searches that you have created. A Saved Search can only be managed by the user that creates it unless that user has the Make this user a Super Admin setting enabled for that user account; see Manage Saved Searches. This setting is generally reserved for Administrators and is not available to most users.
To quickly configure a specific Saved Search that you have created, follow these steps:
Click the image from the left sidebar that represents your own Saved Search. Though Saved Searches shared with you also display from the left sidebar, you cannot configure these Saved Searches. The search results for that Saved Search displays.
The Edit Saved Searches page displays the following information in tabular format about your Saved Searches and those which have been shared with you for that Saved Search type:
Name: The Name column displays the name of the Saved Search. The icon beside the Saved Search's name displays from the left sidebar for that Saved Search's type. For example, the icons that display in the image above display in Request-related pages.
Created By: The Created By column displays the user's avatar who created the Saved Search. Hover your cursor over the user's avatar to view that person's full name.
Modified: The Modified column displays the date and time the Saved Search was last modified by the user that created the Saved Search. A Saved Search can only be modified by the user that created it. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Created: The Created column displays the date and time the Saved Search was created. The time zone setting to display the time is according to the ProcessMaker Platform instance unless your user profile's Time zone setting is specified.
Use the Search field to filter Saved Searches that display.
If there are no Saved Searches, the following message displays: No Data Available.
Control how tabular information displays, including how to sort columns or how many items display per page.
Configure one of your own Saved Searches.
To configure a Saved Search, the Saved Searches package must be installed.
You may configure only one of your own Saved Searches, not one which has been shared with you. Configure a Saved Search regardless of whether it is visible or hidden.
Follow these steps to select the Saved Search to configure:
View the Shared Searches for a specific Saved Search type. The Edit Saved Searches page displays.
Refer to the following sections to configure your Saved Search. These configuration sections may be configured independently of one another:
Follow these steps to configure basic settings for your Saved Search:
Edit the following information in the Configuration tab about your Saved Search as necessary:
Name: In the Name setting, edit the name of your Saved Search. Since this name displays from the left sidebar of Requests/Tasks pages, ensure that this is a descriptive name based on the ProcessMaker Query Language (PMQL) parameters that compose the search. This name is helpful for yourself and those with whom you share this Saved Search to know for what this Saved Search's results are. This is a required setting.
Image: Follow these guidelines to select an image that represents the Saved Search results. Saved Searches associated with Requests display from the left sidebar of Requests pages, while those associated with Tasks display from the left sidebar of Tasks pages.
Select an image from ProcessMaker Platform to represent the Saved Search:
Click the Icon drop-down menu.
Select any of the images that ProcessMaker Platform provides.
Select a custom image to represent the Saved Search:
Click the Upload Custom Icon button to the right of the Icon drop-down menu. The file browser window displays.
Locate the icon on your local computer or network to represent the Saved Search. The icon must not be larger than 2 kilobytes large or the following message displays below the Choose File button: The file is too large. File size must be less than 2KB when base64 encoded..
PMQL: In the PMQL setting, edit the ProcessMaker Query Language (PMQL) parameters if necessary. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
Click Save.
Follow these steps to configure how information displays for your Saved Search:
Select the Saved Search to configure. The Configuration tab displays.
Note the following when configuring how Saved Search results display in tabular format:
The informational components in the Active Columns column display in the order that these informational components display in tabular format. Informational components at the top of the Active Columns column display left-most in the column order; components at the bottom of the Active Columns column display right-most in the column order.
It may be helpful to understand how ProcessMaker Platform analyzes completed Request data for Request-type Saved Searches. To derive that Request information, view the Data tab in the summary for a completed Request to view the data from a completed Request. The key names (represented in red-colored text) represent Request data. Note that your user account or group membership must have the Requests: Edit Request Data permission. Ask your Administrator if you do not see the Data tab in completed Request summaries.
The columns as configured in the Active Columns column determine how Saved Search results can be visualized in charts: these columns are options when configuring the chart series, category, and metric settings for a chart. Active columns in a Saved Search's results that represent dates, numbers, and/or unique text results are recommended as settings when configuring a Saved Search chart.
Follow these guidelines to select which column(s) display information in the Saved Search results:
Remove a column that displays information in the Saved Search results:
Add and configure a column that displays information in the Saved Search results:
Drag the informational component from the Available Columns column to the Active Columns column, and then place the informational component in the order from top-to-bottom that you want that informational component to display in search results. Informational components at the top of the Active Columns column display left-most in the column order; components at the bottom of the Active Columns column display right-most in the column order.
Informational components that are not defaults can be configured to display a label and what the informational component represents.
Configure how a column displays information in the Saved Search results:
In the Label setting, edit the column label that displays in search results (if necessary).
In the Field setting, edit the key name that represents the Request data (if necessary). data.
represents that what follows derives from Request information. To derive that Request information if it is necessary to change the Field setting value, view the Data tab in the summary for a completed Request to view the data from a completed Request, and then use the specific key name (represented in red-colored text) in the following syntax, where RequestData
represents the key name: data.RequestData
. Note that your user account or group membership must have the Requests: Edit Request Data permission. Ask your Administrator if you do not see the Data tab in completed Requests.
Use the Sortable toggle key to adjust whether the column can be sorted in search results.
Click Save.
Add a custom column to include additional information in the Save Search results:
In the Label setting, enter the column label that displays in search results.
In the Field setting, enter the key name that represents the Request data. data.
represents that what follows derives from Request information. To derive that Request information, view the Data tab in the summary for a completed Request to view the data from a completed Request, and then use the specific key name (represented in red-colored text) in the following syntax, where RequestData
represents the key name: data.RequestData
. Note that your user account or group membership must have the Requests: Edit Request Data permission. Ask your Administrator if you do not see the Data tab in completed Requests.
Use the Sortable toggle key to adjust whether the column can be sorted in search results.
Click Save.
Sort the order that columns display in Save Search results:
Reset the columns in the Saved Search to the default layout:
Click Confirm.
Click Save after you configure all your Saved Search settings.
Follow these steps to configure with which users to share your Saved Search:
Select the Saved Search to configure. The Configuration tab displays.
Follow these guidelines to select with which users to share your Saved Search:
Adjust the toggle key for each user that you want to share your Saved Search. When the toggle key is enabled, that user can use your Saved Search, but cannot configure, hide, or delete it.
Enter in the Search setting the text to filter users by their full name.
Click Save.
Follow these steps to configure with which groups to share your Saved Search:
Select the Saved Search to configure. The Configuration tab displays.
Follow these guidelines to select with which groups to share your Saved Search:
Adjust the toggle key for each user that you want to share your Saved Search. When the toggle key is enabled, all members of that group can use your Saved Search, but none can configure, hide, or delete it.
Enter in the Search setting the text to filter groups.
Click Save.
Schedule an interval to regularly email reports of a Saved Search's results.
Only the user that created the Saved Search may configure report email scheduling.
Follow these steps to schedule an interval to email reports of a Saved Search's search results:
From the Day of the week setting, select the day of the week in which to email the report of the Saved Search's results. Only one day may be selected. If multiple days are required, then create another schedule that sends the report on a different day.
In the Time setting, enter the time in which to email the report.
In the Send To setting, enter the email address(es) for the email recipients to receive the report. Separate multiple email recipients using commas.
In the Email Subject setting, enter the email subject of your report to which the report will be attached.
From the Email Body option, do one of the following:
In the Email Body setting, enter the email body content for your report. Email recipients see this setting in their email clients when they receive a report.
From the File Format option, select one of the following options to specify the format of the emailed report that is attached to the email:
CSV: Select the CSV option to email the report in .CSV
format.
XLSX: Select the XLSX option to email the report in .XLSX
format.
Click Save.
Pause or resume the scheduled interval to email reports of a Saved Search.
Only the user that created the Saved Search may pause report email scheduling.
Follow these steps to pause emailing scheduled reports of a Saved Search's search results:
Only the user that created the Saved Search may resume report email scheduling.
Follow these steps to resume emailing scheduled reports of a Saved Search's search results:
View all the schedules configured to email reports of a Saved Search.
Follow these steps to view the schedules to email reports of a Saved Search's results:
The Scheduled Reports page displays the following information in tabular format about the intervals in which to email reports for this Saved Search:
Subject: The Subject column displays the email subject of the report. Email recipients see this setting in their email clients when they receive a report.
To: The To column displays the email address(es) for the email recipients of the report.
Scheduled: The Scheduled column displays the scheduled interval when to email reports.
Last Sent: The Last Sent column displays when the last report was emailed. If this scheduled interval has not emailed a report, this column displays Never Sent for this scheduled interval.
Receive notifications when a Saved Search's results change.
Below are other examples to receive a notification when the Saved Search results change:
Saved Search notifications can be enabled only for your own Saved Searches. Saved Searches by default send notifications when a Saved Search's results change.
Follow these steps to enable notifications when the results for your Saved Search changes:
Saved Search notifications can be disabled only for your own Saved Searches.
Follow these steps to disable notifications when the results for your Saved Search changes:
See examples of the different chart types you can create for your Saved Searches.
Customize charts to include the series and/or categories from the both PMQL query parameters and the columns configured in the detailed data view of that Saved Search. For example, if your Saved Search included a custom column called Countries to display how many Requests have started based on a Request variable value called Countries
, that Request variable may also be used as a series or category in a chart in that Saved Search.
The Charts tab displays charts created for a Saved Search.
See the following sections:
See the following example chart as reference for the following terms ProcessMaker Platform uses in Saved Search charts:
Hover your cursor over a data point to see what that data represents.
Filter data that displays in a chart by hiding attributes of that data via the chart's legend. Consider the following chart that shows the number of Requests by status type per day of the week to visualize how many Requests exist for the "Account Process".
This chart contains three keys in the legend that displays at the top of the chart. Each key in the chart legend represents a data marker in the visualized chart data.
To not display the Requests that have an error, click the Error key in the chart's legend. The strike-through text style displays over the Error key in the chart legend that indicates this data marker is hidden from the chart. The other data markers in the chart automatically adjust to show their data points using the chart's current units of measurement. Click the Error key again from the legend to show this chart data marker again.
See the following Saved Search chart types:
The vertical-style bar chart visualizes Saved Search results in vertical bars. The following vertical-style bar chart shows the number of Requests by status per agency. In this example, data markers are stacked: data markers overlay on one another in the x- and y-axis such that all Request status types display on each other for each agency. Furthermore, this example displays the data marker represents when hovering the cursor over that marker.
The line chart visualizes Saved Search results as data points on a line to show how those results trend. The following line chart shows the number of Requests by status type per day of the week.
The pie chart visualizes Saved Search results as relational proportions between data. The following pie chart shows the number of Requests by status type for the Loan Process.
The list chart displays the raw data or a pivot table for a Saved Search.
The following list chart shows the raw data for Loan Requests.
When a List chart displays a pivot table for a Saved Search, click a column header to pivot how the Saved Search results display.
The following chart shows a pivot table of the number of started Requests by the day of the week for Account Openings.
Click the Edit Saved Searches iconfrom the left sidebar of pages associated with that type.
Click the Edit Saved Searches iconfrom the left sidebar of pages associated with that Saved Search type. The My Saved Searches tab of the Edit Saved Searches page displays your Saved Searches associated by its specific type. Below are Saved Searches for the Request type.
Click the Configure Saved Search button. The configuration settings for your Saved Search displays. See Configure a Saved Search.
Toggle to hide or show your own Saved Searches by using the Hide Saved Searchand Show Saved Searchicons. Hidden Saved Searches do not display in the left sidebar specific to the context from which the Edit Saved Searches icon was selected. See Hide or Show Your Own Saved Searches.
Click the Configure icon. See Configure a Saved Search.
Click the Delete icon. See Delete a Saved Search.
Click the Configure iconfor your Saved Search. The Configuration tab displays.
Select the Saved Search to configure. The Configuration tab displays. Use the Configuration tab to configure basic settings for your Saved Search.
Click the Columns tab. Use the Columns tab to customize how the Saved Search results display in tabular format from the Data tab. The Active Columns column displays the currently selected or default columns to present the Saved Search's search results in tabular format. The Available Columns column displays optional informational components to display the Saved Search's search results. These available options are based on ProcessMaker Platform's analysis of the Saved Search results.
From the Active Columns column, click the Remove iconfor the informational component not to display in the Saved Search's search results. The removed informational component moves to the bottom of the Available Columns column.
Click the Configuration iconfor the informational component placed from the Available Columns column. Note that columns that do not have the Configuration icon are default columns that cannot be configured, but only removed from the tabular data in search results.
The Configure screen for that informational component displays.
Use the Add Custom Column screen to add a custom column to include an informational component that ProcessMaker Platform's analysis of completed Requests for the Saved Search's selected Process did not provide. Click the Add Custom Column button at the bottom of the Available Columns column. The Create Custom Column screen displays.
Sort the informational components in the Active Columns column in the order that they are to display in the Saved Search's search results. To do so, click theicon for an informational component, drag it, and then place it into the order the column is to display in search results. Do not drag the information component to the Available Columns column, or it will no longer be included as a column that displays information in search results.
If it is necessary to reset the columns in your Saved Search to the default layout, click the Reset to Default button. Doing so displays the Reset to Default screen.
Click the Shared with Users tab.
Click the Shared with Groups tab.
To schedule reports for a results, the must be installed.
. The Scheduled Reports page displays for that Saved Search.
Click the Add Scheduled Report button. The Schedule Report screen displays.
Select the Would you like to use a custom Email Screen? option. A drop-down menu displays from which you can select an -type that will display its contents as the email body. Note that the must be installed to have the Email-type Screen and send emails of scheduled reports.
To schedule reports for a results, the must be installed.
.
. The Scheduled Reports page displays for that Saved Search.
Click the Pause iconfor the schedule to pause emailing reports at that interval.
.
. The Scheduled Reports page displays for that Saved Search.
Click the Unpause iconfor the schedule to resume emailing reports at that interval. The next report emails at its next scheduled interval.
To view the schedules to email reports of a results, the must be installed.
in which to view its schedules to email reports.
Click the Scheduled Reports button. The Scheduled Reports page displays for that Saved Search.
Click the Pause iconto suspend the schedule of emailed reports for that Saved Search's results.
Click the Unpause iconto resume the schedule of emailed reports for that Saved Search's results. Note that this icon only displays if a schedule is paused.
Click the Add Scheduled Report button. See .
Click the Edit icon. See .
Click the Delete icon. See .
, including how to sort columns or how many items display per page.
Receive a each time search results change based on your parameters. For example, suppose that you have a Saved Search for all in-progress for a particular , such as for a Purchase Request Process. Each time a Request starts for that Process, your Saved Search results change. If your Saved Search is configured to send notifications each time your Saved Search results change, you receive a notification.
If your Saved Search parameters include when a new is available, receive a notification.
If a record ID in a Collection changes, receive a notification. Note that the must be installed to use Collections.
Saved Search notifications can be or only for your own Saved Searches. Saved Searches by default send notifications when a Saved Search's results change.
To enable for a , the must be installed.
See the permission or ask your Administrator for assistance.
in which to enable notifications for its changed results.
Click the Enable Notifications buttonto enable notifications for this Saved Search.
To disable for a , the must be installed.
in which to disable notifications for its changed results.
Click the Disable Notifications buttonto disable notifications for this Saved Search.
Charts help visualize your Saved Search results. Though you can , nothing distills that data like a customized chart. Create and configure two-dimensional charts to visualize Saved Search results after selecting a Saved Search. You may create customized charts regardless of whether you created the Saved Search or if it was shared with you.
Charts use the data results from the Saved Search to visualize those results in a variety of chart types and styles. Chart data may be filtered by using an optional query that further filters the data from that Saved Search to visualize minute data.
designers may also embed Saved Search charts into - and -type Screens using the .
Understand how ProcessMaker Platform defines components in a Saved Search chart. Note that Saved Search charts are visualizations of Saved Search results. The data and how that data presents in a Saved Search chart derive from the columns presented in the of that Saved Search.
A chart category optionally aggregates the chart by an additional measurement as indicated by the chart . The chart category represents the column from the Saved Search tabular data for applicable chart types. In the , the chart category additionally aggregates by Request status.
A data marker represents one visualization in the chart data. In the , two data markers are visible. Data markers can be stacked: data markers overlay on one another in the x- and y-axis. The data markers in the are not stacked.
A data point represents a point in a line chart's data that shows trending. Data points only apply to line charts. Each visible in the has four (4) data points.
A key is an item in the . Each key in the chart legend represents a in the visualized chart data. Keys that have strike-through text style are hidden in the visualized chart data. In the , there are three keys in the chart legend. The data marker for the Error-status Requests is hidden.
The chart legend identifies how the in the chart are represented. Chart legends may be displayed on the top, bottom, left, or right of the visualized data. In the , the chart legend is at the top of the chart.
The chart metric indicates the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. Aggregation is represented by the Y-axis for applicable chart types. In the , the chart metric is the Request ID as displayed in the # column of Saved Search detailed data view, and then aggregated by the sum of all Requests by status.
The chart series indicates how to group the Saved Search tabular-formatted results. The series groups the chart content by the units of measurement in the X-axis for applicable chart types. In the , the series is "how many Requests start by day of the week."
The horizontal-style bar chart visualizes Saved Search results in horizontal bars. The following horizontal-style bar chart shows the number of that start for the Account Process per day of the week.
The doughnut chart visualizes Saved Search results as relational proportions between data similar to the but with the inner portion removed. The following doughnut chart shows the number of Requests by status type for the Loan Process.
The count chart displays a single data metric on a canvas. The following count chart shows how many records are in the "Department" .
When a List chart displays the raw data for a Saved Search, the chart contents display similarly to the Saved Search results from which the chart is based. Click the Open Record iconto display the specific data in the list chart for that Saved Search.
Copy a Saved Search chart.
To copy a Saved Search chart, the Saved Searches package must be installed.
Follow these steps to arrange the order of the charts of a Saved Search:
View the search results for a Saved Search in which to view its charts. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Create a chart based on the results of a Saved Search to visualize those results.
To create a chart for a Saved Search's results, the Saved Searches package must be installed.
Follow the steps below only to create a horizontal bar, vertical bar, line, pie, or doughnut chart types. Settings for the count and list chart types vary from the steps described below.
See the following sections for steps to create their chart types:
Follow these steps to create a horizontal bar, vertical bar, line, pie, or doughnut chart types for a Saved Search:
View the search results for a Saved Search in which to create a chart. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
In the Name setting, enter the name of the chart. This is a required setting.
From the Chart Type group, select one of the following chart types to visualize the results of this Saved Search:
Bar (Horizontal): The horizontal-style bar chart visualizes Saved Search results in horizontal bars. See chart example.
Bar (Vertical): The vertical-style bar chart visualizes Saved Search results in vertical bars. See chart example.
Line: The line chart visualizes Saved Search results as data points on a line to show how those results trend. See chart example.
Pie: The pie chart visualizes Saved Search results as relational proportions between data. See chart example.
Doughnut: The doughnut chart visualizes Saved Search results as relational proportions between data similarly to the pie chart type but with the inner portion removed. See chart example.
Count: The count chart displays a single data metric on a canvas. See chart example. If you select the Count chart option, see Create a Count Chart for its specific settings.
List: The list chart displays chart data in tabular format. See chart example. If you select the List chart option, see Create a List Chart for its specific settings.
Bar (Horizontal) is the default chart type.
From the Series setting, select how to group the chart data. The series groups the chart content by the units of measurement in the X-axis for applicable chart types. See chart example that references the series grouping. Options that display in the Series drop-down menu derive from the columns configured from the Saved Search tabular data as displayed from the Data tab of this Saved Search. The default configurable columns vary for each type of Saved Search. The Recommended indicator for Saved Search results represent dates, numbers, and/or unique text results and are recommended when configuring the chart series. This is a required setting for applicable charts.
From the Category setting, optionally select a secondary measurement by which to aggregate the chart series. See chart example that references the category measurement. The Category setting does not apply to count charts. Options and their recommendations that display in the Category setting are the same as those in the Series setting.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See chart example that references how that chart data is aggregated.
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
In the Query setting, optionally enter a ProcessMaker Query Language (PMQL) query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
From the Color Scheme setting, select the color palette from which to display the chart.
Enable the Stacked toggle key to stack the chart's data markers: overlay the data markers one another in the x- and y-axis. See this chart as an example of stacked data markers.
From the Legend setting, select where to place the legend in respect to the chart from the following options:
None: The chart legend does not display.
Top: The legend displays above the chart. This is the default option.
Bottom: The legend displays below the chart.
Left: The legend displays to the left of the chart.
Right: The legend displays to the right of the chart.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Created Chart.
To create a chart for a Saved Search's results, the Saved Searches package must be installed.
Follow the steps below only to create a count chart type. Settings for the other chart types vary from the steps described below.
See the following sections for steps to create their chart types:
Follow these steps to create a count chart type for a Saved Search:
View the search results for a Saved Search in which to create this chart type. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
In the Name setting, enter the name of the chart. This is a required setting.
From the Chart Type group, select the Count chart type to visualize the results of this Saved Search. The Count chart type displays a single data metric on a canvas. See chart example.
If you select the Bar (Horizontal), Bar (Vertical), Line, Pie, or Doughnut options, see Create a Horizontal Bar, Vertical Bar, Line, Pie, or Doughnut Chart for their specific settings to create those chart types.
If you select the List chart option, see Create a List Chart for its specific settings.
Bar (Horizontal) is the default chart type.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See chart example that references how that chart data is aggregated.
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
In the Query setting, optionally enter a ProcessMaker Query Language (PMQL) query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
Click the Display tab to configure the appearance and style of the Saved Search chart.
From the Background Color setting, select a color as the background for the count chart canvas.
From the Icon setting, select an icon to display beside to the left of the count chart metric. The Line Chart icon is the default icon.
In the Label setting, optionally enter a label to describe the count chart metric instead of the metric's default label.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Created Chart.
To create a chart for a Saved Search's results, the Saved Searches package must be installed.
Follow the steps below only to create a list chart type. Settings for the other chart types vary from the steps described below.
See the following sections for steps to create their chart types:
Follow these steps to create a list chart type for a Saved Search:
View the search results for a Saved Search in which to create this chart type. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
In the Name setting, enter the name of the chart. This is a required setting.
From the Chart Type group, select the List chart type to visualize the results of this Saved Search. The List chart type displays chart data in tabular format. See chart example.
If you select the Bar (Horizontal), Bar (Vertical), Line, Pie, or Doughnut options, see Create a Horizontal Bar, Vertical Bar, Line, Pie, or Doughnut Chart for their specific settings to create those chart types.
If you select the Count chart option, see Create a Count Chart for its specific settings.
Bar (Horizontal) is the default chart type.
Enable the Select Pivot Table toggle key to create a list chart from which any column header in the chart may be selected to sort the raw data. The Select Pivot Table is disabled by default. If the Select Pivot Table toggle key is enabled, the following settings display:
From the Series setting, select how to group the chart data. The series groups the chart content by the units of measurement in the X-axis for applicable chart types. See chart example that references the series grouping. The Series setting does not apply to count charts. Options that display in the Series drop-down menu derive from the columns configured from the Saved Search tabular data as displayed from the Data tab of this Saved Search. The default configurable columns vary for each type of Saved Search. The Recommended indicator for Saved Search results represent dates, numbers, and/or unique text results and are recommended when configuring the chart series. This is a required setting for applicable charts.
From the Category setting, optionally select a secondary measurement by which to aggregate the chart series. See chart example that references the category measurement. The Category setting does not apply to count charts. Options and their recommendations that display in the Category setting are the same as those in the Series setting.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See chart example that references how that chart data is aggregated.
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
In the Query setting, optionally enter a ProcessMaker Query Language (PMQL) query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
Click the Display tab to configure the appearance and style of the Saved Search chart.
Follow this step if the Select Pivot Table toggle key is enabled from the Source tab:
Follow these steps if the Select Pivot Table toggle key is disabled from the Source tab:
From the Background Color setting, select a color as the background for the list chart canvas.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Created Chart.
Edit a Saved Search chart that has been created.
To edit a Saved Search chart, the Saved Searches package must be installed.
Follow the steps below only to edit a horizontal bar, vertical bar, line, pie, or doughnut chart types. Settings for the count and list chart types vary from the steps described below. See the following sections for steps to edit their chart types:
Follow these steps to edit a horizontal bar, vertical bar, line, pie, or doughnut chart types for a Saved Search:
View the search results for a Saved Search in which to view its charts. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Edit the following settings as necessary:
In the Name setting, edit the name of the chart. This is a required setting.
From the Chart Type group, select one of the following chart types to visualize the results of this Saved Search:
Bar (Horizontal): The horizontal-style bar chart visualizes Saved Search results in horizontal bars. See chart example.
Bar (Vertical): The vertical-style bar chart visualizes Saved Search results in vertical bars. See chart example.
Line: The line chart visualizes Saved Search results as data points on a line to show how those results trend. See chart example.
Pie: The pie chart visualizes Saved Search results as relational proportions between data. See chart example.
Doughnut: The doughnut chart visualizes Saved Search results as relational proportions between data similarly to the pie chart type but with the inner portion removed. See chart example.
Count: The count chart displays a single data metric on a canvas. See chart example. If you select the Count chart option, see Edit a Count Chart for its specific settings.
List: The list chart displays chart data in tabular format. See chart example. If you select the List chart option, see Edit a List chart for its specific settings.
Bar (Horizontal) is the default chart type.
Click the Source tab to configure from which Saved Search's results to visualize in the chart. The Source tab settings vary depending on the chart type selected from the General tab.
Edit the following settings as necessary:
From the Series setting, select how to group the chart data. The series groups the chart content by the units of measurement in the X-axis for applicable chart types. See chart example that references the series grouping. Options that display in the Series drop-down menu derive from the columns configured from the Saved Search tabular data as displayed from the Data tab of this Saved Search. The default configurable columns vary for each type of Saved Search. The Recommended indicator for Saved Search results represent dates, numbers, and/or unique text results and are recommended when configuring the chart series. This is a required setting for applicable charts.
From the Category setting, optionally select a secondary measurement by which to aggregate the chart series. See chart example that references the category measurement. The Category setting does not apply to count charts. Options and their recommendations that display in the Category setting are the same as those in the Series setting.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See chart example that references how that chart data is aggregated.
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
In the Query setting, optionally enter a ProcessMaker Query Language (PMQL) query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
Click the Display tab to configure the appearance and style of the Saved Search chart. The Display tab settings vary depending on the chart type selected from the General tab.
This step shows the settings for the Horizontal Bar, Vertical Bar, Line, Pie, or Doughnut chart:
Edit the following settings as necessary:
From the Color Scheme setting, select the color palette from which to display the chart.
Enable the Stacked toggle key to stack the chart's data markers: overlay the data markers one another in the x- and y-axis. See this chart as an example of stacked data markers.
From the Legend setting, select where to place the legend in respect to the chart from the following options:
None: The chart legend does not display.
Top: The legend displays above the chart. This is the default option.
Bottom: The legend displays below the chart.
Left: The legend displays to the left of the chart.
Right: The legend displays to the right of the chart.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Saved Chart.
To edit a chart for a Saved Search's results, the Saved Searches package must be installed.
Follow the steps below only to edit a count chart type. Settings for the other chart types vary from the steps described below.
See the following sections for steps to edit their chart types:
Follow these steps to edit a count chart type for a Saved Search:
View the search results for a Saved Search in which to edit this chart type. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Edit the following settings as necessary:
In the Name setting, edit the name of the chart. This is a required setting.
From the Chart Type group, select the count chart type to visualize the results of this Saved Search. The Count chart displays a single data metric on a canvas. See chart example.
If you select the Bar (Horizontal), Bar (Vertical), Line, Pie, Doughnut chart option, see Edit a Horizontal Bar, Vertical Bar, Line, Pie, or Doughnut Chart procedure for its specific settings.
If you select the List chart option, see Edit a List chart for its specific settings.
Bar (Horizontal) is the default chart type.
Click the Source tab to configure from which Saved Search's results to visualize in the chart.
Edit the following settings as necessary:
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See chart example that references how that chart data is aggregated.
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
In the Query setting, optionally enter a ProcessMaker Query Language (PMQL) query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
Click the Display tab to configure the appearance and style of the Saved Search chart. The Display tab settings vary depending on the chart type selected from the General tab. This step shows the settings for the Count chart.
Edit the following settings as necessary:
From the Background Color setting, select a color as the background for the count chart canvas.
From the Icon setting, select an icon to display beside to the left of the count chart metric. The Line Chart icon is the default icon.
In the Label setting, optionally enter a label to describe the count chart metric instead of the metric's default label.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Saved Chart.
To edit a chart for a Saved Search's results, the Saved Searches package must be installed.
Follow the steps below only to edit a list chart type. Settings for the other chart types vary from the steps described below.
See the following sections for steps to edit their chart types:
Follow these steps to edit a list chart type for a Saved Search:
View the search results for a Saved Search in which to edit this chart type. The Data tab displays the data details for that Saved Search.
Click the Charts tab. The Charts tab displays all charts created for this Saved Search.
Edit the following settings as necessary:
In the Name setting, edit the name of the chart. This is a required setting.
From the Chart Type group, select the list chart type to visualize the results of this Saved Search.
If you select the Bar (Horizontal), Bar (Vertical), Line, Pie, Doughnut chart option, see Edit a Horizontal Bar, Vertical Bar, Line, Pie, or Doughnut Chart procedure for its specific settings.
If you select the Count chart option, see Edit a Count Chart for its specific settings.
Bar (Horizontal) is the default chart.
Click the Source tab to configure from which Saved Search's results to visualize in the chart. The Source tab settings vary depending on the chart type selected from the General tab.
Edit the following settings as necessary:
Enable the Select Pivot Table toggle key to edit a list chart from which any column header in the chart may be selected to sort the raw data.
The Select Pivot Table is disabled by default.
If the Select Pivot Table toggle key is enabled, the following settings display:
From the Series setting, select how to group the chart data. The series groups the chart content by the units of measurement in the X-axis for applicable chart types. See chart example that references the series grouping. The Series setting does not apply to count charts. Options that display in the Series drop-down menu derive from the columns configured from the Saved Search tabular data as displayed from the Data tab of this Saved Search. The default configurable columns vary for each type of Saved Search. The Recommended indicator for Saved Search results represent dates, numbers, and/or unique text results and are recommended when configuring the chart series. This is a required setting for applicable charts.
From the Category setting, optionally select a secondary measurement by which to aggregate the chart series. See chart example that references the category measurement. The Category setting does not apply to count charts. Options and their recommendations that display in the Category setting are the same as those in the Series setting.
From the Metric setting, select the chart contents from the Saved Search tabular-formatted results to aggregate as well as how to aggregate that data. The Metric setting options are numerically-based Saved Search results such as # that represents the ID for the Request, Task, or Collection record associated with that Saved Search. See chart example that references how that chart data is aggregated.
Select from the following options how to aggregate the selected chart metric:
Average: The average is the arithmetic mean calculated by adding a group of values, and then dividing by the count of those items.
Count: The chart visualizes the number of values of the metric you select.
Minimum: The chart visualizes the minimum value of the metric you select.
Maximum: The chart visualizes the maximum value of the metric you select.
Median: The median is the middle value of a group of values that is calculated by sorting each of the values of the metric you select, then visualizing the middle value.
Sum: The sum is the arithmetic addition of each value of the metric you select. This is the default option.
This is a required setting.
In the Query setting, optionally enter a ProcessMaker Query Language (PMQL) query from which to further filter the Saved Search's results. See the following topics for information how to use PMQL for Requests, Tasks, and Collections:
Click the Display tab to configure the appearance and style of the Saved Search chart.
This step shows the settings for the List chart.
Follow this step if the Select Pivot Table toggle key is enabled from the Source tab:
From the Background Color setting, select a color as the background for the list chart canvas.
Follow these steps if the Select Pivot Table toggle key is disabled from the Source tab:
From the Background Color setting, select a color as the background for the list chart canvas.
Enable the Make rows clickable toggle key to allow anywhere within a list chart row to redirect to the corresponding Request, Task or Collection record depending from which type of Saved Search the list chart derives its data. The Make rows clickable toggle key is disabled by default.
Click Save. If a required setting does not contain a value or selection, the following message displays: The given data was invalid.. Otherwise, the chart and the following message display: Successfully Saved Chart.
Click the Copy Chart iconfor the chart from which to make a copy. The copied chart uses the same name as the source chart with the word Copy appended to it.
Click the +Chart button. The Create Chart screen displays the General tab.
Click the Source tab to configure from which Saved Search's results to visualize in the chart.
Click the Display tab to configure the appearance and style of the Saved Search chart.
Click the +Chart button. The Create Chart screen displays the General tab.
Click the Source tab to configure from which Saved Search's results to visualize in the chart.
Click the +Chart button. The Create Chart screen displays the General tab.
Click the Source tab to configure from which Saved Search's results to visualize in the chart.
From the Background Color setting, select a color as the background for the list chart canvas.
Enable the Display link toggle key to display a link that, when clicked, redirects to the corresponding Request, Task or Collection record depending from which type of Saved Search the list chart derives its data. The link displays as the Open Record iconat the end of each row. The Display link toggle key is enabled by default.
Enable the Make rows clickable toggle key to allow anywhere within a list chart row to redirect to the corresponding Request, Task or Collection record depending from which type of Saved Search the list chart derives its data. The Make rows clickable toggle key is disabled by default.
Click the Configure Chart icon. The General tab displays the current settings for the Saved Search chart.
This step shows the settings for the Horizontal Bar, Vertical Bar, Line, Pie, or Doughnut chart.
Click the Configure Chart icon. The General tab displays the current settings for the Saved Search chart.
The Source tab settings vary depending on the chart type selected from the General tab. This step shows the settings for the Count chart.
Click the Configure Chart icon. The General tab displays the current settings for the Saved Search chart.
This step shows the settings for the List chart.
Enable the Display link toggle key to display a link that, when clicked, redirects to the corresponding Request, Task or Collection record depending from which type of Saved Search the list chart derives its data. The link displays as the Open Record iconat the end of each row. The Display link toggle key is enabled by default.