Stencil widgets offer much more customization than standard widgets and custom widgets and relatively 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 Function widget is a custom widget that performs aggregate function as a summary. It provides drill-down capabilities and display details to provide additional information.
Functionality:
It provides the aggregate function as a summary. This supports Count, Sum and Average functions.
When the widget is clicked, the widget expands and displays all records and columns in the user report using the same format as a Data Table custom widget.
Click the
to refresh data
Click the
to export the data to Microsoft Excel in .xlsx format.
Click the
to expand the widget to view more data
You can also zoom in via the
and zoom out via the
Click to
view more columns
Click the
to sort and filter data. This feature allows you to:
Sort Ascending (A to Z) or Descending (Z to A)
Search in column filters
Users can filter value (text, dates, numeric, and monetary fields)
Adding a Function Widget
After selecting template widget type, select Function 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.
Title: The title of the chart appears on 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. Theme is applied to the entire widget and the header of the widget when it is clicked on.
Icon: An option to add icon for the widget
Function: Displays the output of the function selected and is a required field. Select from 3 options:
Count - counts the number of rows
Sum - sum of all values in the Aggregate column
Average - average of all values in the Aggregate column
User Report: Specify a user report from the list. This is a mandatory field. When the Sum or Average function option is selected, the selected report must have a column named "Aggregate". 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. Please check the Things to Note section for more details about User Reports including a screenshot of the user report for this example.
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
to finish configuration.
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
Click on any point on the function widget to open the drill-in data table. This supports drill-in to further analyze the data in the widget. The Data User Report should contain additional columns that will be displayed in the drill-in data table. The drill-in data table can be resized.
Click on any point on the map chart to open the drill-in data table. The chart supports drill-in to further analyze the data in the chart. The Data User Report should contain additional columns that will be displayed in the drill-in data table. The drill-in data table can be resized.
Things to Note
User Role security still limits report data however User Report filters must be used to further filter report data
User Report prompts are supported for context filters
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
With the exception of Aggregate, all columns will be displayed in the drill-in data table unless they are marked hidden in the User Report
If the Aggregate field is missing from the backing User Report of the widget, then the following prompt will be visible in the widget in the dashboard: An 'Aggregate' field is required in the linked user report for sum and average functions.
Basic data table HTML is supported (links, icons, etc)