ContextHub ha reemplazado a Client Context. Consulte la documentación relacionada para obtener más información.
Client Context representa una colección ensamblada dinámicamente de datos de usuario. Puede utilizar los datos para determinar el contenido que se mostrará en una página web en una situación determinada (segmentación de contenido). Los datos también están disponibles para el análisis de sitios web y para cualquier javascript de la página.
Client Context consta principalmente de los siguientes aspectos:
Para crear un almacén de sesiones independiente y agregarlo a Client Context, o para crear un almacén de sesiones vinculado a un componente de almacén de contexto. AEM instala varios componentes de tienda de contexto que puede utilizar de inmediato. Puede utilizar estos componentes como base para sus componentes.
Para obtener información sobre cómo abrir Client Context, configurar la información que muestra y simular la experiencia del usuario, consulte Client Context.
Client Context incluye varios almacenes de sesiones que contienen datos de usuario. Los datos de almacenamiento proceden de las siguientes fuentes:
El marco de Client Context proporciona un API de javascript que puede utilizar para interactuar con almacenes de sesión y leer y escribir datos de usuario, así como para escuchar y reaccionar a eventos de almacenamiento. También puede crear almacenes de sesión para los datos de usuario que utilice para la segmentación de contenido u otros fines.
Los datos del almacén de sesión permanecen en el cliente. Client Context no vuelve a escribir datos en el servidor. Para enviar datos al servidor de, utilice un formulario o desarrolle JavaScript personalizado.
Cada almacén de sesión es una colección de pares propiedad-valor. El almacén de sesión representa una colección de datos (de cualquier tipo), cuyo significado conceptual puede decidir el diseñador o el desarrollador. En el siguiente ejemplo de código JavaScript se define un objeto que representa los datos de perfil que el almacén de sesión puede contener:
{
age: 20,
authorizableId: "aparker@geometrixx.info",
birthday: "27 Feb 1992",
email: "aparker@geometrixx.info",
formattedName: "Alison Parker",
gender: "female",
path: "/home/users/geometrixx/aparker@geometrixx.info/profile"
}
Un almacén de sesiones se puede mantener entre sesiones de explorador o solo puede durar la sesión de explorador en la que se crea.
La persistencia del almacenamiento utiliza el almacenamiento del explorador o cookies (las SessionPersistence
cookie). El almacenamiento del explorador es más común.
Cuando se cierra y se vuelve a abrir el explorador, se puede cargar un almacén de sesiones con los valores de un almacén persistente. A continuación, es necesario borrar la caché del explorador para eliminar los valores antiguos.
Un componente de almacén de contexto es un componente de CQ que se puede agregar a Client Context. Normalmente, los componentes de almacén de contexto muestran datos de un almacén de sesión con el que están asociados. Sin embargo, la información que muestran los componentes del almacén de contexto no se limita a los datos del almacén de sesión.
Los componentes del almacén de contexto pueden incluir los siguientes elementos:
Para obtener una descripción de los componentes de tienda de contexto instalados que puede agregar al almacén de contexto, consulte Componentes de Client Context disponibles.
Los datos de página ya no están en el contexto de cliente como componente predeterminado. Si es necesario, puede agregarlo editando el contexto de cliente y agregando el Propiedades de almacenamiento genérico y, a continuación, configure para definir el componente Almacenar as pagedata
.
La información de perfil también se utiliza para el envío contenido de destino.
Incluya el componente Client Context en la sección del cuerpo de las páginas web para habilitar Client Context. La ruta del nodo del componente Client Context es /libs/cq/personalization/components/clientcontext
. Para incluir el componente, agregue el siguiente código al archivo JSP del componente de página, ubicado justo debajo de la etiqueta body
de la página:
<cq:include path="clientcontext" resourceType="cq/personalization/components/clientcontext"/>
El componente clientcontext hace que la página cargue las bibliotecas de cliente que implementan Client Context.
La IU de Client Context solo está disponible en la instancia de autor.
Para ampliar Client Context, cree un almacén de sesiones y, opcionalmente, muestre los datos del almacén:
Si tiene (o crea) un JSONP
que puede proporcionar los datos, puede utilizar simplemente el JSONP
componente de almacén de contexto y asígnelo al servicio JSONP. Esto gestionará el almacén de sesión.
Cree un almacén de sesión para los datos que debe agregar y recuperar de Client Context. Por lo general, utilice el siguiente procedimiento para crear un almacén de sesiones:
Cree una carpeta de biblioteca de cliente que tenga un categories
valor de propiedad de personalization.stores.kernel
. Client Context carga automáticamente las bibliotecas de cliente de esta categoría.
Configure la carpeta de la biblioteca de cliente para que dependa de personalization.core.kernel
carpeta de la biblioteca del cliente. El personalization.core.kernel
La biblioteca de cliente de proporciona la API de JavaScript de Client Context.
Agregue el javascript que crea e inicializa el almacén de sesiones.
Si se incluye el javascript en la biblioteca de cliente personalization.store.kernel, el almacén se creará cuando se cargue el marco de Client Context.
Si está creando un almacén de sesiones como parte de un componente de almacén de contexto, puede colocar alternativamente el javascript en el archivo init.js.jsp del componente. En este caso, el almacén de sesiones se crea únicamente si el componente se agrega a Client Context.
Los almacenes de sesión se crean y quedan disponibles durante una sesión del explorador, o se conservan en el almacenamiento del explorador o en las cookies. La API de JavaScript de Client Context define varias clases que representan ambos tipos de almacenes de datos:
[CQ_Analytics.SessionStore](/docs/experience-manager-65/developing/personlization/client-context/ccjsapi.html?lang=es#cq-analytics-sessionstore)
: estos objetos residen únicamente en el DOM de la página. Los datos se crean y persisten durante la duración de la página. [CQ_Analytics.PerstistedSessionStore](/docs/experience-manager-65/developing/personlization/client-context/ccjsapi.html?lang=es#cq-analytics-persistedsessionstore)
: estos objetos residen en el DOM de la página y se conservan en el almacenamiento del explorador o en las cookies. Los datos están disponibles en todas las páginas y en todas las sesiones de usuario.La API también proporciona extensiones de estas clases especializadas en almacenar datos JSON o datos JSONP:
Objetos de solo sesión: CQ_Analytics.JSONStore y CQ_Analytics.JSONPStore.
Objetos persistentes: CQ_Analytics.PersistedJSONStore y CQ_Analytics.PersistedJSONPStore.
El javascript de la carpeta de biblioteca del cliente crea e inicializa el almacén de sesiones. A continuación, el almacén de sesión debe registrarse mediante el Administrador de tienda de contexto. En el siguiente ejemplo se crea y registra un CQ_Analytics.SessionStore objeto.
//Create the session store
if (!CQ_Analytics.MyStore) {
CQ_Analytics.MyStore = new CQ_Analytics.SessionStore();
CQ_Analytics.MyStore.STOREKEY = "MYSTORE";
CQ_Analytics.MyStore.STORENAME = "mystore";
CQ_Analytics.MyStore.data={};
}
//register the session store
if (CQ_Analytics.ClientContextMgr){
CQ_Analytics.ClientContextMgr.register(CQ_Analytics.MyStore)
}
Para almacenar datos JSON, el siguiente ejemplo crea y registra un CQ_Analytics.JSONStore objeto.
if (!CQ_Analytics.myJSONStore) {
CQ_Analytics.myJSONStore = CQ_Analytics.JSONStore.registerNewInstance("myjsonstore",{});
}
Cree un componente de almacén de contexto para procesar los datos del almacén de sesión en Client Context. Una vez creado, puede arrastrar el componente de almacén de contexto a Client Context para procesar los datos de un almacén de sesión. Los componentes del almacén de contexto constan de los siguientes elementos:
AEM proporciona los componentes genericstore y genericstoreproperties del almacén de contexto que puede ampliar. La estructura de los datos de la tienda determina el componente que se amplía:
Pares propiedad-valor: ampliar el GenericStoreProperties
componente. Este componente procesa automáticamente los almacenes de pares propiedad-valor. Se proporcionan varios puntos de interacción:
prolog.jsp
y epilog.jsp
: interacción de componentes que le permite agregar lógica del lado del servidor antes o después del procesamiento del componente.Datos complejos: ampliar el GenericStore
componente. El almacén de sesiones necesitará un método "renderer" al que se llamará cada vez que se necesite representar el componente. La función de procesamiento se llama con dos parámetros:
@param {String} store
El almacén que se procesará
@param {String} divId
El ID del div en el que se debe procesar el almacén.
Todos los componentes de Client Context son extensiones de los componentes Almacén genérico o Propiedades de almacenamiento genérico. Hay varios ejemplos instalados en la variable /libs/cq/personalization/components/contextstores
carpeta.
Al editar Client Context, los componentes del almacén de contexto aparecen en la barra de tareas. Como con todos los componentes, la variable componentGroup
y jcr:title
las propiedades del componente Client Context determinan el grupo y el nombre del componente.
Todos los componentes que tienen un componentGroup
valor de propiedad de Client Context
aparecen en la barra de tareas de forma predeterminada. Si utiliza un valor diferente para componentGroup
, debe añadir manualmente el componente a la barra de tareas utilizando el modo Diseño.
Cuando se agrega un componente de almacén de contexto a Client Context, a continuación se crea un nodo que representa la instancia del componente /etc/clientcontext/default/content/jcr:content/stores
. Este nodo contiene los valores de propiedad que se configuran mediante el cuadro de diálogo de edición del componente.
Cuando se inicializa Client Context, se procesan estos nodos.
Agregue un archivo init.js.jsp al componente para generar código javascript que inicialice el almacén de sesiones que utiliza el componente de almacén de contexto. Por ejemplo, utilice el script de inicialización para recuperar las propiedades de configuración del componente y utilizarlas para rellenar el almacén de sesiones.
El JavaScript que se genera se agrega a la página cuando Client Context se inicializa al cargar la página tanto en la instancia de autor como en la de publicación. Este JSP se ejecuta antes de que se cargue y procese la instancia del componente de almacén de contexto.
El código debe establecer el tipo MIME del archivo en text/javascript
, o no se ejecuta.
El script init.js.jsp se ejecuta en la instancia de autor y publicación, pero solo si se agrega el componente de almacén de contexto a Client Context.
El siguiente procedimiento crea el archivo de secuencias de comandos init.js.jsp y agrega el código que establece el tipo mime correcto. El código que realiza la inicialización del almacén sería el siguiente.
Haga clic con el botón derecho en el nodo de componente de almacén de contexto y haga clic en Crear > Crear archivo.
En el campo Nombre, escriba init.js.jsp
y, a continuación, haga clic en Aceptar.
En la parte superior de la página, agregue el siguiente código y haga clic en Guardar todo.
<%@page contentType="text/javascript" %>
Muestra los datos del almacén de sesión en Client Context mediante un formato coherente.
Las etiquetas de personalización proporcionan lo siguiente personalization:storePropertyTag
que muestra el valor de una propiedad de un almacén de sesiones. Para utilizar la etiqueta, incluya la siguiente línea de código en su archivo JSP:
<%@taglib prefix="personalization" uri="https://www.day.com/taglibs/cq/personalization/1.0" %>
La etiqueta tiene el siguiente formato:
<personalization:storePropertyTag propertyName="property_name" store="session_store_name"/>
El propertyName
attribute es el nombre de la propiedad store que se va a mostrar. El store
attribute es el nombre del almacén registrado. La siguiente etiqueta de ejemplo muestra el valor de authorizableId
propiedad del profile
tienda:
<personalization:storePropertyTag propertyName="authorizableId" store="profile"/>
La carpeta de la biblioteca de cliente personalization.ui (/etc/clientlibs/foundation/personalization/ui/themes/default?lang=es) proporciona los estilos CSS que Client Context utiliza para dar formato al código de HTML. El siguiente código ilustra la estructura sugerida para utilizar para mostrar los datos del almacén:
<div class="cq-cc-store">
<div class="cq-cc-thumbnail">
<div class="cq-cc-store-property">
<!-- personalization:storePropertyTag for the store thumbnail image goes here -->
</div>
</div>
<div class="cq-cc-content">
<div class="cq-cc-store-property cq-cc-store-property-level0">
<!-- personalization:storePropertyTag for a store property goes here -->
</div>
<div class="cq-cc-store-property cq-cc-store-property-level1">
<!-- personalization:storePropertyTag for a store property goes here -->
</div>
<div class="cq-cc-store-property cq-cc-store-property-level2">
<!-- personalization:storePropertyTag for a store property goes here -->
</div>
<div class="cq-cc-store-property cq-cc-store-property-level3">
<!-- personalization:storePropertyTag for a store property goes here -->
</div>
</div>
<div class="cq-cc-clear"></div>
</div>
El /libs/cq/personalization/components/contextstores/profiledata
el componente de almacén de contexto utiliza esta estructura para mostrar los datos del almacén de sesiones de perfil. El cq-cc-thumbnail
La clase coloca la imagen en miniatura. El cq-cc-store-property-level*x*
Las clases dan formato a los datos alfanuméricos:
Para procesar los datos de almacén mediante un componente genericstore, debe:
Las etiquetas de personalización proporcionan lo siguiente personalization:storePropertyTag
que muestra el valor de una propiedad de un almacén de sesiones. Para utilizar la etiqueta, incluya la siguiente línea de código en su archivo JSP:
<%@taglib prefix="personalization" uri="https://www.day.com/taglibs/cq/personalization/1.0" %>
La etiqueta tiene el siguiente formato:
<personalization:storeRendererTag store="store_name"/>
El almacén de sesiones necesitará un método "renderer" al que se llamará cada vez que se necesite representar el componente. La función de procesamiento se llama con dos parámetros:
Utilice JavaScript para interactuar con los almacenes de sesión.
Obtenga un objeto de almacén de sesión para leer o escribir datos en el almacén. CQ_Analytics.ClientContextMgr proporciona acceso a las tiendas en función del nombre de la tienda. Una vez obtenido, utilice los métodos del CQ_Analytics.SessionStore o CQ_Analytics.PersistedSessionStore para interactuar con los datos de la tienda.
El siguiente ejemplo obtiene la variable profile
y, a continuación, recupera el formattedName
de la tienda.
function getName(){
var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
if(profilestore){
return profilestore.getProperty("formattedName", false);
} else {
return null;
}
}
La sesión almacena eventos de activación, por lo que es posible añadir oyentes y eventos de déclencheur basados en estos eventos.
Los almacenes de sesión se basan en la variable Observable
patrón. Se extienden CQ_Analytics.Observable
que proporciona el [addListener](/docs/experience-manager-65/developing/personlization/client-context/ccjsapi.md#addlistener-event-fct-scope)
método.
En el siguiente ejemplo se agrega un agente de escucha al update
evento de la profile
almacén de sesión.
var profileStore = ClientContextMgr.getRegisteredStore("profile");
if( profileStore ) {
//callback execution context
var executionContext = this;
//add "update" event listener to store
profileStore.addListener("update",function(store, property) {
//do something on store update
},executionContext);
}
Los almacenes de sesión no están disponibles hasta que se cargan e inicializan con datos. Los siguientes factores pueden afectar al tiempo de disponibilidad del almacén de sesiones:
Utilice el CQ_Analytics.ClientContextUtils del objeto onStoreRegistered y onStoreInitialized métodos para acceder a los almacenes de sesión solo cuando están disponibles. Estos métodos permiten registrar detectores de eventos que reaccionan a los eventos de registro e inicialización de sesión.
Si depende de otra tienda, debe tener en cuenta el caso de que la tienda nunca se haya registrado.
El ejemplo siguiente utiliza el onStoreRegistered
evento de la profile
almacén de sesión. Cuando se registra el almacén, se agrega un agente de escucha al update
del almacén de sesiones. Cuando se actualiza el almacén, el contenido del <div class="welcome">
en la página se actualiza con el nombre del elemento profile
tienda.
//listen for the store registration
CQ_Analytics.ClientContextUtils.onStoreRegistered("profile", listen);
//listen for the store's update event
function listen(){
var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
profilestore.addListener("update",insertName);
}
//insert the welcome message
function insertName(){
$("div.welcome").text("Welcome "+getName());
}
//obtain the name from the profile store
function getName(){
var profilestore = CQ_Analytics.ClientContextMgr.getRegisteredStore("profile");
if(profilestore){
return profilestore.getProperty("formattedName", false);
} else {
return null;
}
}
Para evitar una propiedad de un PersistedSessionStore
de persistir (es decir, excluirlo del sessionpersistence
cookie), agregue la propiedad a la lista de propiedades no persistentes del almacén de sesiones persistentes.
Consulte [CQ_Analytics.PersistedSessionStore.setNonPersisted(propertyName)](/docs/experience-manager-65/developing/personlization/client-context/ccjsapi.md#setnonpersisted-name)
CQ_Analytics.ClientContextUtils.onStoreRegistered("surferinfo", function(store) {
//this will exclude the browser, OS and resolution properties of the surferinfo session store from the
store.setNonPersisted("browser");
store.setNonPersisted("OS");
store.setNonPersisted("resolution");
});
La página actual debe tener una página móvil correspondiente; esto se determina únicamente si la página tiene un LiveCopy configurado con una configuración de despliegue móvil ( rolloutconfig.path.toLowerCase
contains mobile
).
Al cambiar de la página de escritorio a su equivalente móvil:
Se carga el DOM de la página móvil.
El principal div
(obligatorio) que contiene el contenido, se extrae y se inserta en la página de escritorio actual.
Es necesario configurar manualmente las clases CSS y body que se deben cargar.
Por ejemplo:
window.CQMobileSlider["geometrixx-outdoors"] = {
//CSS used by desktop that need to be removed when mobile
DESKTOP_CSS: [
"/etc/designs/${app}/clientlibs_desktop_v1.css"
],
//CSS used by mobile that need to be removed when desktop
MOBILE_CSS: [
"/etc/designs/${app}/clientlibs_mobile_v1.css"
],
//id of the content that needs to be removed when mobile
DESKTOP_MAIN_ID: "main",
//id of the content that needs to be removed when desktop
MOBILE_MAIN_ID: "main",
//body classes used by desktop that need to be removed when mobile
DESKTOP_BODY_CLASS: [
"page"
],
//body classes used by mobile that need to be removed when desktop
MOBILE_BODY_CLASS: [
"page-mobile"
]
};
En este ejemplo, se crea un componente de almacén de contexto que recupera datos de un servicio externo y los almacena en el almacén de sesiones:
Cree una aplicación CQ y agregue el componente geoloc.
Abra el CRXDE Lite en el explorador web (https://localhost:4502/crx/de).
Haga clic con el botón derecho en /apps
y haga clic en Crear > Crear carpeta. Especifique un nombre para myapp
y, a continuación, haga clic en Aceptar.
Del mismo modo, a continuación myapp
, cree una carpeta llamada contextstores
. "
Haga clic con el botón derecho en /apps/myapp/contextstores
y haga clic en Crear > Crear componente. Especifique los siguientes valores de propiedad y haga clic en Siguiente:
En el cuadro de diálogo Crear componente, haga clic en Siguiente en cada página hasta que se active el botón Aceptar y, a continuación, haga clic en Aceptar.
Haga clic en Guardar todo.
El componente de almacén de contexto requiere un cuadro de diálogo de edición. El cuadro de diálogo de edición geográfica contendrá un mensaje estático que indica que no hay propiedades que configurar.
Haga clic con el botón derecho en /libs/cq/personalization/components/contextstores/genericstoreproperties/dialog
y haga clic en Copiar.
Haga clic con el botón derecho en /apps/myapp/contextstores/geoloc
y haga clic en pegar.
Elimine todos los nodos secundarios debajo del nodo /apps/myapp/contextstore/geoloc/dialog/items/items/tab1/items:
Haga clic con el botón derecho en /apps/myapp/contextstores/geoloc/dialog/items/items/tab1/items
y haga clic en Crear > Crear nodo. Especifique los siguientes valores de propiedad y haga clic en Aceptar:
Agregue las siguientes propiedades al nodo:
Nombre | Tipo | Valor |
---|---|---|
cls | Cadena | x-form-fieldset-description |
text | Cadena | El componente geoloc no requiere ninguna configuración. |
xtype | Cadena | estático |
Haga clic en Guardar todo.
Agregue un archivo init.js.jsp al componente geoloc y utilícelo para crear el almacén de sesiones, recuperar los datos de ubicación y agregarlo al almacén.
El archivo init.js.jsp se ejecuta cuando la página carga Client Context. En este momento, la API de JavaScript de Client Context ya está cargada y disponible para el script.
Haga clic con el botón derecho en el nodo /apps/myapp/contextstore/geoloc y haga clic en Crear > Crear archivo. Especifique un Nombre de init.js.jsp y haga clic en Aceptar.
Agregue el siguiente código a la parte superior de la página y haga clic en Guardar todo.
<%@page contentType="text/javascript;charset=utf-8" %><%
%><%@include file="/libs/foundation/global.jsp"%><%
log.info("***** initializing geolocstore ****");
String store = "locstore";
String jsonpurl = "https://api.wipmania.com/jsonp?callback=${callback}";
%>
var locstore = CQ_Analytics.StoreRegistry.getStore("<%= store %>");
if(!locstore){
locstore = CQ_Analytics.JSONPStore.registerNewInstance("<%= store %>", "<%= jsonpurl %>",{});
}
<% log.info(" ***** done initializing geoloc ************"); %>
Agregue el código al archivo JSP del componente geoloc para procesar los datos del almacén en Client Context.
En CRXDE Lite, abra el /apps/myapp/contextstores/geoloc/geoloc.jsp
archivo.
Agregue el siguiente código HTML debajo del código auxiliar:
<%@taglib prefix="personalization" uri="https://www.day.com/taglibs/cq/personalization/1.0" %>
<div class="cq-cc-store">
<div class="cq-cc-content">
<div class="cq-cc-store-property cq-cc-store-property-level0">
Continent: <personalization:storePropertyTag propertyName="address/continent" store="locstore"/>
</div>
<div class="cq-cc-store-property cq-cc-store-property-level1">
Country: <personalization:storePropertyTag propertyName="address/country" store="locstore"/>
</div>
<div class="cq-cc-store-property cq-cc-store-property-level2">
City: <personalization:storePropertyTag propertyName="address/city" store="locstore"/>
</div>
<div class="cq-cc-store-property cq-cc-store-property-level3">
Latitude: <personalization:storePropertyTag propertyName="latitude" store="locstore"/>
</div>
<div class="cq-cc-store-property cq-cc-store-property-level4">
Longitude: <personalization:storePropertyTag propertyName="longitude" store="locstore"/>
</div>
</div>
<div class="cq-cc-clear"></div>
</div>
Haga clic en Guardar todo.
Agregue el componente Almacén de ubicaciones a Client Context para que se inicialice cuando se cargue la página.
Abra la página de inicio de los Geometrixx Outdoors en la instancia de autor (https://localhost:4502/content/geometrixx-outdoors/en.html).
Haga clic en Ctrl-Alt-c (Windows) o control-opción-c (Mac) para abrir Client Context.
Haga clic en el icono de edición en la parte superior de Client Context para abrir el Diseñador de Client Context.
Arrastre el componente Almacén de ubicaciones a Client Context.
Abra la página de inicio de los Geometrixx Outdoors en modo de edición y, a continuación, abra Client Context para ver los datos del componente Almacén de ubicaciones.
Para crear un segundo contexto de cliente, debe duplicar la rama:
/etc/clientcontext/default
La subcarpeta:
/content
contendrá el contenido del contexto de cliente personalizado.
La carpeta:
/contextstores
permite definir diferentes configuraciones para las tiendas de contexto.
Para utilizar el contexto de cliente personalizado, edite la propiedad
path
en el estilo de diseño del componente contexto de cliente, como se incluye en la plantilla de página. Por ejemplo, como ubicación estándar de:
/libs/cq/personalization/components/clientcontext/design_dialog/items/path