CacheInfo String in FatWire / Oracle WebCenter Sites

The cscacheinfo and sscacheinfo fields of the SiteCatalog are populated with a CacheInfo string. We are now going to discuss about the syntax of the CacheInfo String.

It is a two-part, comma separated string.

The first part tells whether the page should be cached or not.

The second part tells about the expiration.

Following is the screenshot which we can see while creating a Template / SiteEntry:

PART – I

The first part in CacheInfo must be one of the following values:

False – If the value is false, then the page will not be cached.

True – If the value is true, then the page will be cached according to the information provided in the second element.

(blank) – If the value is blank, then Content Server will consult the futuretense.ini property cs.alwaysusedisk. If this property is set to yes, then a blank value will be interpreted as having the same behavior as true. If the value is set to no , then a blank value will be interpreted as having the same behavior as false.

* – If the value is *, then it will be treated as blank.

PART – II

The Second part tells us when the cached page should be removed from cache. If the first element is false, then the second element is ignored. There are Five ways of specifying the expiration of a page.

Page Timeout (in minutes)

Absolute Moment in Time

Time Pattern

Wildcard

Blank

Page Timeout: If the second element starts with ~, then the value following the ~ must be an integer. This is the number of minutes a page will remain in cache. A negative value or “0” indicates that the page will never expire.

Absolute Moment in Time: If the second element starts with @, then the value following the @ must be a date expressed in the JDBC date string format, namely, YYYY-MM-DD HH:MM:SS. After the particular date and time, the cached pages will be flushed from cache.

Time Pattern: If the second element starts with #, then the value following the # must be a valid TimePattern string as defined by the public class COM.FutureTense.Util.TimePattern. It allows you to specify expiration at a specific time or times every day, month,week, day of week, and year.

Wildcard: If the second element is *, then the page will assume a timeout expiration behavior, as
described in Timeout above. The timeout value will be read from cs.pgCacheTimeout property of futuretense.ini file.

Blank: If the second element is blank, then it assumes the same behavior of *.

In this way, we can set the Caching for a page, and its expiration time.