Widgets are the building blocks of your dashboard and are prepopulated on dashboard pages in the dcTrack Web Client. Each widget displays data on a specific KPI or metric, with some widgets having additional dropdown selectors to filter the data based on various parameters for additional granularity. In addition to preconfigured widgets, customizable widgets also are available. These include chart widgets, SQL grid widgets, and HTML widgets.
A user with the Administrator role or a globally defined Gatekeeper or Operator role can add, edit, or delete any widgets, including custom widgets but excluding default chart widgets, so you must have one of these roles in order to import a dashboard widget.
New widgets are added from the Dashboard tab in the dcTrack Web Client.
This topic covers the following:
Importing an SQL Widget
You can create SQL queries for the SQL widget yourself, obtain them from Sunbird Technical Support, or copy them from the Addons site here. The resulting widget is in a grid/tabular format for easy data exploration and analysis.
Administrators and global Gatekeepers can add or remove permissions for grid widgets. If you do not see the data you expect, you may not have permissions to access that data. Contact your dcTrack system administrator for more information.
To import an SQL widget:
- In the dcTrack Web Client, click on the Dashboard tab.
- Navigate to the dashboard page where you want to add the widget. (Note: This can be any dashboard except the Enterprise Health dashboard.)
- Click the New Widget icon in the Dashboard tab menu.
- In the dropdown, select the SQL Grid Widget option.
- The SQL Grid Widget Settings dialog displays in a popup. You are able to specify the Title, Refresh rate, and SQL query. All fields are required.
- In the SQL Query (ODBC) field, add your SQL query.
- Click the Save button.
- The widget will be added to the dashboard.
Note: The SQL widget uses dcTrack's ODBC views. For more information, including ODBC tables, see the dcTrack ODBC View Tables and Sample Queries section in the dcTrack API Guide.
Importing a Custom Chart Widget
Custom chart widgets are available for users who want specific metrics that are not covered by the available default widgets. Any existing chart type can be used to create a custom chart widget. The resulting widget will display as a chart, similar to the default chart widgets available natively.
Custom chart widgets can be created by Sunbird Technical Support or downloaded from the Addons site here.
To import a chart widget:
- In the dcTrack Web Client, click on the Dashboard tab.
- Navigate to the dashboard page where you want to add the widget. (Note: This can be any dashboard except the Enterprise Health dashboard.)
- Click the New Widget icon in the Dashboard tab menu.
- In the dropdown, select the Chart Widget option.
- The Custom Widget Upload dialog will display. Click the Upload button.
- In the resulting file selection dialog, select the widget file provided by Sunbird Technical Support or downloaded from the Addons site and click the Open button. (Note: Widgets are provided as .zip files. You must unzip the file. The file you should upload will have a .widget extension and be named with the widget name.)
This example uses the Cabinet Space By Location and Cabinet Group widget available on the Addons site here. - Close the Custom Widget Upload dialog.
- The file will be automatically uploaded once selected, and the new widget file will be added to the dashboard.