Stencil widgets offer much more customization than standard widgets and custom widgets and are straightforward to configure. The look and organization of the widget is predefined. The data, text, and icons are easily customizable using one or two User Reports. These user reports must use specific column captions (names) for the widget to function correctly.
The Statistics List Widget is a custom stencil widget that has two sections and uses one User Report for each section. The top section displays summary-like information and the bottom section lists multiple records likely related to the summary data.
Functionality:
Click the
icon to export the data to Microsoft Excel in .xlsx format.
Adding a Statistic List Widget
Select Statistics List from the Add Widget Templates side panel and click the
From here you can modify the following fields:
Name: This is a mandatory field. Users should give the widget a specific name to differentiate it from other instances of the widget.
Description: Description of the widget which is only viewable by users editing the dashboard. Descriptions are limited to 500 characters.
Theme: Select a color using the color picker. This will be the background color of the widget title. If no color is selected, white will be the defaulted color used.
Configuration User Report (First Row Only): Specify a user report from the list. This is a mandatory field. An option to open the report via
which will happen on a new tab and run the report is available via
which will happen on a new tab. The selected user report must use the specific column names (in bold) for the widget to function correctly and they can appear in any sequence in the report. Please check the Things to Note section for more details about User Reports including screenshots of the user reports for this example:
Title - Custom Calc field with text between single quote marks
Subtitle - Custom Calc field with text between single quote marks
Icon - Custom Calc field. Set field value to NULL if an icon is not required. Otherwise, use the following HTML format between single quote marks e.g. '<i class="fal fa-ad"></i>'
For a list of support icons see: https://fontawesome.com/icons?d=gallery&s=light
Number Subtitle - Custom Calc field with text between single quote marks
Number Rows- Custom Calc field with a number between single quote marks
Number - you may wish to create a pre-requisite report that calculates a Total Numbers so that the field can be referenced in this report.
List User Report (Multiple Rows): Specify a user report from the list. This is a mandatory field. The selected user report must use the specific column names (in bold) for widget to function correctly and they can be in any sequence:
Name - can be standard Equus Platform field
Number - can be standard Equus Platform field with a Count Aggregate
Fill Percent - Custom Calc field - use the field from the pre-requisite report that calculates the Total Number as part of the calculation
Refresh Time Override (Hours): The number of hours to refresh the report data can be set to override the default dashboard refresh setting. A higher value improves general system performance by running reports less often. A lower value refreshes data more frequently. Certain widgets can override this setting. A user can always force a refresh in a widget to see the latest data and update their cache.
Click
The newly added widget will be added. Widgets can be moved around and resized whilst in editing mode. You can change configuration with the
icon and delete it with
Things to note
Here is the sample configuration User Report (First Row Only)'s Report:
User Report prompts are not supported on the configuration report. The User Report prompts for the List user Report are supported for context filters. Filters are optional on the User Report for the widget to display data
User Role security still limits report data however User Report filters must be used to further filter report data
After selecting a user report the user can run or edit the report for easy setup
The Refresh Time Override (Hours) can be set to override the default dashboard refresh time
The configuration report can have more rows when it is run but only the first row will be used to populate the widget