Ajout de ContextHub à des pages et accès à des magasins adding-contexthub-to-pages-and-accessing-stores
Ajoutez ContextHub à vos pages pour activer les fonctionnalités ContextHub et créer un lien vers les bibliothèques JavaScript ContextHub
L’API JavaScript ContextHub permet d’accéder aux données contextuelles gérées par ContextHub. Cette page décrit brièvement les principales fonctionnalités de l’API pour accéder aux données contextuelles et les manipuler. Suivez les liens vers la documentation de référence de l’API pour consulter des informations détaillées et des exemples de code.
Ajout de ContextHub à un composant de page adding-contexthub-to-a-page-component
Pour activer les fonctionnalités ContextHub et créer un lien vers les bibliothèques JavaScript ContextHub, incluez le composant contexthub dans la variable head de votre page. Le code JSP de votre composant de page ressemble à l’exemple suivant :
<head>
<sling:include path="contexthub" resourceType="granite/contexthub/components/contexthub" />
</head>
Notez que vous devez également configurer si la barre d’outils ContextHub s’affiche en mode Aperçu. Voir Affichage et masquage de l’IU ContextHub.
À propos des magasins ContextHub about-contexthub-stores
Utilisez les magasins ContextHub pour conserver les données contextuelles. ContextHub fournit les types de magasins suivants qui constituent la base de tous les types de magasins :
Tous les types de magasins sont des extensions de la classe ContextHub.Store.Core. Pour plus d’informations sur la création d’un type de magasin, voir Création de magasins personnalisés. Pour plus d’informations sur les exemples de types de magasin, voir Exemples de candidats de magasins ContextHub.
Modes de persistance persistence-modes
Les magasins ContextHub utilisent l’un des modes de persistance suivants :
- Local : Utilise HTML5 localStorage pour conserver les données. Le stockage local est conservé dans le navigateur entre les sessions.
- Session : utilise HTML5 sessionStorage pour conserver les données. Le stockage de session est conservé pendant la durée de la session du navigateur et est disponible pour toutes les fenêtres du navigateur.
- Cookie : Utilise la prise en charge native des cookies par le navigateur pour le stockage des données. Les données de cookie sont envoyées vers et depuis le serveur dans les requêtes HTTP.
- Window.name : utilise la propriété window.name pour conserver les données.
- Memory : utilise un objet JavaScript pour conserver les données.
Par défaut, ContextHub utilise le mode de persistance local. Si le navigateur ne prend pas en charge ou n’autorise pas HTML5 localStorage, la persistance de session est utilisée. Si le navigateur ne prend pas en charge ou n’autorise pas HTML5 sessionStorage, la persistance Window.name est utilisée.
Données du magasin store-data
En interne, le stockage des données forme une arborescence, permettant l’ajout de valeurs sous la forme de types Principaux ou d’objets complexes. Lorsque vous ajoutez des objets complexes aux magasins, les propriétés de l’objet forment des branches dans l’arborescence de données. Par exemple, l’objet complexe suivant est ajouté à un magasin vide nommé location :
Object {
number: 321,
data: {
city: "Basel",
country: "Switzerland",
details: {
population: 173330,
elevation: 260
}
}
}
L’arborescence des données du magasin peut être conceptualisée comme suit :
/
|- number
|- data
|- city
|- country
|- details
|- population
|- elevation
L’arborescence définit les éléments de données du magasin sous la forme de paires clé/valeur. Dans l’exemple ci-dessus, la clé /number correspond à la valeur 321 et la clé /data/country à la valeur Switzerland.
Manipulation d’objets manipulating-objects
ContextHub fournit la classe ContextHub.Utils.JSON.tree pour manipuler des objets JavaScript. Utilisez les fonctions de cette classe pour manipuler des objets JavaScript avant de les ajouter à un magasin ou après les avoir récupérés d’un magasin.
En outre, la classe ContextHub.Utils.JSON fournit des fonctions pour sérialiser des objets en chaînes et désérialiser des chaînes en objets. Utilisez cette classe pour gérer les données JSON afin de prendre en charge les navigateurs qui n’intègrent pas, en natif, les fonctions JSON.parse et JSON.stringify.
Interaction avec les magasins ContextHub interacting-with-contexthub-stores
Utilisez l’objet JavaScript ContextHub pour obtenir un magasin comme objet JavaScript. Une fois que vous avez obtenu l’objet de magasin, vous pouvez manipuler les données qu’il contient. Utilisez la fonction getAllStores ou getStore pour obtenir le magasin.
Accès aux données du magasin accessing-store-data
La classe JavaScript ContexHub.Store.Core définit plusieurs fonctions permettant d’interagir avec les données du magasin. Les fonctions suivantes stockent et récupèrent plusieurs éléments de données contenus dans des objets :
Les éléments de données individuels sont stockés sous la forme d’un ensemble de paires clé/valeur. Pour stocker et récupérer des valeurs, spécifiez la clé correspondante :
Notez que les magasins candidats personnalisés peuvent définir des fonctions supplémentaires qui permettent d’accéder aux données du magasin.
Génération d’événements ContextHub contexthub-eventing
ContextHub comprend un framework d’événements qui vous permet de répondre automatiquement aux événements du magasin. Chaque objet du magasin contient un objet ContextHub.Utils.Eventing disponible sous la forme d’une propriété eventing du magasin. Utilisez la fonction on ou once pour lier une fonction JavaScript à un événement de magasin.
Utilisation de ContextHub pour manipuler des cookies using-context-hub-to-manipulate-cookies
L’API JavaScript ContextHub offre une prise en charge de plusieurs navigateurs pour la gestion des cookies de navigateur. L’espace de noms ContextHub.Utils.Cookie définit plusieurs fonctions permettant de créer, de manipuler et de supprimer des cookies.
Identification de segments ContextHub résolus determining-resolved-contexthub-segments
Le moteur de segments ContextHub vous permet de déterminer quels segments enregistrés sont résolus dans le contexte actuel. Utilisez la fonction getResolvedSegments de la classe ContextHub.SegmentEngine.SegmentManager pour récupérer les segments résolus. Utilisez ensuite la fonction getName ou getPath de la classe ContextHub.SegmentEngine.Segment pour tester un segment.
Segments installés installed-segments
Les segments ContextHub sont installés sous le nœud /conf/we-retail/settings/wcm/segments.
- femme
- female-over-30
- female-under-30
- homme
- male-over-30
- male-under-30
- order-value-75-to-100
- order-value-over-100
- over-30
- summer
- summer-female
- summer-female-over-30
- summer-female-under-30
- summer-male
- summer-male-over-30
- summer-male-under-30
- under-30
- winter
- winter-female
- winter-female-over-30
- winter-female-under-30
- winter-male
- winter-male-over-30
- winter-male-under-20
Les règles utilisées pour résoudre ces segments sont résumées comme suit :
-
Le sexe féminin ou masculin est déterminé à partir de la variable
genderélément de données du profile magasin. -
L’âge est déterminé à partir de l’élément de données d’âge de la banque de profils.
-
La saison est déterminée à partir de l’élément de données de latitude de la variable géolocalisation et l’élément de données month du magasin surferinfo.
Journalisation des messages de débogage pour ContextHub logging-debug-messages-for-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.debugsurtrue.
Affichage d’un aperçu de la structure ContextHub see-an-overview-of-the-contexthub-framework
ContextHub fournit une page de diagnostics qui affiche un aperçu de son framework.