Añadir ContextHub en páginas y acceder a tiendas

Añada ContextHub en sus páginas para habilitar las funciones de ContextHub y vincular a las bibliotecas de Javascript de ContextHub

La API de JavaScript de ContextHub proporciona acceso a los datos de contexto que administra ContextHub. En esta página se describen brevemente las principales funciones de la API para acceder a los datos de contexto y manipularlos. Siga los vínculos a la documentación de referencia de la API para ver información detallada y ejemplos de código.

Añadir ContextHub en un componente de página

Para habilitar las funciones de ContextHub y vincular a las bibliotecas de Javascript de ContextHub, incluya el componente contexthub en la sección head de la página. El código JSP del componente de página es similar al siguiente ejemplo:

<head>
   <sling:include path="contexthub" resourceType="granite/contexthub/components/contexthub" />
</head>

Tenga en cuenta que también debe configurar si la barra de herramientas de ContextHub aparece en modo de Previsualización. Consulte Mostrar y ocultar la interfaz de usuario de ContextHub.

Acerca de las tiendas de ContextHub

Utilice los almacenes de ContextHub para conservar los datos de contexto. ContextHub proporciona los siguientes tipos de tiendas que forman la base de todos los tipos de tiendas:

Todos los tipos de tienda son extensiones de la clase ContextHub.Store.Core. Para obtener información sobre cómo crear un nuevo tipo de almacén, consulte Creación de tiendas personalizadas. Para obtener información sobre los tipos de almacén de muestra, consulte Muestra de candidatos de la tienda ContextHub.

Modos de persistencia

Las tiendas de Context Hub utilizan uno de los siguientes modos de persistencia:

Local: utiliza el almacenamiento local de HTML5 para conservar los datos. El almacenamiento local se mantiene en el navegador en todas las sesiones.
Sesión: utiliza sessionStorage de HTML5 para conservar los datos. El almacenamiento de sesión se mantiene durante toda la sesión del explorador y está disponible para todas las ventanas del explorador.
Cookie: utiliza la compatibilidad nativa del explorador con cookies para el almacenamiento de datos. Los datos de cookies se envían desde y hacia el servidor en solicitudes HTTP.
Window.name: utiliza la propiedad window.name para conservar los datos.
Memoria: utiliza un objeto Javascript para conservar datos.

De forma predeterminada, Context Hub utiliza el modo de persistencia local. Si el explorador no admite o no permite el almacenamiento local de HTML5, se utiliza la persistencia de sesión. Si el navegador no admite o no permite HTML5 sessionStorage, se utiliza la persistencia Window.name.

Almacenar datos

Internamente, el almacenamiento de datos forma una estructura de árbol, lo que permite agregar valores como tipos primarios u objetos complejos. Cuando se agregan objetos complejos a los almacenes, las propiedades del objeto se ramifican en el árbol de datos. Por ejemplo, se agrega el siguiente objeto complejo a una tienda vacía denominada location:

Object {
   number: 321,
   data: {
      city: "Basel",
      country: "Switzerland",
      details: {
         population: 173330,
         elevation: 260
      }
   }
}

La estructura de árbol de los datos del almacén se puede conceptualizar de la siguiente manera:

/
|- number
|- data
      |- city
      |- country
      |- details
            |- population
            |- elevation

La estructura de árbol define los elementos de datos del almacén como pares clave/valor. En el ejemplo anterior, la clave /number corresponde al valor 321 y la clave /data/country corresponde al valor Switzerland.

Manipulación de objetos

ContextHub proporciona la clase ContextHub.Utils.JSON.tree para manipular objetos Javascript. Utilice las funciones de esta clase para manipular objetos de JavaScript antes de agregarlos a una tienda o después de obtenerlos de una tienda.

Además, la clase ContextHub.Utils.JSON proporciona funciones para serializar objetos en cadenas y deserializar cadenas en objetos. Utilice esta clase para administrar datos JSON para admitir exploradores que no incluyen de forma nativa las funciones JSON.parse y JSON.stringify.

Interactuar con las tiendas de ContextHub

Utilice el objeto ContextHub Javascript para obtener un almacén como objeto Javascript. Una vez obtenido el objeto store, puede manipular los datos que contiene. Utilice la función getAllStores o getStore para obtener el almacén.

Acceso a los datos del almacén

La clase ContexHub.Store.Core Javascript define varias funciones para interactuar con los datos del almacén. Las siguientes funciones almacenan y recuperan varios elementos de datos contenidos en objetos:

Los elementos de datos individuales se almacenan como un conjunto de pares clave/valor. Para almacenar y recuperar valores, especifique la clave correspondiente:

Tenga en cuenta que los candidatos a tiendas personalizadas pueden definir funciones adicionales que proporcionan acceso para almacenar datos.

NOTA

De forma predeterminada, ContextHub no tiene en cuenta el inicio de sesión que se está usando en los servidores de publicación y ContextHub considera a estos usuarios como "anónimos".

Puede informar a ContextHub de los usuarios que iniciaron sesión cargando el almacén de perfiles tal como se implementó en el sitio de referencia de We.Retail. Consulte el código relevante en GitHub aquí.

Evento de ContextHub

ContextHub incluye una estructura de evento que le permite reaccionar automáticamente a los eventos de la tienda. Cada objeto store contiene un objeto ContextHub.Utils.Eventing que está disponible como propiedad eventing del almacén. Utilice la función on o once para enlazar una función de Javascript a un evento de almacenamiento.

Uso de Context Hub para manipular cookies

La API de JavaScript de Context Hub proporciona compatibilidad con distintos exploradores para la gestión de cookies de navegador. La Área de nombres ContextHub.Utils.Cookie define varias funciones para crear, manipular y eliminar cookies.

Determinación de segmentos resueltos de ContextHub

El motor de segmentos de ContextHub permite determinar qué segmentos registrados se resuelven en el contexto actual. Utilice la función getResolvedSegments de la clase ContextHub.SegmentEngine.SegmentManager para recuperar segmentos resueltos. A continuación, utilice la función getName o getPath de la clase ContextHub.SegmentEngine.Segment para probar un segmento.

Segmentos instalados

Los segmentos de ContextHub se instalan debajo del nodo /conf/we-retail/settings/wcm/segments.

femenino
hembra sobre 30
hembra menor de 30 años
masculino
macho sobre 30
macho menor de 30 años
order-value-75-to-100
order-value-over-100
más de 30
verano
verano-mujer
verano-mujer-sobre-30
verano-mujer-menor de 30 años
verano (hombre)
verano-hombre-sobre-30
verano-hombre-menor de 30 años
menor de 30 años
invierno
invierno-mujer
invierno-mujer-sobre-30
invierno-mujer-menor de 30 años
invierno masculino
invierno-hombre-sobre-30
invierno-hombre-menor de 20 años

Las reglas que se utilizan para resolver estos segmentos se resumen de la siguiente manera:

El elemento de datos gender del almacén perfil determina la mujer o el hombre.
La edad se determina a partir del elemento de datos de edad del almacén de perfiles.
La estación se determina a partir del elemento de datos de latitud del almacén geolocalización y del elemento de datos del mes del almacén de información de surferinfo.

ADVERTENCIA

Los segmentos instalados se proporcionan como configuraciones de referencia para ayudarle a crear su propia configuración dedicada para su proyecto y, como tal, no debe utilizarse directamente.

Registro de mensajes de depuración para ContextHub

Configure el servicio OSGi de ContextHub de Adobe Granite (PID = com.adobe.granite.contexthub.impl.ContextHubImpl) para registrar mensajes de depuración detallados que sean útiles al desarrollar.

Para configurar el servicio, puede utilizar la Consola Web o un nodo JCR en el repositorio:

Consola web: Para registrar mensajes de depuración, seleccione la propiedad Debug.
Nodo JCR: Para registrar mensajes de depuración, establezca la propiedad booleana com.adobe.granite.contexthub.debug en true.