Configuration de l'intégration IBM Digital Data Exchange

Vous pouvez activer l'intégration entre HCL Commerce et IBM Digital Data Exchange (DDX) en mettant à jour la configuration du fournisseur d'analyse pour votre site.

Avant de commencer

Pour effectuer les étapes suivantes, assurez-vous que vous effectuez les tâches suivantes :

Intégrez votre magasin à IBM Digital Analytics. Les étapes suivantes utilisent une intégration à IBM Digital Analytics pour démontrer comment intégrer HCL Commerce à DDX pour transmettre des données à un fournisseur d'analyse.

Procédure

Accédez au répertoire suivant, qui contient le fichier déployé biConfig.xml pour votre intégration entre votre fournisseur d'analyse HCL Commerce, tel que IBM Digital Analytics.
- workspace_dir\crs-web\WebContent\WEB-INF\xml\config\bi
Ouvrez le fichier biConfig.xml pour l'éditer.
Ce fichier inclut les paramètres de configuration pour la façon dont HCL Commerce s'intègre à IBM Digital Analytics.
Mettez à jour la configuration du fournisseur d'analyse de votre site ou de vos magasins afin d'inclure l'option de configuration "useDDX".
Lorsque la valeur de cette option est définie sur "true" ou est incluse sans valeur, la sortie JavaScript pour toutes les balises d'analyse est incluse dans un objet JavaScript et envoyée à DDX. Incluez l'option dans l'élément <biprovider/> pour définir la configuration comme valeur par défaut pour chaque magasin associé à ce fournisseur d'analyse. Vous pouvez également remplacer le paramètre d'un magasin, en incluant l'option ayant une valeur différente dans la configuration de l'élément <store/> d'un magasin.
- Tous les magasins
```
<biprovider name="coremetrics"
 enabled="true"> 
 ...
 <options>
   <attribute name="useDDX" />
 </options>
 ...
</biprovider>
```
- Magasins spécifiques
```
<store 
 storeId="10101,10102,10103" 
 biprovider="coremetrics" 
 enabled="true"> 
 ...
 <options>
  <attribute name="useDDX" value="true" />
 </options> 
 ...
</store>
```
  Où storeId est la valeur de l'ID de magasin ou la liste des valeurs d'ID de magasin. Par exemple, "10101,10102,10103".
Mettez à jour la configurationoutput de votre site ou de vos magasins pour l'inclure la fonction cmSetClientID dans votre JavaScript si le paramètre n'est pas déjà configuré. Définissez les valeurs appropriées pour la fonction comme indiqué dans l'exemple suivant.
```
<output section="header">
<![CDATA[
...
<script type="text/javascript">
cmSetupNormalization("krypto-_-krypto");
cmSetClientID(Client_ID,Data_collection_method,Analytics_Provider_site,WebSphere_Commerce_server);
</script>                 
]]>
</output>
```
Où

Client_ID

ID client fourni par votre fournisseur d'analyse. Par exemple, "99999999".

Data_collection_method

La méthode de collecte des données. Définissez les valeurs suivantes :

true

Les cookies du navigateur de collecte de données sont gérés sur le client du navigateur, qui est défini dans le domaine spécifié comme la valeur WebSphere_Commerce_server.

false

Les cookies du navigateur de collecte de données sont gérés par votre fournisseur d'analyse, qui est défini dans le domaine spécifié comme la valeur Analytics_Provider_site.

Analytics_Provider_site

Nom de domaine de votre site d'analyse. Par exemple, "data.coremetrics.com".

WebSphere_Commerce_server

Nom du domaine de votre serveur HCL Commerce. Par exemple, "thesite.com".

Par exemple,
```
<output section="header">
<![CDATA[
...
<script type="text/javascript">
cmSetupNormalization("krypto-_-krypto");
cmSetClientID("99999999",true,"data.coremetrics.com","thesite.com");
</script>                 
]]>
</output>
```
Enregistrez et fermez le fichier.
Pour obtenir un exemple de fichier biConfig.xml complet et pour plus de paramètres de configuration que vous pouvez configurer lorsque vous utilisez IBM Digital Analytics comme fournisseur d'analyse, voir Exemple de fichier biConfig.xml pour IBM Digital Analytics :.
Ajoutez des valeurs de paramètres de type de page aux balises d'affichage de page sur vos pages de magasin pour identifier les entrées de données analytiques dans l'objet JavaScript envoyé à DDX.
Les magasins basés sur le magasin type HCL Commerce Aurora incluent déjà des valeurs de type de page (identificateur de page unique) définies dans digitalData.pageInstanceID. Si votre magasin n'est pas basé sur ce magasin type ou si vous souhaitez modifier les valeurs de type de page par défaut envoyées à DDX, incluez les valeurs de type de page sur les pages de votre magasin.
Par défaut, toutes les pages des magasins basés sur le magasin type HCL Commerce Aurora incluent une configuration par défaut qui associe la valeur "wcs-standardpages" à la balise d'affichage de la page. Certaines pages incluent également d'autres valeurs. Par exemple, la page du magasin type OrderItemDisplay.jsp Aurora inclut la configuration suivante du paramètre de type de page :
```
<cm:pageview pageType="wcs-cart"/>
```
Remarque : Si la prise en charge de l'intégration à DDX n'est pas activée, le paramètre et la valeur du type de page sont ignorés.
La balise d'affichage de page recueille des informations sur les pages de magasin qu'un client a consultées. Pour plus d'informations sur cette balise, voir Balise d'affichage de page.
HCL Commerce définit la valeur du paramètre de type de page dans digitalData.pageInstanceID. La valeur pageInstanceID est référencée lorsque vous configurez les règles du groupe de pages dans DDX pour déterminer si les balises affectées à ce groupe de pages sont déployées dans une page de magasin. De cette façon, les balises peuvent être logiquement regroupées à l'intérieur de DDX pour le déploiement à des types de pages qui doivent recevoir ces balises. Par exemple, les balises nécessaires pour collecter des informations sur la page et le produit à partir d'une page de panier d'achat sont ajoutées à un groupe de pages DDX avec une règle de pageInstanceID = 'wcs-cart'.
1. Ouvrez la page JSP pour la page magasin qui inclut la balise d'affichage de page dans laquelle vous incluez une valeur de paramètre de type de page.
2. Ajoutez le paramètre de type de page à la balise d'affichage de page sur les pages de votre magasin. Définissez la valeur du paramètre pour inclure tous les types de pages que vous souhaitez associer à la page.
  Lorsque vous incluez plusieurs valeurs, séparez les valeurs d'un caractère de soulignement "_".
  Par exemple, la page du magasin type OrderShippingBillingConfirmationPage.jsp Aurora inclut le paramètre de type de page et la configuration de valeur suivants :
```
<cm:pageview pageType="wcs-order_wcs-registration"/>
```
  Par défaut, les valeurs de paramètres suivantes sont disponibles pour une utilisation sur les pages du magasin type HCL Commerce Aurora.
  
  wcs-productdetail
  
  Cette valeur est incluse dans les pages pour identifier que les données ajoutées à l'objet JavaScript sont des données d'entrée de catalogue digitalData. Par exemple, cette valeur est incluse par défaut sur la page du magasin type ProductDisplay.jsp Aurora. Envisagez d'ajouter cette valeur aux pages qui incluent la balise <cm:product /> de produit.
  
  wcs-cart
  
  Cette valeur est incluse dans les pages pour identifier que les données ajoutées à l'objet digitalData JavaScript sont des données de panier d'achat. Par exemple, cette valeur est incluse par défaut sur la page du magasin type OrderItemDisplay.jsp Aurora. Envisagez d'ajouter cette valeur aux pages qui incluent la balise <cm:cart /> d'achat.
  
  wcs-registration
  
  Cette valeur est incluse dans les pages pour identifier que les données ajoutées à l'objet digitalData JavaScript sont liées à l'enregistrement ou à l'utilisateur. Par exemple, cette valeur est incluse par défaut sur la page du magasin type OrderShippingBillingConfirmationPage.jsp Aurora. Envisagez d'ajouter cette valeur aux pages qui incluent la balise <cm:registration /> d'inscription.
  
  wcs-order
  
  Cette valeur est incluse dans les pages pour identifier que les données ajoutées à l'objet digitalData JavaScript sont des données liées à la commande. Par exemple, cette valeur est incluse par défaut sur la page du magasin type OrderShippingBillingConfirmationPage.jsp Aurora. Envisagez d'ajouter cette valeur aux pages qui incluent la balise <cm:order /> de commande.
  
  wcs-element
  
  Cette valeur est incluse dans les pages pour identifier que les données ajoutées à l'objet digitalData JavaScript sont des données d'interaction client. Envisagez d'ajouter cette valeur aux pages qui incluent la balise <cm:element /> d'élément.
  
  wcs-conversionevent
  
  Cette valeur est incluse dans les pages pour identifier que les données ajoutées à l'objet digitalData JavaScript sont des données qui sont liées aux événements et qui ne sont pas liées aux achats de produits. Envisagez d'ajouter cette valeur aux pages qui incluent la balise <cm:conversion /> d'achat.
  
  wcs-standardpage
  
  Cette valeur est la valeur par défaut pour toutes les pages JSP du magasin qui incluent la balise d'affichage de page. Si vous ajoutez des pages personnalisées à votre magasin à partir desquelles vous souhaitez collecter des informations d'analyse à envoyer à DDX, ajoutez cette valeur.
  
  Vous pouvez remplacer la valeur "wcs-standardpage" ou d'autres valeurs par défaut en étendant la classe CommonBaseTag et en modifiant la valeur des variables qui détiennent ces valeurs. Par exemple, la variable qui détient la valeur "wcs-standardpage" est une variable protégée, DEFAULT_PAGE_TYPE. Vous pouvez également remplacer l'utilisation du caractère de soulignement "_" comme caractère séparateur. La variable qui détient cette valeur est également une variable protégée, DEFAULT_PAGE_TYPE_SEPARATOR dans la classe CommonBaseTag.
  Remarque : La configuration DDX n'affecte pas la fonctionnalité ou la sortie de la balise de campagne <cm:campurl />. Cette balise ne génère pas de section JavaScript dans la sortie, il n'y a donc pas de modification DDX correspondante. Lorsque vous activez la prise en charge de DDX, il n'y a pas de changement dans le comportement de la balise de campagne.
  Si vous n'incluez pas le paramètre de type de page sur vos pages de magasin, vous devez remplir l'une des configurations suivantes pour identifier vos entrées de données. Pour plus d'informations sur l'une ou l'autre des configurations suivantes, consultez la documentation fournie par DDX.
  - Définissez JavaScript pour détecter le type de page sur chaque page de magasin, par exemple en déterminant le type de page à partir de l'URL fournie par window.location.href dans JavaScript.
  - Utilisez le Gestionnaire de balises DDX pour enregistrer le code qui peut déterminer le type de page, par exemple à partir de l'URL fournie par window.location.href dans JavaScript.
  Si vous n'incluez pas de valeurs autres que la valeur du paramètre "wcs-standardpage" par défaut, la valeur suivante est la sortie de l'objet digitalData JavaScript :
```
digitalData = { pageInstanceID: "wcs-standardpage" }
```
  Si vous incluez d'autres valeurs de type de page, les valeurs sont ajoutées à la valeur "wcs-standardpage" de l'objet JavaScript :
```
digitalData = { pageInstanceID: "wcs-standardpage_wcs-order_wcs-registration" }
```
3. Configurez DDX pour créer les groupes de pages et les règles pour enregistrer les valeurs des paramètres de type de page et définir comment DDX doit relayer les données incluses dans l'objet digitalData JavaScript.
  Pour plus d'informations, voir la documentation fournie par DDX.

Résultats

Votre intégration analytique peut générer une sortie à envoyer à DDX. Avec cette sortie, toutes les données à envoyer à DDX et à transmettre à IBM Digital Analytics sont incluses dans l'objet digitalData JavaScript. Pour obtenir des exemples de la façon dont les balises d'analyse WebSphere Commerce existantes, qui incluent une valeur correspondante de paramètre de type de page, génèrent des données à l'objet JavaScript, voir