Understand refresh history and data freshness

Distinguish source data, dataset refresh records, dashboard cache timestamps and viewer updates.

A dashboard can be available while its data is older than the business expects. Define what “current” means for the reporting task before choosing a refresh interval or displaying a freshness message.

Track the stages separately

StageQuestion to answer
Source systemHave the business records arrived or changed?
Dataset processingWhat refresh was recorded, and what was its outcome?
Dashboard cacheWhen was the dashboard cache last refreshed?
Canvas or viewerWhen did the user’s screen request an update?

An update at one stage does not prove that every earlier stage is current. For example, reloading a canvas does not establish that the source transaction feed has finished loading.

Read dataset refresh evidence

Get Dataset Refresh History returns a bare array with DateStartedUtc, DateCompletedUtc, Success, RunMessage and Duration. Order records deliberately when identifying the most recent attempt; do not assume array position represents recency.

Handle an empty history explicitly. For a failed record, investigate its message and related server evidence before deciding what to do next. Keep detailed diagnostic messages in an appropriately restricted environment.

Check the dashboard cache timestamp

Get Dashboard Cache Last Refresh Date returns a timestamp in Data. Use it alongside the dataset evidence, not as proof of the age of every source record.

The Check dataset refresh history and dashboard cache age recipe in Recipes shows both calls for a related dataset and dashboard.

Set a business rule in your application

For a daily management report, agree the required source-load completion and acceptable reporting age. Your application can flag a missed window or withhold a “current” label when the evidence is insufficient. Use an explicitly agreed rule rather than inferring success from a timestamp alone.

Configure native dataset refresh in IFBI and check its behaviour in your installation. The refresh-history and cache calls help you monitor that process; they do not start a dataset refresh.

Continue with reliable integration behaviour and troubleshooting.


Did this page help you?