Bridgeline Digital Logo
Menu

Enable an OrchestraCMS platform cache

OrchestraCMS Platform Cache uses a Platform Cache Partition in your Salesforce organization that is intended solely for use by OrchestraCMS. To use this feature, you must enable Platform Cache in your organization and allocate cache space to the OrchestraCMS partition.

Allocate cache space to the OrchestraCMS partition

  1. In Salesforce Setup, navigate to Develop -> Platform Cache.
  2. Click Edit next to OrchestraCMS in the list of platform cache partitions.
    • The Capacity (MBs) section contains the following subsections relating to allocating space to this partition:
      • Total Available. Available space in the Platform Cache that has not been allocated to any partition.
      • Session Cache Allocation. Space allocated to the session cache for this partition.
      • Org Cache Allocation. Space allocated to the organization cache for this partition.
      • Total Allocation. Total allocated space for this partition.

There are a few considerations to keep in mind when allocating cache space to the OrchestraCMS partition. You do not need to allocate space to both the session cache and organization cache, but if allocating space to either one of them, you must allocate a minimum of 5MB.

Additionally, OrchestraCMS uses the session cache solely for storing information about user targets. So you should only allocate space to the session cache if you have a site that uses the OrchestraCMS Targeting feature.

  • When you have finished allocating space to the partition cache, click Save.

In OrchestraCMS, you can control how your cache space is used with greater specificity.

  1. Within OrchestraCMS Setup, select Platform Cache. Here you will find a list of OrchestraCMS constructs to include in the platform cache.
  1. To include constructs in the cache, click the checkboxes beside the ones you wish to include and click Save.

  • OrchestraCMS Site Object. This is used by every OrchestraCMS transaction and every page hit and service request during live production site rendering. This object is cached in the org-wide section of the partition. We recommend turning this option on.
  • OrchestraCMS User Object and Targeting Filters. This information is only used during live production site rendering if the site makes use of the OrchestraCMS Content Targeting feature. These objects are cached in the user-session section of the partition. The option should only be selected if the site uses content targeting.
  • OrchestraCMS Site Language Maps. This object holds a number of site language maps used by live site rendering. Even if the site is not multilingual, there is still some benefit to caching this object. This object is cached in the org-wide section of the partition. We recommend turning this option on.
  • OrchestraCMS Page Version Index. This object contains a mapping of every URL used for live site rendering. Salesforce imposes a 100KB size limit for individual platform cache entries; as this limit is applied after a JAVA serialization has been done against the object, it is impossible for OrchestraCMS to know in advance if the object will “fit”. If the attempt to cache this object fails due to the size limitation, the system will turn this option off and send an email to the System Administrator. If this happens, we do not recommend turning the option back on, as the effort expended to build the cache object is wasted. This object is cached in the org-wide section of the partition. Our recommendation is to turn this option on initially and let the system decide if it needs to turn the option off.
  • OrchestraCMS User Profile Permissions and Feature Licenses. The OrchestraCMS UI and APIs need to validate user permissions and feature licenses prior to servicing requests. Having this information cached speeds up the processing of these requests. Note that this does not boost live site performance. These objects are cached in the org-wide section of the partition. We recommend turning this option on.

Once you have decided which constructs to include, you can click Show Cache Keys to reveal the contents of the OrchestraCMS partition cache. For each key, the name and cache type are displayed along with an action panel for the key. The action panel allows you to show the contents of that cache key or remove it from the cache.

Notes on Platform Cache

  • Although you can turn on platform caching options without having allocated any memory to the OrchestraCMS cache partition, we do not recommend this.
  • OrchestraCMS automatically manages cached object “refresh” provided the objects in question are updated via the OrchestraCMS UI or APIs. OrchestraCMS cannot detect changes to cached objects that have been affected externally.
  • The platform cache settings are configurable on a site-by-site basis to provide maximum control to the system administrator in prioritizing cache utilization.
  • The Show Cache Keys and values functionality can show all org-wide cache entries but can only display session-cached keys and values for the current user.
  • If a key is removed from the cache, it will be regenerated the next time it is needed by OrchestraCMS.