Cireson Portal

User Guide: Add-In - Dashboard Auto Refresh

Add-Ins Overview

The Cireson Service Manager Portal Add-In feature is a location for pre-packaged solutions. Simply toggle a solution on, and it is active. Toggle any solution off if you no longer wish to use it. This approach allows for a streamlined, no-code approach to extensibility in the Cireson Service Manager Portal.

Note: For information about the Service Manager Portal Add-In feature and installation process, view the overview article here.

 

Dashboard Auto Refresh Download Link

The latest version 1.0.0 of this Add-In can be downloaded here.

Note: This version of the Add-In is built and tested against version 12.0.2 of the Cireson Portal. It is recommended you are using that version or higher with this Add-In

 

Dashboard Auto Refresh Summary

The Dashboard Auto Refresh Add-In allows dashboard widgets to refresh data on a configurable interval via toggle switch at the top of the page. This only applies to dashboard pages created with the Dashboard Designer.

The Add-In can be configured to allow auto refreshing of all dashboard pages, or specific pages via GUID.

Each setting for the Add-In is as follows:

KeyDescriptionDefault ValueRefreshIntervalSets the time in milliseconds to wait before the page widgets refresh.60000DefaultEnabledSetting this to true will enable the refresh on all dashboard pages by default.trueShowOnPagesLeave blank to display the Auto Refresh Toggle Swith on all pages, or list page guids to only show on specific pages. 

 

Testing and Validation

  1. If experiencing issues, refer to KB Article 2568 here for overall Add-Ins troubleshooting steps

  2. Run through the Add-In’s functionality with default settings.

    1. Verify the following:

      1. In the developer console (open up a browser > dev tools > console), you see that the Dashboard Auto Refresh Add-In is loaded

  3. As you change settings, go through the above again with browser console open

    1. Verify no error messages

    2. Verify your changed settings behave as expected

 

Examples

Auto Refresh Toggle Switch

 

The above will ...

Note: Toggle the Auto Refresh switch to turn the auto refresh function on or off.

 

Per Page Add-In Settings

 

Note: To display the Auto Refresh toggle switch on specific pages, enter the 32 character GUID (including hyphens) in the "ShowOnPages" "VALUE" field. Multiple entries should be separated with only a comma and no spaces.

Note: To display the Auto Refresh toggle switch on all Dashboard pages, leave the "ShowOnPages" "VALUE" field blank.

 

Select the Page GUID

 

Note: You can find the page GUID in the URL for the page you wish to include.

 

Versions

This is the first release of the Add-In. Older versions will appear here as they become available.