ProcessMaker 4.1
ProcessMaker API Documentation
ProcessMaker Examples
Powered By GitBook
Saved Search Chart Control Settings
Add a control that displays a Saved Search chart.

Control Description

The Saved Search Chart control embeds a chart from a Saved Search into a Screen. The Saved Search chart visualizes the latest Saved Search result data at the time the Screen displays. The Saved Search chart is interactive as if it were in the Charts tab of its Saved Search. By embedding a Saved Search chart into a Screen widens that chart's viewability to more stakeholders or even individuals who are not users in your organization by allowing anonymous users access ProcessMaker via the Web Entry package.
Use the Saved Search Chart control to visualize Saved Search results directly within Screens in the following ways:
    Request participants can view the current chart configured for a Saved Search using the latest Request data at the time the Request participant views the Screen.
    Request participants who do not have access to Collections can view charts for Saved Searches based on a Collection.
This control is only available for the following Screen types:

ProcessMaker Package Required

To add a Saved Search Chart control to a Screen, the Saved Searches package must be installed.

Permissions Required

Your user account or group membership must have the following permissions to design a Screen unless your user account has the Make this user a Super Admin setting selected:
    Screens: Edit Screens
    Screens: View Screens
See the Screens permissions or ask your Administrator for assistance.
To select a Saved Search Chart from a Saved Search Chart control, you must be that Saved Search's owner or have been shared the Saved Search.

Add the Control to a ProcessMaker Screen

Follow these steps to add this control to the Screen:
    1.
    Create a new Screen or click the Edit icon
    to edit the selected Screen. The Screen is in Design mode.
    2.
    View the Screen page to which to add the control.
    3.
    Locate the Saved Search Chart icon
    in the panel to the left of the Screen Builder canvas.
    4.
    Drag the Saved Search Chart icon into the Screen Builder canvas. Existing controls on the Screen Builder canvas adjust positioning based on where you drag the control.
    5.
    Place into the Screen Builder canvas where you want the control to display on the Screen.
    6.
    Configure the Saved Search Chart control. See Settings.
    7.
    Validate that the control is configured correctly. See Validate Your Screen.
Below is a Saved Search Chart control in Preview mode.
Saved Search Chart control in Preview mode

Move the Control on the Page

After adding a control to a Screen page, you may move it to another location on that page such that it is above or below other controls placed on that page. A control cannot be moved to another Screen page.
Follow these steps to move a control to another location on that Screen page:
    1.
    Place your cursor anywhere on the control not displaying the Duplicate Control
    or Delete Control
    buttons.
    2.
    Hold your cursor, then drag the control above or below other controls on that Screen page. Screen Builder previews where the control would display on the page based on how you position the control above or below other controls. If the control cannot be placed in a location because your cursor is above an existing control or too far to the left or right of the page, the
    icon displays in the preview.
    3.
    Place the control at the location on the page you want it. The other control(s) on the page automatically adjust position.

Copy the Control with its Settings

Copying a control also copies the current settings of that control. The copied control displays below other controls placed on that Screen page.
Follow these steps to copy a control:
    1.
    Select the control to be copied.
    2.
    Click the Duplicate Control button
    . The control copies with its current settings, and then displays below other controls placed on that page.

Delete the Control from a ProcessMaker Screen

Deleting a control also deletes configuration for that control. If you add another control, it will have default settings.
Follow these steps to delete a control from a Screen page:
    1.
    Select the control to be deleted.
    2.
    Click the Delete button
    . The control deletes. Other controls on that Screen page adjust their locations automatically.

Settings

The Saved Search Chart control has the following panel that contains settings:

Configuration Panel Settings

Click the control while in Design mode, and then click the Configuration panel that is on the right-side of the Screen Builder canvas.
Below are the settings for the Saved Search Chart control in the Configuration panel:

Chart

Select the Saved Search chart to display in the Screen. If you are not that Saved Search's owner nor have not been shared the Saved Search associated with the chart, that chart does not display in the Chart setting.

PMQL Query

Enter an additional ProcessMaker Query Language (PMQL) query from which to filter Saved Search results to display in the chart.

Title

Enable the Title toggle key to display the Saved Search chart's title above the chart. The Title toggle key is enabled by default.

Border

Enable the Border toggle key to display a border around the Saved Search chart. The Border toggle key is enabled by default.
Enable the Enable Link toggle key to display the
icon that, when clicked, displays the Saved Search from which the chart visualizes data in a new browser window. The Enable Link toggle key is disabled by default.

Size

Select the size of the Saved Search chart.
The Size setting options are based on the height of the Saved Search chart. The width of the chart adjusts accordingly. Select from the following options:
    Half: The Half option displays the chart by half its height.
    Standard: The Standard option displays the chart in its default height. The Standard option is the default setting.
    Double: The Double option displays the chart double its default height.

Related Topics

Last modified 3mo ago