Editing a Refresh Timer widget

Edit online

The Refresh Timer widget can be used to set a time interval whereby a refresh event is generated at specified intervals.

After a set period the Refresh Timer widget triggers a dataRefresh event and other dashboard widgets that subscribe to that event are updated accordingly. Once the event has been triggered, the widget restarts the timer and the event is again triggered once the timer reaches zero.

Note: The browser reload widget and the refresh timer widget are used in different situations. The refresh timer widget is used more often than the browser reload widget.
  • Use the refresh widget to update dashboard data at regular intervals. The refresh widget is useful when data providers do not provide dynamic refreshes. The refresh widget does not reload the entire browser. It can be used for dashboards that are running on desktop or mobile browsers.
  • Use the browser reload widget on dashboards that run for extended periods in desktop environments. Depending on the browser and version, dashboards that are running for extended periods can become slow to respond because of browser-related memory leaks. If you notice the desktop client's memory usage is increasing over time, add a browser reload widget to the dashboard to periodically release memory. The browser reload widget is used for desktop environments only, that is, it must not be used for dashboards that are running on mobile devices.

Procedure

To edit the widget settings:
  1. Click Edit options icon and select Edit, or from the Widget menu in the dashboard menu bar, select Edit.
  2. In the Title field, enter a custom title for the widget.
  3. Optional: Check Allow user to pick refresh interval to display a series of time-labeled check boxes. Check the refresh intervals that you want the user to be able to configure in view mode.
    Alternatively, if you do not check Allow user to pick refresh interval, you can select a refresh interval in minutes from the Set Reload Interval drop-down. Users cannot then configure custom refresh intervals in view mode.
  4. Optional: In the Custom Help URL field, provide a fully qualified URL (that is, include http:// or https://) to an HTML file to provide custom help.
    The specified help page is accessible from the General tab when a user clicks the help icon for the widget.
  5. Click OK to save your settings.
  6. In the dashboard tab bar, click Save and Exit to exit edit mode and return to the dashboard.