Important! Starting with version 188.8.131.521 we have a new feature that determines if a KPI is fresh or stale and allows you to alert users when data becomes stales. This feature is enabled by default. On upgrade, this may cause some of your KPIs to enter this state and you may need to adjust the setting (default is 60 minutes). To disable this feature sitewide, change the KPI Stale Age to 0 in Visual KPI Designer under gear icon > Features & Config > Website.
Having real-time data is important for making the right decisions at the right time. What happens if your KPIs show data that appears valid but is actually out of date or stale? Visual KPI has a way of automatically changing the status of a KPI to ‘Stale’ and alerting users when data has not been updated for a certain period of time.
Visual KPI has a Stale status that indicates a KPI has not changed over a predetermined period of time.
In List View, Stale status is indicated by the Stale icon () and color assigned to Stale status (see Set default Stale status attributes below).
The Stale status works by using a time offset in minutes (default is 60 minutes). Every time your data is updated, if the actual value is returned with a timestamp older than 60 minutes (the default), the status will change to Stale (including the status icon and color). You can customize the time (in minutes) for Stale status to activate for your entire KPI site or for individual KPIs.
In KPI Map view, Stale status is indicated by the color assigned to Stale.
Change default Stale status time
The default status can be set sitewide and will affect all KPIs, unless you override individual KPIs.
Using Visual KPI Designer, click the Sitewide Settings configuration icon () and select Features & Config/Website.
The Website settings worksheet is then added to the workbook. If it already exists in the workbook, the Website configuration worksheet is activated and the current configuration data is retrieved from the database and displayed.
Under the KPI Settings section, set the KPI Stale Age (in minutes) to the time that should elapse before a KPI becomes stale (no recent data received). The time is offset (in minutes) to return a Stale status if the most recent timestamped data returned is older than the offset time.
Example: The pressure of an active boiler should return a value every 15 minutes. If Visual KPI doesn’t receive another value for this KPI from one or more of the associated data sources within 60 minutes, the data is considered stale and the KPI status will be set to Stale (and an alert will be sent if configured).
Note: Don’t forget to save the Visual KPI worksheet.
Set default Stale status attributes
Using Visual KPI Designer, you can manage or override the default settings for any status, including Stale status. Learn more
Alert users when data becomes stale for an individual KPI
In the KPI worksheet in Visual KPI Designer, all KPIs will have a Stale Age of Default unless it has been changed. This Default time offset means it will follow the sitewide setting (as described above). You also have the ability to override this time offset for any individual KPI.
Open the KPI worksheet in Visual KPI Designer.
Under the User Experience section of attributes, enter a KPI Stale Age (in minutes) for one or more KPIs.
To reset the KPI Stale Age to default, use the pull-down menu and select Default.
Save the worksheet.
Turn OFF or disable Stale status for any or all KPIs
By default, all individual KPIs are set to 60 (minutes) sitewide. To disable the Stale status, set the KPI Stale Age (time offset) to 0 (minutes).
- To disable Stale status for all KPIs sitewide, set KPI Stale Age to 0 in sitewide settings.
- To disable Stale status for individual KPIs, set KPI Stale Age to 0 next to an individual KPI in the KPI worksheet.
Contact us if you need help!