Configuración de ContextHub

ContextHub es un marco para almacenar, manipular y presentar datos de contexto. Para obtener más información sobre ContextHub, consulte la documentación para desarrolladores. ContextHub reemplaza Client Context en la IU táctil.

Configure la barra de herramientas ContextHub para controlar si aparece en modo de Previsualización, para crear almacenes de ContextHub y agregar módulos de interfaz de usuario mediante la IU táctil.

Desactivación de ContextHub

De forma predeterminada, ContextHub está habilitado en una instalación AEM. ContextHub se puede deshabilitar para evitar que cargue js/css e inicialice. Existen dos opciones para deshabilitar ContextHub:

• Edite la configuración de ContextHub y marque la opción Deshabilitar ContextHub

  1. En el carril, toque o haga clic en Herramientas > Sitios > ContextHub
  2. Toque o haga clic en el Contenedor de configuración predeterminado
  3. Seleccione la Configuración de ContextHub y toque o haga clic en Editar elemento seleccionado
  4. Toque o haga clic en Deshabilitar ContextHub y toque o haga clic en Guardar

o

• Use CRXDE Lite para establecer la propiedad disabled en true en /libs/settings/cloudsettings

Mostrar y ocultar la interfaz de usuario de ContextHub

Configure el servicio OSGi de ContextHub de Adobe Granite para mostrar u ocultar la IU de ContextHub en sus páginas. El PID de este servicio es com.adobe.granite.contexthub.impl.ContextHubImpl.

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

• Consola web: para mostrar la interfaz de usuario, seleccione la propiedad Mostrar interfaz de usuario. Para ocultar la interfaz de usuario, desactive la propiedad Ocultar IU.
• Nodo JCR: para mostrar la interfaz de usuario, establezca la com.adobe.granite.contexthub.show_ui propiedad booleana en true. Para ocultar la interfaz de usuario, establezca la propiedad en false.

Al mostrar la interfaz de usuario de ContextHub, solo aparece en las páginas de AEM instancias de autor. La interfaz de usuario no aparece en las páginas de instancias de publicación.

Añadir los modos y módulos de interfaz de usuario de ContextHub

Configure los modos y módulos de interfaz de usuario que aparecen en la barra de herramientas de ContextHub en modo de Previsualización:

• Modos de IU: Grupos de módulos relacionados
• Módulos: Widgets que exponen datos de contexto de una tienda y permiten a los autores manipular el contexto

Los modos de IU aparecen como una serie de iconos en la parte izquierda de la barra de herramientas. Cuando se selecciona, los módulos de un modo de IU aparecen a la derecha.

Los iconos son referencias de la biblioteca de iconos de la interfaz de usuario de Coral.

Añadir un modo de IU

Añada un modo de IU para agrupar los módulos de ContextHub relacionados. Al crear el modo de IU, se proporciona el título y el icono que aparecen en la barra de herramientas de ContextHub.

1. En el carril del Experience Manager, toque o haga clic en Herramientas > Sitios > Context Hub.

2. Toque o haga clic en el Contenedor de configuración predeterminado.

3. Toque o haga clic en la Configuración de Context Hub.

4. Toque o haga clic en el botón Crear y, a continuación, toque o haga clic en el modo de IU de Context Hub.

   

5. Proporcione valores para las siguientes propiedades:

   • Título del modo de IU: Título que identifica el modo de IU
   • Icono de modo: El selector del icono IU de Coral que se va a usar, por ejemplo coral-Icon--user
   • Habilitado: Seleccione esta opción para mostrar el modo de IU en la barra de herramientas de ContextHub

6. Haga clic o pulse Guardar.

Añadir un módulo de interfaz de usuario

Añada un módulo de interfaz de usuario de ContextHub en un modo de interfaz de usuario para que aparezca en la barra de herramientas de ContextHub para obtener una vista previa del contenido de la página. Cuando agrega un módulo de interfaz de usuario, está creando una instancia de un tipo de módulo registrado con ContextHub. Para agregar un módulo de interfaz de usuario, debe conocer el nombre del tipo de módulo asociado.

AEM proporciona un tipo de módulo de interfaz de usuario base, así como varios tipos de módulo de interfaz de usuario de ejemplo en los que puede basar un módulo de interfaz de usuario. La siguiente tabla proporciona una breve descripción de cada una. Para obtener información sobre el desarrollo de un módulo de interfaz de usuario personalizado, consulte Creación de módulos de interfaz de usuario de ContextHub.

Las propiedades del módulo UI incluyen una configuración detallada en la que puede proporcionar valores para propiedades específicas del módulo. La configuración detallada se proporciona en formato JSON. La columna Tipo de módulo de la tabla proporciona vínculos a información sobre el código JSON necesario para cada tipo de módulo de interfaz de usuario.

1. En el carril del Experience Manager, toque o haga clic en Herramientas > Sitios > ContextHub.

2. Toque o haga clic en el Contenedor de configuración al que desee agregar un módulo de interfaz de usuario.

3. Haga clic o escriba la Configuración de ContextHub a la que desea agregar el módulo de interfaz de usuario.

4. Toque o haga clic en el modo de IU al que está agregando el módulo de IU.

5. Toque o haga clic en el botón Crear y, a continuación, toque o haga clic en ContextHub UI Module (genérico).

   

6. Proporcione valores para las siguientes propiedades:

   • Título del módulo UI: Título que identifica el módulo de interfaz de usuario
   • Tipo de módulo: El tipo de módulo
   • Habilitado: Seleccione esta opción para mostrar el módulo de interfaz de usuario en la barra de herramientas de ContextHub

7. (Opcional) Para anular la configuración de almacenamiento predeterminada, introduzca un objeto JSON para configurar el módulo de interfaz de usuario.

8. Haga clic o pulse Guardar.

Creación de una tienda de ContextHub

Cree un almacén de Context Hub para conservar los datos de usuario y acceder a ellos según sea necesario. Las tiendas de ContextHub se basan en los candidatos de las tiendas registradas. Cuando crea la tienda, necesita el valor de storeType con el que se registró el candidato de la tienda. (Consulte Creación de candidatos de tienda personalizados).

Configuración detallada del almacén

Al configurar una tienda, la propiedad Configuración de detalles permite proporcionar valores para propiedades específicas de la tienda. El valor se basa en el parámetro config de la función init del almacén. Por lo tanto, si necesita proporcionar este valor, y el formato del valor, depende de la tienda.

El valor de la propiedad Configuración de detalles es un objeto config en formato JSON.

Candidatos de tienda de muestra

AEM proporciona los siguientes candidatos de almacén de muestra en los que puede basar una tienda.

1. En el carril del Experience Manager, toque o haga clic en Herramientas > Sitios > ContextHub.

2. Toque o haga clic en el contenedor de configuración predeterminado.

3. Haga clic o toque Configuración de Contexthub

4. Para agregar una tienda, toque o haga clic en el icono Crear y, a continuación, toque o haga clic en Configuración de la tienda ContexHub.

   

5. Proporcione valores para las propiedades de configuración básicas y toque o haga clic en Siguiente:

   • Título de configuración: el título que identifica el almacén
   • Tipo de almacén: el valor de la propiedad storeType del candidato de almacén en el que se basa el almacén
   • Requerido: Seleccionar
   • Habilitado: seleccione esta opción para habilitar la tienda

6. (Opcional) Para anular la configuración predeterminada del almacén, introduzca un objeto JSON en el cuadro Configuración de detalles (JSON).

7. Haga clic o pulse Guardar.

Ejemplo: Uso de un servicio JSONP

Este ejemplo ilustra cómo configurar una tienda y mostrar los datos en un módulo de interfaz de usuario. En este ejemplo, el servicio MD5 del sitio jsontest.com se utiliza como fuente de datos para una tienda. El servicio devuelve el código hash MD5 de una cadena determinada, en formato JSON.

Se ha configurado un almacén contexthub.generic-jsonp para que almacene datos para la llamada de servicio https://md5.jsontest.com/?text=%22text%20to%20md5%22. El servicio devuelve los siguientes datos que se muestran en un módulo de interfaz de usuario:

{
   "md5": "919a56ab62b6d5e1219fe1d95248a2c5",
   "original": "\"text to md5\""
}

Creación de una tienda contexthub.generic-jsonp

El candidato de almacén de muestras contexthub.generic-jsonp le permite recuperar datos de un servicio JSONP o un servicio Web que devuelve datos JSON. Para este candidato a tienda, utilice la configuración de la tienda para proporcionar detalles sobre el servicio JSONP que se va a utilizar.

La función init de la clase ContextHub.Store.JSONPStore Javascript define un objeto config que inicializa este candidato de almacén. El objeto config contiene un objeto service que incluye detalles sobre el servicio JSONP. Para configurar el almacén, debe proporcionar el objeto service en formato JSON como valor de la propiedad Configuración de detalles.

Para guardar datos del servicio MD5 del sitio jsontest.com, utilice el procedimiento de Creación de una tienda ContextHub con las siguientes propiedades:

• Título de configuración: md5

• Tipo de tienda: contexthub.generic-jsonp

• Requerido: Seleccionar

• Habilitado: Seleccionar

• Configuración detallada (JSON):

  {
   "service": {
   "jsonp": false,
   "timeout": 1000,
   "ttl": 1800000,
   "secure": false,
   "host": "md5.jsontest.com",
   "port": 80,
   "params":{
   "text":"text to md5"
       }
     }
   }
  

Añadir un módulo de interfaz de usuario para los datos de md5

Añada un módulo de interfaz de usuario a la barra de herramientas de ContextHub para mostrar los datos almacenados en la tienda md5 de ejemplo. En este ejemplo, el módulo contexthub.base se utiliza para producir el siguiente módulo de interfaz de usuario:

Utilice el procedimiento de Añadir un módulo de interfaz de usuario para agregar el módulo de interfaz de usuario a un modo de interfaz de usuario existente, como el modo de interfaz de usuario Perona de ejemplo. Para el módulo de interfaz de usuario, utilice los siguientes valores de propiedad:

• Título del módulo de interfaz de usuario: MD5

• Tipo de módulo: contexthub.base

• Configuración detallada (JSON):

  {
   "icon": "coral-Icon--data",
   "title": "MD5 Converstion",
   "storeMapping": { "md5": "md5" },
   "template": "<p> {{md5.original}}</p>;
                <p>{{md5.md5}}</p>"
  }
  

Depuración de ContextHub

Se puede habilitar un modo de depuración para ContextHub para permitir la resolución de problemas. El modo de depuración se puede habilitar mediante la configuración de ContextHub o mediante CRXDE.

Mediante la Configuración

Edite la configuración de ContextHub y marque la opción Depurar

1. En el carril, toque o haga clic en Herramientas > Sitios > ContextHub
2. Toque o haga clic en el Contenedor de configuración predeterminado
3. Seleccione la Configuración de ContextHub y toque o haga clic en Editar elemento seleccionado
4. Haga clic o toque Depurar y toque o haga clic en Guardar

Mediante CRXDE

Use CRXDE Lite para establecer la propiedad debug en true en:

• /conf/global/settings/cloudsettings o
• /conf/<tenant>/settings/cloudsettings

Modo silencioso

El modo silencioso suprime toda la información de depuración. A diferencia de la opción de depuración normal, que se puede establecer de forma independiente para cada configuración de ContextHub, el modo silencioso es una configuración global que tiene prioridad sobre cualquier configuración de depuración en el nivel de configuración de ContextHub.

Esto resulta útil para la instancia de publicación, donde no desea ninguna información de depuración. Dado que es una configuración global, se habilita mediante OSGi.

1. Abra la Configuración de la consola web de Adobe Experience Manager en http://<host>:<port>/system/console/configMgr
2. Buscar ContextHub de granito de Adobe
3. Haga clic en la configuración ContextHub de granito de Adobe para editar sus propiedades
4. Marque la opción Modo silencioso y haga clic en Guardar

Recuperación de las configuraciones de ContextHub tras la actualización

Cuando se realiza una actualización a AEM, se realiza una copia de seguridad de las configuraciones de ContextHub y se almacenan en una ubicación segura. Durante la actualización, se instalan las configuraciones predeterminadas de ContextHub, reemplazando las configuraciones existentes. La copia de seguridad es necesaria para conservar los cambios o adiciones que haya realizado.

Las configuraciones de ContextHub se almacenan en una carpeta denominada contexthub en los nodos siguientes:

• /conf/global/settings/cloudsettings
• /conf/<tenant>/settings/cloudsettings

Después de una actualización, la copia de seguridad se almacena en una carpeta denominada contexthub bajo un nodo denominado:

/conf/global/settings/cloudsettings/default-pre-upgrade_yyyymmdd_xxxxxxx o
/conf/<tenant>/settings/cloudsettings/default-pre-upgrade_yyyymmdd_xxxxxxx

La porción yyyymmdd del nombre del nodo es la fecha en que se realizó la actualización.

Para recuperar las configuraciones de ContextHub, utilice CRXDE Lite para copiar los nodos que representan sus tiendas, modos de interfaz de usuario y módulos de interfaz de usuario desde debajo del nodo default-pre-upgrade_yyyymmdd_xxxxxx a continuación:

• /conf/global/settings/cloudsettings o
• /conf/<tenant>/settings/cloudsettings