Exemple : Extraction d'agencements Commerce Composer

Cet exemple explique comment extraire des agencements Commerce Composer pour un magasin avec l'Utilitaire d'extraction de donnée. Ensuite, vous pouvez utiliser l'pour l'utilitaire de chargement de données pour charger les données extraites dans une autre instance ou un autre magasin HCL Commerce afin de copier rapidement des agencements d'une instance ou d'un magasin à l'autre.

Un agencement est une organisation de widgets d'agencement dans un modèle d'agencement qui est utilisé pour afficher une page de magasin. Un agencement contient un ou plusieurs widgets qui sont placés à des emplacements spécifiques dans le modèle. Les propriétés (paires nom-valeur) de chaque widget dans un agencement sont associées à des valeurs spécifiques. Pour plus d'informations sur les agencements, voir Agencements, modèles d'agencement et agencements par défaut.

Avant de commencer

Vous devez exécuter les tâches suivantes :
  • Vérifiez que le magasin depuis lequel extraire des données contient des données d'agencement Commerce Composer à extraire.
Remarque : si vous prévoyez de charger les données extraites dans une autre instance, l'outil Commerce Composer doit être activé dans le magasin dans lequel charger les données. Le magasin type Aurora a été activé pour utiliser l'outil Commerce Composer.

A propos de cet exemple

Lorsque vous exécutez cet exemple, l'Utilitaire d'extraction de donnée est configuré pour extraire les agencements uniquement pour le magasin que vous spécifiez. Vous pouvez spécifier le magasin dans le fichier de configuration de l'environnement ou directement sur la ligne de commande lorsque vous exécutez l'utilitaire.

Lorsque vous exécutez cet exemple, l'utilitaire extrait également les données de modèle d'agencement et les données de relation de tout widget affecté aux agencements pour le magasin spécifié. Les données pour les widgets d'agencement qui sont enregistrés auprès d'un magasin ou abonnés à un magasin ne sont pas extraites. Vous devez extraire ces données de widget au cours d'une opération distincte. Pour plus d'informations sur l'extraction de ces données de widget, voir Exemple : Extraction de widgets Commerce Composer.

Les exemples de fichier de configuration qui sont utilisés pour configurer l'Utilitaire d'extraction de donnée se trouvent dans le répertoire et les sous-répertoires suivants :
  • HCL Commerce DeveloperWCDE_installdir\samples\DataExtract\CommerceComposer

Exemples de fichier de configuration

Les fichiers de configuration ci-après sont utilisés pour configurer l'Utilitaire d'extraction de donnée en vue de l'extraction de données dans des fichiers de sortie CSV.
wc-dataextract-env.xml
Fichier de configuration de l'environnement. Il inclut les variables d'environnement pour votre instance HCL Commerce. Ces variables incluent les informations suivantes :
  • Variables de contexte métier, notamment l'identificateur de magasin, l'identificateur de catalogue, ainsi que la langue et la devise par défaut pour votre magasin.
  • Paramètres d'environnement de base de données, notamment le type, le nom et le schéma de base de données.
wc-dataextract-layout.xml
Fichier de configuration de l'ordre d'extraction des données. Il spécifie les chemins d'accès au fichier de configuration de l'environnement et aux fichiers de configuration d'objet métier pour chaque type d'objet. Il identifie également l'ordre dans lequel l'Utilitaire d'extraction de donnée extrait les données et identifie les fichiers de sortie que l'utilitaire génère afin d'inclure les données extraites.
wc-extract-business-object.xml
Fichier de configuration d'objet métier. Il définit la façon dont l'utilitaire identifie les données à extraire ainsi que le médiateur d'objet métier dont l'utilitaire doit se servir afin de transformer les données extraites. Dans cet exemple, tous les fichiers de configuration d'objet métier configurent l'utilitaire en vue de l'utilisation du médiateur d'objet métier suivant :

com.ibm.commerce.foundation.dataload.businessobjectmediator.AssociationObjectMediator

Les fichiers de configuration d'objet métier suivants sont utilisés afin de configurer l'Utilitaire d'extraction de donnée pour cet exemple :
wc-extract-registerWidgetdef.xml
Ce fichier est utilisé pour configurer l'utilitaire afin d'extraire les données d'enregistrement du conteneur de modèles d'agencement. L'utilitaire extrait ces données depuis les tables de base de données suivantes :L'utilitaire génère le fichier registerWidgetdef.csv afin d'inclure les données extraites. Ce fichier peut ensuite être utilisé afin de charger des données permettant d'enregistrer un nouveau conteneur de modèles d'agencement dans l'outil Commerce Composer. Pour plus d'informations sur les données pouvant être incluses dans ce fichier, voir fichier d'entrée registerWidgetdef.
wc-extract-subscribeWidgetdef.xml
Deux fichiers wc-extract-registerWidgetdef.xml sont utilisés dans cet exemple. Ils sont utilisés pour configurer l'utilitaire en vue de l'extraction des données d'abonnement des conteneurs de modèles d'agencement et des widgets. L'utilitaire extrait les données pour les deux types d'objet depuis la table de base de données suivante :L'utilitaire génère 2 fichiers de sortie subscribeWidgetdef.csv afin d'inclure les données extraites. Ces fichiers peuvent ensuite être utilisés afin de charger les données permettant d'abonner des widgets et des conteneurs de modèles d'agencement à un magasin.
  • Le fichier subscribeWidgetdef.csv dans le répertoire layout inclut des données d'abonnement de widget.
  • Le fichier subscribeWidgetdef.csv dans le répertoire template inclut des données d'abonnement de conteneur de modèles d'agencement.
Pour plus d'informations sur les données pouvant être incluses dans ces fichiers, voir Fichier d'entrée subscribeWidgetdef.
wc-extract-template.xml
Ce fichier est utilisé pour configurer l'utilitaire en vue de l'extraction de données de modèle d'agencement de base. L'utilitaire extrait ces données depuis la table de base de données suivante :L'utilitaire génère le fichier de sortie template.csv afin d'inclure ces données extraites. Ce fichier peut ensuite être utilisé afin de charger les données permettant de créer des modèles d'agencement dans l'outil Commerce Composer. Pour plus d'informations sur les données pouvant être incluses dans ce fichier, voir fichier d'entrée de modèle.
wc-extract-slotDefinition.xml
Ce fichier est utilisé pour configurer l'utilitaire en vue de l'extraction des définitions d'emplacement de maquette fonctionnelle de site Web pour les modèles d'agencement. Chaque emplacement de maquette fonctionnelle de site Web est défini par des coordonnées X et Y et est utilisé pour organiser les widgets dans un agencement. L'utilitaire extrait ces données depuis la table de base de données suivante :L'utilitaire génère le fichier de sortie slotdefinition.csv afin d'inclure les données extraites. Ce fichier peut ensuite être utilisé afin de charger les données permettant d'affecter les coordonnées de maquette fonctionnelle de site Web à un agencement. Pour plus d'informations sur les données pouvant figurer dans ce fichier, voir fichier d'entrée slotDefinition
wc-extract-pagelayout.xml
Ce fichier est utilisé pour configurer l'utilitaire en vue de l'extraction de données d'agencement de base pour les agencements qui existent pour un magasin. L'utilitaire extrait ces données depuis les tables de base de données suivantes : L'utilitaire génère le fichier de sortie layout.csv afin d'inclure les données extraites. Ce fichier peut ensuite être utilisé afin de charger les données permettant de créer des agencements dans un magasin. Pour plus d'informations sur les données pouvant figurer dans ce fichier, voir fichier d'entrée d'agencement.
wc-extract-widget.xml
Ce fichier est utilisé pour configurer l'utilitaire en vue de l'extraction des données de relation pour l'affectation de widgets et de conteneurs de modèles d'agencement à des agencements. L'utilitaire extrait ces données depuis les tables de base de données suivantes : L'utilitaire génère le fichier layoutWidgetRelationship.csv afin d'inclure les données extraites. Ce fichier peut ensuite être utilisé pour affecter des widgets à des agencements dans un autre magasin ou dans une autre instance. Pour plus d'informations sur les données pouvant figurer dans ce fichier, voir fichier d'entrée layoutWidgetRelationship.
wc-extract-widgetnvp.xml
Ce fichier est utilisé pour configurer l'utilitaire en vue de l'extraction de données pour les propriétés de paire nom-valeur des widgets qui sont affectés à des agencements. L'utilitaire extrait ces données depuis la table de base de données suivante :L'utilitaire génère le fichier widgetnvp.csv afin d'inclure les données extraites. Ce fichier peut ensuite être utilisé afin de configurer les propriétés pour les widgets qui sont affectés aux agencements d'un magasin. Pour plus d'informations sur les données pouvant figurer dans ce fichier, voir widgetnvp fichier d'entrée.

Procédure

  1. Copiez les exemples de fichier de configuration et les répertoires dans un répertoire local.
  2. Editez votre copie de l'exemple de fichier de configuration de l'environnement afin de définir les variables de configuration pour votre environnement. L'exemple de fichier de configuration qui est utilisé dans cet exemple inclut des valeurs pour un environnement HCL Commerce Developer par défaut qui utilise une base de données Apache Derby. Si vos paramètres d'environnement sont différents, vous devez changer les valeurs configurées dans votre fichier de configuration de l'environnement pour qu'elles correspondent à votre environnement. Pour plus d'informations sur la mise à jour d'un fichier de configuration de l'environnement, voir Configuration des paramètres d'environnement de chargement de données.
  3. HCL Commerce DeveloperDans une ligne de commande, accédez au répertoire WCDE_installdir\bin.
  4. LinuxOuvrez une ligne de commande dans le . Accédez au répertoire utilities_root/bin. Pour plus d'informations sur l'entrée et la sortie des conteneurs, voir Exécution des utilitaires à partir de Utility server Docker container.
  5. Entrez la commande suivante pour exécuter l'exemple de configuration de l'ordre d'extraction des données afin d'extraire les données d'agencement dans des fichiers de sortie CSV :
    • Linux./dataextract.sh ../samples/DataExtract/CommerceComposer/wc-dataextract-layout.xml
    • HCL Commerce Developerdataextract ..\samples\DataExtract\CommerceComposer\wc-dataextract-layout.xml
Une fois que l'utilitaire a terminé le processus d'extraction, il génère les fichiers de sortie CSV dans le répertoire et les sous-répertoires de sortie configurés. Ces fichiers incluent des données pour tous les agencements qui existent pour l'ID de magasin configuré. Ils incluent également les données pour les modèles d'agencement qui sont utilisés par les agencements et les données de relation pour tout widget affecté aux agencements. Par défaut, les fichiers sont générés dans le répertoire et les sous-répertoires de sortie suivants :
  • Linuxutilities_root/samples/DataExtract/CommerceComposer/output
  • HCL Commerce DeveloperWCDE_installdir\samples\DataExtract\CommerceComposer\output

Vérification des résultats

  1. Accédez au répertoire que vous avez configuré comme répertoire de sortie. Si vous n'avez pas configuré de répertoire de sortie, accédez au répertoire suivant :
    • Linuxutilities_root/samples/DataExtract/CommerceComposer/output
    • HCL Commerce DeveloperWCDE_installdir\samples\DataExtract\CommerceComposer\output
  2. Vérifiez que les fichiers de sortie CSV suivants ont été générés :
    • template/registerWidgetdef.csv
    • template/subscribeWidgetdef.csv
    • template/template.csv
    • template/slotDefinition.csv
    • layout/subscribeWidgetdef.csv
    • layout/layout.csv
    • layout/layoutWidgetRelationship.csv
    • layout/widgetnvp.csv
  3. Ouvrez les fichiers de sortie CSV afin d'examiner leur contenu.
  4. Vérifiez que le contenu des fichiers correspond aux données qui se trouvent dans la base de données pour les agencements appartenant au magasin spécifié.

Etapes suivantes

Vous pouvez charger les données que vous avez extraites dans une autre instance HCL Commerce avec l'pour l'utilitaire de chargement de données. Pour un exemple qui explique comment charger des données d'agencement, voir Exemple : Chargement d'agencements Commerce Composer. Si vous suivez cet exemple, éditez le fichier de configuration de l'ordre de chargement afin de spécifier les fichiers CSV qui ont été générés par l'Utilitaire d'extraction de donnée.