caches Element

The caches element is a container element for cache elements you can use to configure CacheManager Object object-based caches in the application. The cache configuration supports a number of default configurations for advertising, discounts, and other common Commerce Server caches. In each case, the cache type has its own default options associated with it; however, you can override the default options.

The caches element contains two elements: cache and config.

cache Element

The cache element indicates the beginning of a new cache definition in the Web.config file. Depending on the extended configuration settings (config elements) requirements, you can use this element as a container and as a marker element. At least one cache element is required.

The following table lists and describes the attributes of the cache element.

config Element

The config element identifies the arbitrary key/value pairs in the cache configuration dictionary. The cache configuration dictionary created by the runtime is supplied to both the loader and writer components, and is used as both the LoaderConfig and WriterConfig dictionaries. If a cache has both loader and writer components and wants to provide a distinct configuration, you must do it programmatically by accessing the CommerceCache instance in the CommerceCacheCollection created for the site. The config element is optional.

If you need to set values for data types other than string, you must set them programmatically.

The following table lists and describes the attributes of the config element.

Cache Types

If you specify a known type for the type attribute, Commerce Server provides a set of default values for the configuration. You can override these default values programmatically or you can set the values in the configuration itself.

Some of the cache types have a dependency on a specific Commerce Server resource. When the CommerceCacheModule creates the caches it also runs checks to make sure that all resource dependencies are satisfied. If these dependences are not satisfied, a CommerceResourceDependencyException is generated. If the BizData Service (Profiles) resource does not exist, setting the type to Advertising or Discounts generates a CommerceResourceDependencyException when the application is initialized. Similarly, if the Marketing resource does not exist, setting the type to MarketingDiscounts generates the same exception.

The following tables list the default values for each configuration setting and each type of cache.

Advertising

The Advertising cache has a dependency on the Marketing resource.

Custom

Discounts

The Discounts cache has a dependency on the Marketing resource.

OrdersConfiguration

The Orders cache has a dependency on the Transaction Config resource.

Payment

The Payment cache has a dependency on the Transaction Config resource.

Shipping

The Shipping cache has a dependency on the Transaction Config resource.

Tax

The Tax cache has a dependency on the Transaction Config resource.

Examples

Code

The following code example shows basic configurations for all Commerce Server caches.

<caches>
    <cache 
       name="Advertising" 
       type="Advertising" 
       refreshInterval="900" 
       retryInterval="30"
    />
    <cache 
       name="Discounts" 
       type="Discounts" 
       refreshInterval="0" 
       retryInterval="30"
    />
    <cache 
       name="ShippingManagerCache" 
       type="Shipping" 
       loaderProgId="Commerce.ShippingMethodCache" 
       refreshInterval="0" 
       retryInterval="30"
    />
    <cache name="PaymentMethodCache" type="Payment"/>
    <cache name="OrdersConfigurationCache" type="OrdersConfiguration"/>
</caches>

Code

The following code example shows how to configure the Discounts cache, and the Advertising cache, to write performance data to the WriteEvents pipeline component. The CSFWriteEvents component is used to write the values from the performance dictionary into the mktg_performance_total table in the marketing database. This is done each time a CSF Cache (of type Adverstising or Discounts) is flushed or reloaded. The mktg_spUpdatePerformanceTotal SQL stored procedure is used by default to perform this operation.

    <cache name="discounts"
      type="Discounts"
      loaderProgId="Commerce.CSFLoadDiscounts"
      writerProgId="Commerce.CSFWriteEvents"
      refreshInterval="0"
      retryInterval="60">
      <config key="recordEventProcedure" value="mktg_spUpdatePerformanceTotal" />
    </cache>
    <cache name="advertising"
      type="Advertising"
      loaderProgId="Commerce.CSFLoadAdvertising"
      writerProgId="Commerce.CSFWriteEvents"
      refreshInterval="0"
      retryInterval="60">
      <config key="recordEventProcedure" value="mktg_spUpdatePerformanceTotal" />
    </cache>

See Also

Reference

CommerceCache

CommerceCacheModule

Other Resources

ShippingManagerCache

Web.Config Configuration Settings