1. SuiteAnalytics
  2. Workbook
  3. SuiteAnalytics Workbook Overview
  4. Data Refresh in SuiteAnalytics Workbook
  5. Optimized Data Refresh
  6. Using Cached Data in SuiteAnalytics Workbook

Using Cached Data in SuiteAnalytics Workbook

You can use Cached Response mode to get faster results in your datasets and workbooks. To turn on Cached Response mode or learn how it works and how to monitor cached data, see the topics below:

Enabling Cached Response Mode

To use cached data, set the data refresh in your dataset or workbook to Cached Response mode. You can only do this for datasets and workbooks you can access. Make sure the Cached Data in Datasets feature is enabled in your account first. For more information, see Enabling the Cached Data in Datasets Feature.

To enable Cached Response mode:

  1. Open your dataset or workbook.

    Note:

    If you create a new workbook or dataset, you must save your dataset to change the data refresh to Cached Response mode.

  2. On the upper-left corner, click the arrow next to Real-time Response.

  3. In the Response Mode window, click Cached.

  4. Click Apply.

The Cached Response mode is now enabled.

Cached Data in Connected Datasets and Workbooks

When you enable Cached Response mode in your datasets or workbooks, the mode also changes for the connected datasets and workbooks in some scenarios. For more information, see Data Refresh Changes in Connected Datasets and Workbooks.

Working with Cached Response Mode

When you set data refresh to Cached Response, your datasets and workbooks load from stored data whenever you open them or make changes. To see when your data was last updated, check the time in the upper-left corner of the Viewer, next to Cached Response.

Note:

Some dataset changes require real-time data, even if Cached Response mode is on. Cached data isn't available if you add or remove fields from your dataset, modify its criteria filters, or change a formula used in your dataset. Save your dataset changes to start using cached data again.

When you work with cached data, you can get the most current data at any time. To refresh cached data and see the most up-to-date results, click the Refresh icon.

The frequency of cached data refresh can be different for datasets and workbook visualizations:

Frequency to refresh cached data in datasets

The refresh frequency for cached data in your datasets adapts to your usage. Cached Response tracks when you view datasets, workbooks, or portlets, then schedules refreshes so the data's updated when you need it. Refreshing can happen as often as every hour or as rarely as every 24 hours, depending on your usage.

Frequency to refresh cached data in pivot tables and charts

Cached data in your pivot tables and charts is refreshed after 60 minutes of inactivity, and after a standard data refresh. For detailed information about cached data in pivot tables and charts, see Understanding Data Caching in Pivot Tables and Charts.

Monitoring Cached Data for Datasets

To see an overview of all datasets using Cached Response mode, admins can go to the Dataset Cache Management page. The Dataset Cache Management page lists all datasets using Cached Response mode, affected workbooks, workbook owners, status, and more. You can turn off Cached Response mode for any dataset on this page to switch it to Real-time Response mode. Only admins can access the Dataset Cache Management page.

To access the Dataset Cache Management Page

  1. On the Analytics Home page, click the Datasets subtab.

  2. In the Actions column, click the More icon.

  3. Click Dataset Cache Management.

Note:

This option doesn’t turn off Cached Data in Datasets, it only switches data refresh to Real-time Response mode. Workbook and dataset owners can still change the mode by opening the workbook or dataset and setting it back to Cached Response. For more information, see Enabling Cached Response Mode.

Known Limitations in Cached Response Mode

Character large object (CLOB) values don’t work in cached response mode. If you use CLOB fields with cached response, you’ll get a message saying cached data can’t be enabled. To keep working, check if you’re using CLOB fields, then do one of the following:

  • Remove CLOB fields – If you remove the fields from your dataset and save it, you can work with cached response mode.

    Note:

    The cached response mode is turned on considering the latest saved changes of the dataset. The response mode cannot be turned on if the dataset contained the CLOB field when was last saved. To work with cached response mode, ensure that you remove the CLOB fields from your dataset and then save it.

  • Keep CLOB fields – If you keep the fields, you can work with real-time response mode only.

Identifying CLOB fields

There is no way to identify CLOB fields directly in your datasets or workbooks. However, you can use the Records Catalog to check field types.

Note:

The Records Catalog is available for all users that have the Records Catalog permission assigned to their role. For more information, see Records Catalog Overview.

To identify CLOB fields:

  1. Go to Setup > Records Catalog.

  2. Use the search field to find your record.

  3. Click SuiteScript and REST Query API.

  4. View the Type column on the right. All fields that appear with the CLOBTEXT type are CLOB fields.

For more information about the details available in the Records Catalog, see Records Catalog Fields Available for SuiteScript and Rest Query API.

Related Topics

General Notices