Configuration de ContextHub

ContextHub est un framework permettant de stocker, manipuler et présenter des données contextuelles. Pour plus de détails sur ContextHub, voir Aperçu du développeur ContextHub.

Vous pouvez configurer la barre d’outils ContextHub pour contrôler si elle apparaît dans le mode d’aperçu, afin de créer des magasins ContextHub et d’ajouter des modules d’IU.

Affichage et masquage de l’IU ContextHub

Configurez le service Adobe Granite ContextHub OSGi pour afficher ou masquer l’IU ContextHub sur vos pages. Le PID de ce service est com.adobe.granite.contexthub.impl.ContextHubImpl.

Pour configurer le service, vous pouvez utiliser la Console web ou un nœud JCR du référentiel :

• Console web : pour afficher l’IU, sélectionnez la propriété Afficher l’IU. Pour masquer l’interface utilisateur, désélectionnez la propriété Masquer l’interface utilisateur .
• Nœud JCR : pour afficher l’IU, définissez la propriété booléenne com.adobe.granite.contexthub.show_ui sur true. Pour masquer l’IU, définissez la propriété sur false.

Si l’IU ContextHub est activée, elle s’affiche uniquement sur les pages sur les instances de création AEM. L’interface utilisateur n’apparaît pas sur les pages des instances de publication.

Ajout des modes et des modules d’IU ContextHub

Configurez les modes et modules d’IU qui s’affichent dans la barre d’outils ContextHub en mode Aperçu :

• Modes d’IU : Groupes de modules connexes
• Modules : Widgets qui exposent les données contextuelles d’un magasin et permettent aux auteurs de manipuler le contexte

Les modes d’IU s’affichent sous forme d’une série d’icônes dans la partie gauche de la barre d’outils. Lorsque cette option est sélectionnée, les modules d’un mode d’IU s’affichent à droite.

Les icônes sont des références de la bibliothèque d’icônes CoralUI.

Ajout d’un mode d’IU

Ajoutez un mode d’IU afin de regrouper les modules ContextHub associés. Lorsque vous créez le mode d’IU, vous fournissez le titre et l’icône qui s’affichent dans la barre d’outils ContextHub.

1. Sur le rail du Experience Manager, cliquez ou appuyez sur Outils > Sites > ContextHub.

2. Cliquez ou appuyez sur Conteneur de configuration par défaut.

3. Cliquez ou appuyez sur Configuration ContextHub.

4. Cliquez ou appuyez sur le bouton Créer, puis sur Mode d’IU ContextHub.

   

5. Saisissez les valeurs pour les propriétés suivantes :

   • Titre du mode d’IU : titre qui identifie le mode d’IU.
   • Icône de mode : sélecteur de l’icône de CoralUI à utiliser ; par exemple coral-Icon--user.
   • Activé : Sélectionnez cette option pour afficher le mode d’IU dans la barre d’outils ContextHub.

6. Cliquez ou appuyez sur Enregistrer.

Ajout d’un module d’IU

Ajoutez un module d’IU ContextHub à un mode d’IU afin qu’il s’affiche dans la barre d’outils ContextHub pour prévisualiser le contenu d’une page. Lorsque vous ajoutez un module d’IU, vous créez une instance d’un type de module qui est enregistré auprès de ContextHub. Pour ajouter un module d’IU, vous devez connaître le nom du type de module associé.

AEM propose un type de module d’IU de base, ainsi que plusieurs types de modules d’IU d’exemple sur lesquels vous pouvez baser un module d’IU. Le tableau suivant présente une brève description de chacun d’entre eux. Pour plus d’informations sur le développement d’un module d’IU personnalisé, voir Création de modules d’IU ContextHub.

Les propriétés du module d’IU incluent une configuration de détails où vous pouvez fournir des valeurs pour des propriétés spécifiques au module. Vous fournissez la configuration de détails au format JSON. La colonne Type de module du tableau fournit des liens vers des informations sur le code JSON requis pour chaque type de module d’IU.

1. Sur le rail du Experience Manager, cliquez ou appuyez sur Outils > Sites > ContextHub.

2. Cliquez ou appuyez sur le conteneur de configuration auquel vous souhaitez ajouter un module d’IU.

3. Cliquez ou saisissez la configuration ContextHub à laquelle vous souhaitez ajouter le module d’IU.

4. Cliquez ou appuyez sur le mode d’IU auquel vous ajoutez le module d’IU.

5. Cliquez ou appuyez sur le bouton Créer, puis sur Module d’IU ContextHub (générique).

   

6. Saisissez les valeurs pour les propriétés suivantes :

   • Titre du module d’IU : Titre qui identifie le module d’IU.
   • Type de module : Type de module
   • Activé : Sélectionnez cette option pour afficher le module d’IU dans la barre d’outils ContextHub.

7. (Facultatif) Pour remplacer la configuration de magasin par défaut, saisissez un objet JSON pour configurer le module d’IU.

8. Cliquez ou appuyez sur Enregistrer.

Création d’un magasin ContextHub

Créez un magasin ContextHub pour conserver les données utilisateur et accéder aux données selon vos besoins. Les magasins ContextHub sont basés sur des candidats de magasins enregistrés. Lorsque vous créez le magasin, vous avez besoin de la valeur du paramètre storeType avec lequel le candidat de magasin a été enregistré. (Voir Création de candidats de magasin personnalisés.)

Configuration de magasin détaillée

Lorsque vous configurez un magasin, la propriété Configuration de détails vous permet de fournir des valeurs pour les propriétés spécifiques au magasin. La valeur est basée sur le paramètre config de la fonction init du magasin. Par conséquent, la nécessité de fournir ou non cette valeur et son format dépend du magasin.

La valeur de la propriété Configuration de détails est un objet config au format JSON.

Exemples de candidats de magasins

AEM fournit des exemples de candidats de magasins sur lesquels vous pouvez baser un magasin.

1. Sur le rail du Experience Manager, cliquez ou appuyez sur Outils > Sites > ContextHub.

2. Cliquez ou appuyez sur le conteneur de configuration par défaut.

3. Cliquez ou appuyez sur Configuration ContextHub

4. Pour ajouter un magasin, cliquez ou appuyez sur l’icône Créer, puis sur Configuration de magasin ContextHub.

   

5. Indiquez les valeurs des propriétés de configuration de base, puis cliquez ou appuyez sur Suivant :

   • Titre de configuration : Titre qui identifie le magasin
   • Type de magasin : La valeur de la propriété storeType du magasin candidat sur lequel baser le magasin
   • Obligatoire : sélectionnez cette option.
   • Activé : Sélectionnez cette option pour activer le magasin.

6. (Facultatif) Pour remplacer la configuration de magasin par défaut, saisissez un objet JSON dans la zone Configuration des détails (JSON).

7. Cliquez ou appuyez sur Enregistrer.

Exemple : en utilisant un service JSONP

Cet exemple illustre comment configurer un magasin et afficher les données dans un module d’IU. Dans cet exemple, le service MD5 du site jsontest.com est utilisé comme source de données pour un magasin. Le service renvoie le code de hachage MD5 d’une chaîne donnée, au format JSON.

Le magasin contexthub.generic-jsonp est configuré de sorte qu’il stocke les données de l’appel de service https://md5.jsontest.com/?text=%22text%20to%20md5%22. Le service renvoie les données suivantes qui s’affichent dans un module d’IU :

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

Création d’un magasin contexthub.generic-jsonp

L’exemple de candidat de magasin contexthub.generic-jsonp vous permet de récupérer les données d’un service JSONP ou web qui renvoie des données JSON. Pour ce candidat de magasin, utilisez la configuration de magasin afin de fournir les détails du service JSONP à utiliser.

La fonction init de la classe JavaScript ContextHub.Store.JSONPStore définit un objet config qui initialise ce candidat de magasin. L’objet config contient un objet service qui inclut des détails sur le service JSONP. Pour configurer le magasin, il vous suffit de fournir l’objet service au format JSON comme valeur de la propriété Configuration de détails.

Pour enregistrer les données à partir du service MD5 du site jsontest.com, suivez la procédure décrite dans Création d’un magasin ContextHub à l’aide des propriétés suivantes :

• Titre de configuration : md5

• Type de magasin : contexthub.generic-jsonp

• Obligatoire : sélectionnez cette option.

• Activé : sélectionnez cette option.

• Configuration des détails (JSON) :

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

Ajout d’un module d’IU pour les données MD5

Ajoutez un module d’IU à la barre d’outils ContextHub pour afficher les données stockées dans l’exemple de magasin MD5. Dans cet exemple, le module contexthub.base est utilisé pour générer le module d’IU suivant :

Utilisez la procédure décrite dans Ajout d’un module d’IU pour ajouter le module d’IU à un mode d’IU existant, comme l’exemple de mode d’IU Persona. Pour le module d’IU, utilisez les valeurs de propriété suivantes :

• Titre du module d’IU : MD5

• Type de module : contexthub.base.

• Configuration des détails (JSON) :

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

Débogage de ContextHub

Une procédure de débogage pour ContextHub peut être activée afin de permettre la résolution des incidents. Le mode de débogage peut être activé via la configuration ContextHub ou via CRXDE.

Via la configuration

Modifiez la configuration de ContextHub et cochez l’option Débogage.

1. Dans le rail, cliquez ou appuyez sur Outils > Sites > ContextHub
2. Cliquez ou appuyez sur la valeur par défaut. Conteneur de configuration
3. Sélectionnez la Configuration ContextHub et cliquez ou appuyez sur Modifier l’élément sélectionné
4. Cliquez ou appuyez sur Débogage et cliquez ou appuyez sur Enregistrer.

Via CRXDE

Utilisez CRXDE Lite pour définir la propriété debug sur true sous :

• /conf/global/settings/cloudsettings ou
• /conf/<site>/settings/cloudsettings

Journalisation des messages de débogage pour ContextHub

Configurez le service OSGi ContextHub d’Adobe Granite (PID = com.adobe.granite.contexthub.impl.ContextHubImpl) pour consigner des messages de débogage détaillés qui s’avèrent utiles dans le cadre du développement.

Pour configurer le service, vous pouvez utiliser la Console web ou un nœud JCR du référentiel :

• Console web : pour consigner des messages de débogage, sélectionnez la propriété Debug.
• Nœud JCR : pour consigner des messages de débogage, définissez la propriété booléenne com.adobe.granite.contexthub.debug sur true.

Mode silencieux

Le mode silencieux supprime toutes les informations de débogage. Contrairement à l’option de débogage normal, qui peut être définie séparément pour chaque configuration ContextHub, le mode silencieux est un paramètre global qui est prioritaire par rapport à tout paramètre de débogage au niveau de la configuration de ContextHub.

Cela est utile pour votre instance de publication, où vous ne souhaitez pas voir d’informations de débogage. Puisqu’il s’agit d’un paramètre global, il est activé via OSGi.

1. Ouvrez la Configuration de la console web Adobe Experience Manager à l’adresse http://<host>:<port>/system/console/configMgr
2. Recherchez Adobe Granite ContextHub.
3. Cliquez sur la configuration Adobe Granite ContextHub pour en modifier les propriétés.
4. Cochez l’option Mode silencieux et cliquez sur Enregistrer.

Désactivation de ContextHub

ContextHub peut être désactivé pour éviter qu’il charge js/css et s’initialise. Il existe deux options pour désactiver ContextHub :

• Modifiez la configuration de ContextHub et cochez l’option Désactiver ContextHub

  1. Dans le rail, cliquez ou appuyez sur Outils > Sites > ContextHub
  2. Cliquez ou appuyez sur la valeur par défaut. Conteneur de configuration
  3. Sélectionnez la Configuration ContextHub et cliquez ou appuyez sur Modifier l’élément sélectionné
  4. Cliquez ou appuyez sur Désactivation de ContextHub et cliquez ou appuyez sur Enregistrer

ou

• Utilisez CRXDE Lite pour définir la propriété disabled sur true sous /conf/global/settings/cloudsettings/<configName>/contexthub.

Ressources Business.Adobe.com