Populate API Cache

This job processes existing data and populates the API cache as part of Digital Commerce Cache Management.

Before running the Populate API Cache job, run these jobs:

Applies to

All releases

By default, the Populate API Cache jobs are run for all catalogs.

Apex Name

populateCacheCAJob in TelcoAdminConsoleHandler

Where to Run This Job

Cacheable API Jobs link on the CMT Administration tab.

Risks of Running This Job

The cache will be cleared and repopulated, but you will not lose any data. There will be a temporary performance impact in a production environment. Run this job only during a maintenance window.

When Not to Run This Job

Do not run this job if cacheable definitions are not ready to be cached. Only run this job once you have completed your product catalog configuration.

When to Run This Job

Cached information is a snapshot of current cacheable definitions at the time caching was invoked. Run this job when definitions are ready or when testing the cached information is required. After running this job, you will see the status, creation and completion dates of the individual API cache jobs.

When you initially run this job, select the checkboxes for all cache job options because some of the jobs have dependencies on other jobs. You can select all options by selecting the Name checkbox on the option list after clicking Start.

More Information

  • This job calls cache handlers that cache the catalog and product information, such as product structure, cardinality, rules, attributes, and pricing.

  • All cache handlers must be selected and cached at least once.

  • The dependency order of handlers is descending.

  • You must clear the entire contents of the cache response object if you make changes to the product catalog data.

  • For more information on best practice, see Populate API Cache Best Practices