Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleVersion History

Date

Change

December 2024

Updated warnings

November 2024

Initial Version

Info

Introduction: Cache Management functions allow to reload cached data and other configuration settings while running the Docupace system (without a full restart of the system).

When you make changes to the Docupace site configuration via the Docupace Connect UI, Docupace Core automatically reloads all data in the corresponding cache. You only need to use the Cache Management functions when changing the database on the backend. Typically, Site-Reliability Engineers (SREs) make such changes.

Definition: A cache is a temporary storage area on the server side that keeps frequently used data in a faster, more accessible place.

Caches should be cleared periodically for several reasons:

  • To free up space - caches can accumulate a lot of unnecessary data over time

  • To fix performance issues - outdated cached data can cause conflicts or slowdowns

  • To force updates - reloading configuration ensures that the system will use recently updated settings

To access the cache functions, open Administration (1) > Tools (2) > Cache Management (3).

admin_tools_cache.pngImage Added

The Cache Management page opens:

cache_management_functions.pngImage Added

Audience: Admin Users, Business Analysts, Site-Reliability Engineers (SREs)

Info

Functionality: Cache Management functions allow to delete data from temporary server-side storage or reload configuration settings without a full restart of the system.

Filter by label (Content by label)
max5
maxCheckboxfalse
reversefalse
titleRelated Pages
cqllabel in ( "admin" , "cache" , "troubleshooting" ) and type = "page" and space = "UG"

The following functions are available:

  1. Clear Cache Key - enter a Cache Key to clear that specific data cache

Warning

Note: This function is retired, since there is no interface for obtaining the Cache Key for a site.

  1. Clear Configuration Cache - clears the entire Docupace Connect cache

Tip: Use this when changes are made to meta data, widgets, domain values, attribute sets, mappings, REST calls to Core, localization messages.

Note

Warning: This function is safe to be executed during production time, however it will impact the performance speed of the first users to use the system after the reset.

  1. Reload Meta & Security from Database - reloads the meta model and security settings

Tip: Use this when new attributes or domains are added, usually this is after a deployment.

Note

Warning: Use this function only during non-business hours as it can impact production processes.

  1. Reload Security Settings Only - reloads only the security settings (Note: Core reloads this automatically every 30 min.)

Tip: Use this when permissions are changed via the Security Manager.

Tip

Note: This function is safe to be executed during production time.

  1. Reload Form Fields Meta - clears cached forms meta

Tip: Use this when changes are made to forms, form fields meta, form fields groups, m2m mappings, etc.

Tip

Note: This function is safe to be executed during production time.

  1. Reload Workflow Meta - clears the cached configuration of the workflow

Tip: Use this when changes are made to transition actions, validations, meta tasks, or other workflow elements.

Tip

Note: This function is safe to be executed during production time.

  1. Reload Cors Filter Settings - reloads configuration of the CORS (Cross-Origin Resource Sharing) filter

Tip: Docupace Core has a domain that allows you to configure CORS, but it is part of the site’s configuration data in Connect.

Tip

Note: This function is safe to be executed during production time.

  1. Reload Properties - reloads site settings that are stored in the properties files

Note

Important: Not all properties can be reloaded using this button. You must restart the site to reload properties that are read when Docupace Core starts up.