Commands and methods for generating a cache key

Commands and methods for generating a cache key

A guide to each method used to generate the cache key. Fewer methods in the cache key results in fewer system resources required to cache the commands.

Methods used to develop a cache key
For rules on which methods to include as part of the cache ID see the comments at the top of cachespec.xml in one of the following directories:

WCDE_installdir\samples\dynacache\marketing\

Method Definition
getCacheKey The unique identifier of the business object. It can be a category ID, a catalog entry ID, or a marketing content ID
getStoreId The unique identifier of the store in which the activity is running
getLanguageId The ID of the language in which to display the result to the customer
getActivityId The unique ID of the activity which returned this business object. This ID is used in the ClickInfo URL
getCatalogId The unique ID of the current catalog
getContracts The unique IDs of the contracts to which the customer is entitled. This ID is required when there are contracts that entitle specific products, or give specific pricing to customers. The catalog web services return entitled categories and products, and the associated product contract pricing.
getActiveOrg The unique ID of the organization to which the customer is currently associated. This method is required when there are contracts that are entitled to specific organizations
getMemberGroups The unique IDs of the member groups to which the customer explicitly belongs. These IDs are required when there are contracts that are entitled to specific member groups
getExperimentId The unique ID of the experiment which returned this business object. This ID is used in the ClickInfo URL
getTestElementId The unique ID of the experiment test element which returned this business object. This ID is used in the ClickInfo URL
getMarketingSpotBehavior The current behavior of the e-Marketing Spot. This behavior is used to avoid caching this command if the e-Marketing Spot is static and the e-Marketing Spot JSP is cached.

Related concepts
Command caching for marketing
Marketing business object cache overview

Related tasks
Setting up command caching for marketing
Tuning the marketing business object cache
Setting up command caching for catalog filter

Related reference
Marketing performance tuning
Marketing cache design considerations

Method	Definition
getCacheKey	The unique identifier of the business object. It can be a category ID, a catalog entry ID, or a marketing content ID
getStoreId	The unique identifier of the store in which the activity is running
getLanguageId	The ID of the language in which to display the result to the customer
getActivityId	The unique ID of the activity which returned this business object. This ID is used in the ClickInfo URL
getCatalogId	The unique ID of the current catalog
getContracts	The unique IDs of the contracts to which the customer is entitled. This ID is required when there are contracts that entitle specific products, or give specific pricing to customers. The catalog web services return entitled categories and products, and the associated product contract pricing.
getActiveOrg	The unique ID of the organization to which the customer is currently associated. This method is required when there are contracts that are entitled to specific organizations
getMemberGroups	The unique IDs of the member groups to which the customer explicitly belongs. These IDs are required when there are contracts that are entitled to specific member groups
getExperimentId	The unique ID of the experiment which returned this business object. This ID is used in the ClickInfo URL
getTestElementId	The unique ID of the experiment test element which returned this business object. This ID is used in the ClickInfo URL
getMarketingSpotBehavior	The current behavior of the e-Marketing Spot. This behavior is used to avoid caching this command if the e-Marketing Spot is static and the e-Marketing Spot JSP is cached.