cache_policies - Model files

Defines cache policies for the model. Each policy must have a max_cache_age parameter that defines the time limit for the policy. This parameter allows you to set defaults for the model, but caching policies can also be set at the dashboard level. Editing cache policies in a workbook model or query model effectively applies the policy to the associated dashboard. Refer to the Topics documentation for information about setting topic-level cache policies.

Syntax

cache_policies:
  <cache_policy_name>:
     max_cache_age: <0_seconds_to_30_days>
     filter_suggestions_must_obey_policy: true/false
     schedule: <cron_expression>

Properties

string

required

A map of cache policy objects where each key is the name of a cache policy. Cache policy names must be unique.

Hide cache_policies properties

string

required

A name that uniquely identifies the cache policy.

Hide cache_policy_name properties

string

default:"6 hours"

required

Defines a rolling-window time limit for the cache policy. The limit is calculated using the timestamp when the cache entry was written, not a specific time of day.For example, if a query populates the cache at 9pm and max_cache_age is 24 hours, users loading the dashboard at 8am the next morning will still see the 9pm result until 9pm that day.Accepted values must be between 0 seconds and 30 days. If a value exceeding 30 days is entered Omni will default to the model’s specified default_cache_policy. If a default policy isn’t set, Omni’s default policy of 6 hours will be used.

To guarantee fresh data at a specific time (for example, at the start of each business day), pair a longer cache policy with a schedule or a scheduled dashboard run. Both bypass the cache and repopulate it with fresh results. Refer to Cache warming for the full pattern.

boolean

default:"false"

This setting can’t currently be removed if set, but it can be changed if needed.

Determines whether filter suggestions obey the cache policy. If false, filter suggestions will be retained for 30 days. Defaults to false.

string

Defines the default cache policy for the model.If set, the cache policy will be applied to all topics in the model and override Omni’s default cache policy. Refer to the Topics documentation for information about setting topic-level cache policies.

string

Applicable to shared models only. Support for extension models coming soon. A cron expression that resets the cache policy on a schedule, evaluated in UTC. The minimum interval is 15 minutes.

Order	Unit	Allowed values	Allowed special characters
1	minute	0-59	* , - /
2	hour	0-23	* , - /
3	day of month	1-31	* , - / L W ?
4	month	1-12 or JAN-DEC	* , - /
5	day of week	1-7 or SUN-SAT	* , - / L W ?

If the cron expression is invalid or falls below the 15-minute minimum, Omni warns during validation but keeps the policy’s max_cache_age behavior intact.

Default cache and filter suggestion retention

Description	Default retention period	Override
Default cache policy	6 hours	`max_cache_age`
Filter suggestions	30 days	Set `filter_suggestions_must_obey_policy` to `true`
Omni Agent chat summary responses	30 days	-

Examples

Retain filter suggestions for 30 days

cache_policies:
  dont_cache_at_all:
    max_cache_age: 0 seconds
    filter_suggestions_must_obey_policy: false

Obey cache policy and retain for 24 hours

Obey cache policy & retain for 24 hours

cache_policies:
  cache_for_a_day:
    max_cache_age: 24 hours
    filter_suggestions_must_obey_policy: true

Reset cache daily at 6AM UTC

Reset the cache every day at 6am UTC

cache_policies:
  nightly:
    max_cache_age: 24 hours
    schedule: "0 6 * * *"

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

cache_policies - Model files

Syntax

Properties

Default cache and filter suggestion retention

Examples

Retain filter suggestions for 30 days

Obey cache policy and retain for 24 hours

Reset cache daily at 6AM UTC

​Syntax

​Properties

​Default cache and filter suggestion retention

​Examples

​Retain filter suggestions for 30 days

​Obey cache policy and retain for 24 hours

​Reset cache daily at 6AM UTC

Syntax

Properties

Default cache and filter suggestion retention

Examples

Retain filter suggestions for 30 days

Obey cache policy and retain for 24 hours

Reset cache daily at 6AM UTC