Configurar la integración de IBM Digital Data Exchange

Puede habilitar la integración entre HCL Commerce y IBM Digital Data Exchange (DDX) actualizando la configuración del proveedor de análisis para el sitio.

Antes de empezar

Para completar los siguientes pasos, asegúrese de que ha completado las siguientes tareas:
  • Integre la tienda con IBM Digital Analytics. Los siguientes pasos utilizan una integración con IBM Digital Analytics para demostrar cómo integrar HCL Commerce con DDX para retransmitir datos a un proveedor de análisis.

Procedimiento

  1. Vaya al siguiente directorio, que incluye el archivo desplegado biConfig.xml para la integración entre HCL Commerce y el proveedor de análisis, como por ejemplo IBM Digital Analytics.
    • workspace_dir\crs-web\WebContent\WEB-INF\xml\config\bi
  2. Abra el archivo biConfig.xml para editarlo.
    Este archivo incluye los valores de configuración para integrar HCL Commerce con IBM Digital Analytics.
  3. Actualice la configuración del proveedor de análisis para el sitio o las tiendas para incluir la opción de configuración "useDDX".
    Cuando el valor de esta opción se establece en "true" o se incluye sin ningún valor, la salida de JavaScript para todos los códigos de análisis se incluye en un objeto de JavaScript y se envía a DDX. Incluya la opción en el elemento <biprovider/> para establecer que la configuración sea el valor predeterminado para cada tienda asociada a dicho proveedor de análisis. También puede alterar temporalmente la configuración de una tienda, incluyendo la opción con un valor diferente en la configuración de elemento <store/> para una tienda.
    • Todas las tiendas
      <biprovider name="coremetrics"
       enabled="true"> 
       ...
       <options>
         <attribute name="useDDX" />
       </options>
       ...
      </biprovider>
    • Tiendas específicas
      <store 
       storeId="10101,10102,10103" 
       biprovider="coremetrics" 
       enabled="true"> 
       ...
       <options>
        <attribute name="useDDX" value="true" />
       </options> 
       ...
      </store>
      Donde storeId es el valor de ID de tienda o lista de valores de ID de tienda. Por ejemplo, "10101,10102,10103".
  4. Actualice la configuración output del sitio o las tiendas para incluir la función cmSetClientID en el JavaScript si el valor no se ha configurado todavía. Establezca los valores adecuados para la función, tal como se muestra en el siguiente ejemplo.
    <output section="header">
    <![CDATA[
    ...
    <script type="text/javascript">
    cmSetupNormalization("krypto-_-krypto");
    cmSetClientID(Client_ID,Data_collection_method,Analytics_Provider_site,WebSphere_Commerce_server);
    </script>                 
    ]]>
    </output>
    Donde
    Client_ID
    El ID de cliente proporcionado por el proveedor de análisis. Por ejemplo, "99999999".
    Data_collection_method
    El método de recopilación de datos. Establezca los siguientes valores:
    true
    Las cookies de recopilación de datos del navegador las gestiona el cliente del navegador, que se establece en el dominio que se especifica como el valor WebSphere_Commerce_server.
    false
    Las cookies de recopilación de datos del navegador las gestiona el proveedor de análisis, que se establece en el dominio que se especifica como el valor Analytics_Provider_site.
    Analytics_Provider_site
    El nombre de dominio del sitio de análisis. Por ejemplo, "data.coremetrics.com".
    WebSphere_Commerce_server
    El nombre de dominio del servidor de HCL Commerce. Por ejemplo, "thesite.com".
    Por ejemplo,
    <output section="header">
    <![CDATA[
    ...
    <script type="text/javascript">
    cmSetupNormalization("krypto-_-krypto");
    cmSetClientID("99999999",true,"data.coremetrics.com","thesite.com");
    </script>                 
    ]]>
    </output>
  5. Guarde y cierre el archivo.
    Para obtener un ejemplo de un archivo completo biConfig.xml y para obtener más valores de configuración que puede configurar cuando utilice IBM Digital Analytics como proveedor de análisis, consulte Archivo biConfig.xml de ejemplo para IBM Digital Analytics.
  6. Añada valores de parámetro de tipo de página a las etiquetas de vista de página de las páginas de su tienda para identificar las entradas de datos de análisis en el objeto de JavaScript que se está enviando a DDX.

    Las tiendas que están basadas en la tienda de inicio Aurora de HCL Commerce ya incluyen valores de tipo de página (identificador de página exclusivo) definidos en digitalData.pageInstanceID. Si la tienda no está basada en esta tienda de inicio o si desea cambiar los valores de tipo de página predeterminados enviados a DDX, incluya los valores de tipo de página en las páginas de tienda.

    De forma predeterminada, todas las páginas de las tiendas que se basan en la tienda de inicio Aurora de HCL Commerce incluyen una configuración predeterminada que asocia el valor "wcs-standardpages" con el código de vista de página. Algunas páginas también incluyen otros valores. Por ejemplo, la página de la tienda de inicio Aurora de OrderItemDisplay.jsp incluye la siguiente configuración de parámetros de tipo de página:
    <cm:pageview pageType="wcs-cart"/>
    Nota: Si el soporte para la integración con DDX no está habilitado, se ignora el valor y el parámetro de tipo de página.

    El código de vista de página recopila información sobre las páginas de la tienda que ha visto un cliente. Para obtener más información sobre este código, consulte Etiqueta de vista de página.

    HCL Commerce define el valor del parámetro de tipo de página en digitalData.pageInstanceID. Se hace referencia al valor pageInstanceID cuando se configuran reglas de grupo de páginas en DDX para determinar si los códigos que están asignados a dicho grupo de páginas se despliegan en una página de tienda. De este modo, los códigos se pueden agrupar lógicamente dentro de DDX para el despliegue en tipos de páginas que deben recibir estos códigos. Por ejemplo, las etiquetas necesarias para recopilar información sobre la página y el producto de una página de carro de la compra se añaden a un grupo de páginas DDX con una regla de pageInstanceID = 'wcs-cart'.

    1. Abra la JSP para la página de tienda que incluye el código de vista de página dentro del que incluye un valor de parámetro de tipo de página.
    2. Añada el parámetro de tipo de página al código de vista de página en las páginas de tienda. Establezca el valor del parámetro para que incluya los tipos de página que desee asociar con la página.
      Cuando se incluyen varios valores, separe los valores con un carácter de subrayado "_".
      Por ejemplo, la página de la tienda de inicio Aurora de OrderShippingBillingConfirmationPage.jsp incluye el siguiente parámetro de tipo de página y configuración de valor:
      <cm:pageview pageType="wcs-order_wcs-registration"/>
      De forma predeterminada, los siguientes valores de parámetro están disponibles para su uso en las páginas de la tienda de inicio Aurora de HCL Commerce.
      wcs-productdetail
      Este valor se incluye en las páginas para identificar que los datos que se añaden al objeto JavaScript digitalData son datos de entrada de catálogo. Por ejemplo, este valor se incluye de forma predeterminada en la página de la tienda de inicio de Aurora ProductDisplay.jsp. Considere la posibilidad de añadir este valor a páginas que incluyan el código de producto <cm:product />.
      wcs-cart
      Este valor se incluye en las páginas para identificar que los datos que se añaden al objeto JavaScript digitalData son datos del carro de la compra. Por ejemplo, este valor se incluye de forma predeterminada en la página de la tienda de inicio de Aurora OrderItemDisplay.jsp. Considere la posibilidad de añadir este valor a páginas que incluyan la etiqueta de compra <cm:cart />.
      wcs-registration
      Este valor se incluye en las páginas para identificar que los datos que se añaden al objeto JavaScript digitalData son de registro o relacionados con el usuario. Por ejemplo, este valor se incluye de forma predeterminada en la página de la tienda de inicio Aurora de OrderShippingBillingConfirmationPage.jsp. Considere la posibilidad de añadir este valor a páginas que incluyan la etiqueta de registro <cm:registration />.
      wcs-order
      Este valor se incluye en las páginas para identificar que los datos que se añaden al objeto JavaScript digitalData son datos relacionados con pedidos. Por ejemplo, este valor se incluye de forma predeterminada en la página de la tienda de inicio de Aurora OrderShippingBillingConfirmationPage.jsp. Considere la posibilidad de añadir este valor a páginas que incluyan el código de pedido <cm:order />.
      wcs-element
      Este valor se incluye en las páginas para identificar que los datos que se añaden al objeto JavaScript digitalData son datos de interacción del cliente. Considere la posibilidad de añadir este valor a páginas que incluyan el código de elemento <cm:element />.
      wcs-conversionevent
      Este valor se incluye en las páginas para identificar que los datos que se añaden al objeto JavaScript digitalData son datos relacionados con eventos que no están relacionados con las compras de productos. Considere la posibilidad de añadir este valor a páginas que incluyan la etiqueta de compra <cm:conversion />.
      wcs-standardpage
      Este es el valor predeterminado para todas las páginas JSP de la tienda que incluye el código de vista de página. Si va a añadir páginas personalizadas a la tienda de las que desea recopilar información de análisis para enviarla a DDX, añada este valor.

      Puede alterar temporalmente el valor "wcs-standardpage" u otros valores predeterminados ampliando la clase CommonBaseTag y cambiando el valor de las variables que incluyen estos valores. Por ejemplo, la variable que incluye el valor "wcs-standardpage" es una variable protegida, DEFAULT_PAGE_TYPE. También puede alterar temporalmente el uso del carácter de subrayado "_" como carácter separador. La variable que incluye este valor también es una variable protegida, DEFAULT_PAGE_TYPE_SEPARATOR en la clase CommonBaseTag.

      Nota: La configuración DDX no afecta a la funcionalidad ni a la salida de la etiqueta de campaña <cm:campurl />. Este código no genera una sección JavaScript en la salida, por lo que no hay ningún cambio DDX correspondiente. Cuando habilita el soporte de DDX, no se produce ningún cambio en el modo en que se comporta la etiqueta de campaña.
      Si no incluye el parámetro de tipo de página en las páginas de la tienda, debe completar una de las siguientes configuraciones para identificar las entradas de datos. Para obtener más información sobre cómo completar alguna de las siguientes configuraciones, consulte la documentación proporcionada por DDX.
      • Defina JavaScript para detectar el tipo de página en cada página de la tienda, como por ejemplo determinar el tipo de página de la URL proporcionada por window.location.href en JavaScript.
      • Utilice el gestor de etiquetas DDX para registrar código que pueda determinar el tipo de página, como por ejemplo de la URL proporcionada por window.location.href en JavaScript.
      Si no incluye ninguno de los valores que no sean el valor de parámetro predeterminado "wcs-standardpage", el valor siguiente se genera en el objeto JavaScript digitalData:
      digitalData = { pageInstanceID: "wcs-standardpage" }
      Si incluye otros valores de tipo de página, los valores se añaden al valor del objeto JavaScript "wcs-standardpage":
      digitalData = { pageInstanceID: "wcs-standardpage_wcs-order_wcs-registration" }
    3. Configure DDX para crear los grupos de páginas y las reglas para registrar los valores de parámetros de tipo de página y para definir cómo DDX transmite los datos que se incluyen en el objeto de JavaScript digitalData.
      Para obtener más información, consulte la documentación que proporciona DDX.

Resultados

La integración de análisis puede generar una salida para enviar a DDX. Con esta salida, todos los datos que se envían a DDX y se retransmiten a IBM Digital Analytics se incluyen en el objeto JavaScript digitalData. Para obtener ejemplos de cómo los códigos de análisis de WebSphere Commerce existentes que incluyen un valor de parámetro de tipo de página correspondiente generan los datos para el objeto JavaScript, consulte