Comparación de parámetros adicionales para etiquetas IBM Digital Analytics

La etiqueta de pedido HCL Commerce (<cm:order />) y la etiqueta de carro de la compra (<cm:cart />) son compatibles con varios parámetros que se pueden utilizar para pasar datos adicionales a IBM Digital Analytics. Esos parámetros son extraparms, extraparmsMap y orderExtraparms (orderExtraparms solo es aplicable a la etiqueta de pedido). Es importante entender qué parámetro debe elegirse para obtener los resultados que se esperan en las etiquetas de datos de IBM Digital Analytics generadas.

La siguiente tabla resume cuándo utilizar cada parámetro:
Parámetro Cuándo se utiliza
extraparms Utilícelo cuando desee añadir los mismos valores a todas las entradas del catálogo en el pedido.
  • Para la etiqueta <cm:order />, utilice este parámetro para pasar valores a IBM Digital Analytics cmCreateShopAction9Tag.
  • Para la etiqueta <cm:cart />, utilice este parámetro para pasar valores a IBM Digital Analytics cmCreateShopAction5Tag.
extraparmsMap Utilícelo cuando desee añadir valores distintos a entradas de catálogo específicas en el pedido, tal como se define la correlación hash. Este parámetro es una alternativa al parámetro extraparms cuando necesita la función adicional de la correlación hash.
  • Para la etiqueta <cm:order />, utilice este parámetro para pasar valores a IBM Digital Analytics cmCreateShopAction9Tag.
  • Para la etiqueta <cm:cart />, utilice este parámetro para pasar valores a IBM Digital Analytics cmCreateShopAction5Tag.
orderExtraparms Utilícelo cuando desee añadir valores al pedido.

Este parámetro solo es compatible con la etiqueta <cm:order />; utilice este parámetro para pasar valores a IBM Digital Analytics cmCreateOrderTag.

Nota: Los ejemplos de este tema utilizan la sintaxis simplificada para especificar valores extraparms. Debe especificar los valores utilizando JavaScript con escape.
Ejemplo de sintaxis simplificada
extraparms="value1-_-value2,value3-_-value4"
Ejemplo de JavaScript con escape correcto
extraparms="\"value1-_-value2\",\"value3-_-value4\""

Si alguno de estos valores extraparms son variables JavaScript, consulte las reglas de sintaxis explicadas en Sintaxis para pasar variables JavaScript como parámetros adicionales.

Ejemplo de uso del parámetro extraparms

A continuación se muestra un ejemplo de cómo se incluirá una etiqueta de análisis de HCL Commerce con el parámetro extraparms en una página de la tienda:
<cm:order orderId="${WCParam.orderId}" extraparms="null,attr1-_-attr2"/>

En este ejemplo, el código de muestra anterior genera las siguientes etiquetas de datos de cmCreateShopAction9Tag para dos entradas de catálogo de pedidos (observe que la etiqueta <order /> también genera la etiqueta de datos cmCreateOrderTag, pero no se muestra en este ejemplo):

cmCreateShopAction9Tag ("KICO-02", "Flavour-Fantasy Gift Set", 
"1.0", "43.58", "1502", "15501", "51.51", "10025", null, "attr1-_-attr2")
cmCreateShopAction9Tag ("KIAC-03", "Rolling Pin", 
"1.0", "7.93", "1502", "15501", "51.51", "10025", null, "attr1-_-attr2")
En los anteriores ejemplos de salida de cmCreateShopAction9Tag, el parámetro extraparms ha generado los siguientes datos para las dos entradas de catálogo de pedidos:
null, "attr1-_-attr2"
Para comprender el formato de los valores de extraparms, consulte:

Ejemplo de uso del parámetro extraparmsMap

Para añadir distintos valores a entradas de catálogo específicas, debe pasar un objeto de tipo java.util.HashMap como valor para extraparmsMap. La clave de la correlación es orderItemId y el valor es el parámetro adicional que desea pasar para esa entrada de catálogo.

El siguiente código de ejemplo muestra cómo se podría utilizar el parámetro extraparmsMap con una etiqueta de análisis de HCL Commerce en una página de la tienda; observe que el código para crear el objeto java.util.HashMap precede a la etiqueta de análisis de HCL Commerce:

<wcf:getData type="com.ibm.commerce.order.facade.datatypes.OrderType" var="orderForAn" 
expressionBuilder="findByOrderId" scope="request">
<wcf:param name="accessProfile" value="IBM_Details" />
<wcf:param name="orderId" value="${WCParam.orderId}" />
</wcf:getData>

<%
java.util.HashMap map = new java.util.HashMap();
com.ibm.commerce.order.facade.datatypes.OrderType 
ord = (com.ibm.commerce.order.facade.datatypes.OrderType) pageContext.getAttribute

("orderForAn",PageContext.REQUEST_SCOPE);
java.util.List orderItemList = ord.getOrderItem();
java.util.Iterator itr = orderItemList.iterator();
int i = 1;
while (itr.hasNext()) {
com.ibm.commerce.order.facade.datatypes.OrderItemType 
orderItemObj = (com.ibm.commerce.order.facade.datatypes.OrderItemType) itr.next();
String id = orderItemObj.getOrderItemIdentifier().getUniqueID();
map.put(id, "null," + "attr" + i+ ".0-_-attr" + i+ ".1");
i++;
}
pageContext.setAttribute("eMap",map);
%>
<cm:order orderType="${orderForAn}" extraparmsMap="${eMap}" />

El código de ejemplo anterior genera la siguiente salida de cmCreateShopAction9Tag de ejemplo para dos entradas de catálogo en el pedido: "Set de regalo de sabores de fantasía" y "Rodillo":

cmCreateShopAction9Tag ("KICO-02", "Flavour-Fantasy Gift Set", 
"1.0", "43.58", "1502", "15501", "51.51", "10025", null, "attr1.0-_-attr1.1")
cmCreateShopAction9Tag ("KIAC-03", "Rolling Pin", 
"1.0", "7.93", "1502", "15501", "51.51", "10025", null, "attr2.0-_-attr2.1")
En los ejemplos de salida cmCreateShopAction9Tag anteriores, el parámetro extraparmsMap ha generado los siguientes datos:
  • Para el "Set de regalo de sabores de fantasía": null, "attr1.0-_-attr1.1"
  • Para el "Rodillo": null, "attr2.0-_-attr2.1"
Para comprender el formato para valores extraparms, consulte:

Ejemplo de uso del parámetro orderExtraparms

A continuación se muestra un ejemplo de cómo se incluirá una etiqueta de análisis de HCL Commerce con el parámetro orderExtraparms en una página de la tienda:
<cm:order orderType="${orderForAn}" orderExtraparms="attr1-_-attr2" />  

El código de ejemplo anterior genera la siguiente etiqueta de datos de cmCreateOrderTag (observe que la etiqueta <order /> también genera la etiqueta de datos cmCreateShopAction9Tag, pero no se muestra en este ejemplo):

cmCreateOrderTag ("16002", "46.65", "6.93", "1502", "LA", "CA", "11111", 
"attr1-_-attr2", "-_--_--_--_--_--_--_--_--_--_--_--_-
Save 10% on all orders today|Flat Shipping-_--5.4|-1.93-_-|") 

En el ejemplo de salida cmCreateOrderTag anterior, el parámetro orderExtraparms ha generado los siguientes datos sobre el pedido:

"attr1-_-attr2"