Channels Output Cache Framework

Learn how to reduces the CRM server workload and improve the response time in high latent networks.

Aurea CRM.Web (Enterprise) provides output caching framework that reduces the CRM server workload and improve the response time in HIGH latent networks, by allowing you to cache the CRM web server output. Output cache framework takes care of server side caching and sets the appropriate client side (response) headers for a data channel decorated with cache output attribute.

The following example shows the channel definition for a channel type with the cache output attribute elements defined in an external file (channelsOutputCaching.config).

<section name="update.web.channelOutputCaching" type="update.Web.Base.Contracts.Caching.Configuration.ChannelOutputCaching ConfigurationSection, update.Web.Base.Contracts"/>
...
<update.web.channelOutputCaching configSource="Configs\channelsOutputCaching.config" />  

<update.web.channelOutputCaching enabled="true">
  <channels>
    <channel channelType="update.Configuration.Web.Channels.FormChannel, update.Configuration.Web" methodName="Get" enabled="false" />
    <channel channelType="update.Configuration.Web.Channels.ConfigurationChannel, update.Configuration.Web" methodName="GetTexts" enabled="true" noCache="true" clientTimeSpan="3600" serverTimeSpan="3600" mustRevalidate="true" anonymousOnly="false" private="true" excludeQueryStringFromCacheKey="false"/>
  </channels> 
</update.web.channelOutputCaching>

The cache output elements should be defined for each of the different data channel types for which you wish to enable client and server side caching for the output from different method calls. The different channel configuration attributes are described below:

• channelType—specify the channel type whose output is to be cached. Mandatory element. For the list of channel types that support caching, see the table below.
• enabled—enable or disable caching the output of the channel. Enabled by default.
• methodName—specify the name of the method whose output is to be cached. Mandatory element. See the table below to get the names of methods that support caching in the list of channel types.
• anonymousOnly—cache enabled only for requests when Thread.CurrentPrinciple is not set. Default value is true.
• clientTimeSpan—time (in seconds) for which a response is cached on the client side. This corresponds to the HTTP Cache-Control general-header's cache-request-directive max-age (in seconds).
• serverTimeSpan—time (in seconds) for which a response is cached on the server side.
• private—ensures that a response is cached by the browser on the client side but is not cached by any intermediate caches like a proxy server. This corresponds to the HTTP Cache-Control general-header's cache-response-directive private.
• mustRevalidate—ensures that the cache entry is not used after it becomes stale, when responding to a subsequent request without first revalidating it with the origin server. This corresponds to the HTTP Cache-Control general-header's cache-response-directive must-revalidate.
• excludeQueryStringFromCacheKey—ensures that cache does not vary by querystring values. Default value is true.

The following table lists the channel types and the method names that support the output caching. The corresponding HTTP method is also pointed out.