BeyondERP.Newsletter
Menu

Setup page · System administration

KPI cache configuration

A setup page that lists the key performance indicators (KPIs) whose values the data cache holds, one row per KPI, with its refresh frequency and switches.

Used by
Information technology manager
Business process
Administer system features
Menu item
KPIDataCacheConfiguration
Main table
SysDataCacheConfigurationTable
Setup steps
1 on this page
Show what matters for
PAGE GUIDEWhat the page does and how to use it8 sections. Choose a role to highlight what matters to you.
Everyone

1What it is and why

What it isA setup page that lists the key performance indicators (KPIs) whose values the data cache holds, one row per KPI, with its refresh frequency and switches.
What you do hereUse this page to review and change, for each KPI, its refresh frequency, whether it is enabled, and whether filtering and manual refresh are allowed, and to enable or disable all of them at once.
ExampleFor example, a KPI whose value the finance team in BEAT checks once a day can use a 24-hour refresh, so its query doesn't run every few minutes.
KPI cache configuration page in Dynamics 365
The page in Dynamics 365. page title tab to open what to set or check
Functional consultant · Solution architect

2Where it fits

Business processAdminister system features
Menu pathSystem administration › Setup › Data cache › KPI cache configuration
Set up firstData cache parameters Microsoft Learn
Used next byKPI detail data cache configuration Microsoft Learn
Related pagesTile data cache configuration Microsoft Learn
End user · Functional consultant

3How to do it

About the examples: Examples and screenshots in this guide use BEAT, a demo company in a Dynamics 365 test environment. Use your own company's codes and values instead of copying them.

Step by step, with screenshots

Set up KPI cache configuration1 screen
  1. Screen 1

    Review the KPI cache configuration

    Go to System administration > Setup > Data cache > KPI cache configuration

    1. Find the KPI in the list
    2. Review whether it is enabled and how often it refreshes
    3. Select Edit to change the refresh frequency, then select Save
    Review the KPI cache configuration (zoomed on the outlined fields)
    Show the full screenReview the KPI cache configuration
    page title tab to open what to set or check

How to use it

  1. Go to System administration > Setup > Data cache > KPI cache configuration.
  2. Use the Filter box to find a KPI in the Consumer column.
  3. Select Edit, then change Enabled, Refresh frequency, Filtering enabled or Manual refresh for the KPI.
  4. Select Enable all or Disable all to change all the KPIs at once.
  5. Select Delete to remove a selected record.

Source: Checked in Dynamics 365

Fields on the page

FieldWhat it meansExample
Refresh frequencyHow often the cached KPI value is refreshed; the administrator can change it at run time.Microsoft Learn 24 hours
EnabledWhen cleared, the KPI's cached value isn't updated.Checked in Dynamics 365

Common errors and fixes

MessageWhat to do
A KPI shows an old valueCheck that the KPI's row is Enabled and that its refresh frequency fits how current the value must be. Checked in Dynamics 365

Test checklist

  1. Find the KPI in the Consumer column.
  2. Select Edit and set its Refresh frequency.
  3. Change data the KPI measures.
  4. Check the KPI value after the refresh interval.

Source: Microsoft Learn

Functional consultant

4Setup decisions

Setup stepRecommended value and whyDecision, common mistake and test
Set up KPI cache configurationUse the same rule Microsoft gives for cached tiles: a fast refresh only for KPIs whose queries are fast, otherwise 10 minutes or 24 hoursMicrosoft ties refresh frequency to query execution time so frequent refreshes don't load the system with slow queries.How often should each cached KPI refresh?Setting every KPI to the fastest refresh: slow KPI queries then run constantly.Test: Cached KPI follows its refresh frequency

Feature management and licence

Licence or add-inOn this system the page opens for Information technology manager. No Feature management feature needs to be turned on for this page.

Microsoft Learn

Solution architect

5Design impact

Shared or per companyShared: the same records are used by every legal entity. Microsoft data model
Can it be undoneReversible: Enabled and the refresh frequency can be changed at any time. Checked in Dynamics 365
If you change it laterA cached KPI shows its value as of the last refresh, so a slower refresh frequency means older values; the administrator can change the frequency at run time. Microsoft Learn
Technical architect

6Technical

Menu itemKPIDataCacheConfiguration Checked in Dynamics 365
FormSysDataCacheConfiguration Checked in Dynamics 365
TableSysDataCacheConfigurationTableShown as “Data cache configuration” in Record infoChecked in Dynamics 365
Who can open itPrivileges SysDataCacheConfigurationDutiesMaintain system settings SysServerSettingsMaintain
1 security roleInformation technology manager SysServerITManager
Checked in Dynamics 365
Roles to set it up and use itTo set it up or change itInformation technology manager SysServerITManagerGive people one of these roles. On this system, 1 role can open this page.Checked in Dynamics 365
Actions on the pageOptions: Personalize, Page options, ShareChecked in Dynamics 365
Developer

7Developer

Open it by URLhttps://<your-environment>/?mi=KPIDataCacheConfiguration
Data migrationLoad order: KPI cache configuration has no data entity in Data management, so it can't be loaded from a file or a configuration template. Change refresh settings by hand in each environment.Checked in Dynamics 365
Table definitionSysDataCacheConfigurationTable columns and relations Microsoft data model
Everyone

8Sources