Skip to main content

Caching Process Documentation

Overview​

To improve the performance of document rendering, a caching mechanism has been introduced. By pre-filling the cache with data related to a documents inside publication or folder, you can significantly speed up the rendering process. This document describes how to use the “Fill the cache with custom TTL” process, how to configure the cache expiration (TTL), and how to verify which items have been cached.

Purpose​

  • Faster Rendering: Pre-caching data reduces the time needed for the system to fetch and render documents.
  • Flexible Configuration: Users can set the Time to Live (TTL) for cached objects to control how often the cache needs refreshing.
  • Scheduled Operation: The process can be run manually or scheduled (e.g., overnight) to prepare data before rendering is needed.

Key Features​

  1. Cache Pre-Filling: The process gathers all relevant planning data for documents linked to a publication (recursively) or folder.
  2. Customizable TTL: You can specify how long objects remain valid in the cache, preventing stale data while reducing repeated computations.
  3. Detailed Logging: The system logs (at the INFO level) record which elements have been cached, helping you confirm the process results and troubleshoot issues if they arise.

Process Description​

1. Filling the Cache with Custom TTL​

Steps:​

  1. Open Flatplan.
  2. Select a publication or folder.
  3. Right-click to open the context menu.
  4. Click Process, then Start Process.
  5. In the process selection dropdown, choose Fill the cache with custom TTL.
  6. Enter the TTL (Time to Live) in seconds.
  7. Click Start to begin caching.

Once started, the process retrieves all planning data for the selected publication or folder.

2. Scheduled Job (Optional)​

  • To automate this process, you can set it up as a scheduled job (e.g., overnight).
  • This ensures that the cache is always filled with up-to-date data before users start their workday, leading to faster rendering and more efficient operations.

System Logs​

  • Location: The system logs (where INFO-level messages appear) will typically be found in the application’s logging directory.
  • Entries: Look for log entries that mention which objects have been cached, including document IDs, folder names, or publication references, depending on the scope you ran the process on.

Summary​

By running the “Fill the cache with custom TTL” process, you can load and cache all relevant planning data for a documents, significantly speeding up subsequent rendering tasks. Make sure to set an appropriate TTL, use scheduling for convenience, and regularly monitor the logs to maintain optimal performance.