Setting up JSP snippet caching based on activity behavior

• workspace_dir/crs-web/WebContent/WEB-INF/

Ensure that the following are specified:

• The do-not-consume property is true.
• The do-not-cache property is true.
• The metadatagenerator is specified as com.ibm.commerce.marketing.cache.EMarketingSpotMetaDataGenerator.

<cache-entry>
	<class>servlet</class>
	<name>/Madisons/Snippets/Marketing/ESpot/ContentAreaESpot.jsp</name>		
	<property name="do-not-consume">true</property>
	<property name="do-not-cache">true</property>
		<property name="save-attributes">false</property>
		<cache-id>
			<component id="emsName" type="parameter">
				<required>false</required>
			</component>
			<component id="DC_storeId" type="attribute">
				<required>false</required>
			</component>
			<component id="DC_lang" type="attribute">
				<required>false</required>
			</component>
			<metadatagenerator>com.ibm.commerce.marketing.cache.EMarketingSpotMetaDataGenerator</metadatagenerator>
		</cache-id>
</cache-entry>

• WCDE_installdir\samples\dynacache\marketing\
  Note: This information only applies to versions prior to HCL Commerce version 9.1.13.0. For HCL Commerce version 9.1.13.0 onwards, the marketing command cache rules are relocated to the cachespec.xml file contained within the InitializationServlet.war file used by the transaction server. If the marketing cache rules were introduced previously by manual customization, they should be removed so that the InitializationServlet rules take precedence.

<!-- NEW: for e-Marketing Spot caching -->
            <component id="getMarketingSpotBehavior" type="method">
               <value>1</value>
            </component>

<%
   /* Get the e-Marketing Spot name from the request parameters, and decode it in case it has been encoded. */
   String emsName = request.getParameter("emsName");
   if (emsName != null) {
   	emsName = java.net.URLDecoder.decode(emsName, "UTF-8");
	  request.setAttribute("emsName", emsName);
   }

	Object DM_marketingSpotBehavior = request.getAttribute("DM_emsBehavior-" + emsName);
  	 if (DM_marketingSpotBehavior != null) 
	{request.setAttribute("DM_marketingSpotBehavior", DM_marketingSpotBehavior.toString());}

<wcf:getData type="com.ibm.commerce.marketing.facade.datatypes.MarketingSpotDataType" var="marketingSpotDatas" expressionBuilder="findByMarketingSpotName">

            <%-- the name of the e-Marketing Spot --%>
            <wcf:param name="DM_EmsName" value="${emsName}" />

<wcf:param name="DM_marketingSpotBehavior" value="${requestScope.DM_marketingSpotBehavior}"/>

</wcf:getData>
</c:otherwise>
</c:choose>

<wcf:eMarketingSpotCache marketingSpotData="${marketingSpotDatas}" contentDependencyName="contentId" catalogEntryDependencyName="productId"  categoryDependencyName="categoryId" />

<!-- E-MARKETING SPOT CACHING BEHAVIOR -->
	  <!--  Setting to specify that the Display Catalog Entry Action should be considered dynamic. This means the 
	        marketing engine should evaluate if the catalog entry can be displayed to each individual customer.
	        For example, you would set this if the catalog entry filter is enabled to remove recommendations
	        in the customer's shopping cart, purchase history, or based on inventory level. 
	        Set the value to 1 if the action behavior is dynamic.
	  -->
  	  <_config:property name="catalogEntryActionBehavior" value="0"/>

	  <!--  Setting to specify that the Display Category Action should be considered dynamic. This means the 
	        marketing engine should evaluate if the category can be displayed to each individual customer.
	        Set the value to 1 if the action behavior is dynamic.
	  -->
  	  <_config:property name="categoryActionBehavior" value="0"/>	

	  <!--  Setting to specify that the Display Content Action should be considered dynamic. This means the 
	        marketing engine should evaluate if the catalog entry can be displayed to each individual customer.
	        For example, you would set this if the content filter is enabled to remove recommendations
	        if the customer is not in a segment associated with a promotion, or is not entitled to the
	        promoted products. 
	        Set the value to 1 if the action behavior is dynamic.
	  -->
  	  <_config:property name="contentActionBehavior" value="0"/>

• If the e-Marketing Spot JSP is included in a servlet cached page, then a static e-Marketing Spot has the JSP consumed by the parent page. If you want to always cache the e-Marketing Spot JSP separately, then define a cacheWithParent parameter with a value of false.
• If an e-Marketing Spot must be specified static or dynamic without relying on automatic determination, pass the marketingSpotBehavior parameter when you are importing the e-Marketing Spot JSP snippet. Specify a value of 0 for static behavior and a value of 1 for dynamic behavior. The Marketing Manager can also specify whether the marketing content is static or dynamic in the Management Center. For more information, see Creating marketing content to display on store pages.
• The timeout for the cached fragment is the earliest start or end date of any activity that is scheduled to the e-Marketing Spot after the current time. The timeout is only set if the time is earlier than the current timeout of the page. Usually the timeout is set in the cachespec.xml file, but it can also be specified when you are including the e-Marketing Spot JSP.