Création de groupes de restrictions widgets Commerce Composer

Créez un groupe de restrictions de widgets pour contrôler les widgets qui peuvent être inclus dans un emplacement de modèle de présentation à l'aide de Commerce Composer. Lorsque les utilisateurs professionnels choisissent d'ajouter un widget à un emplacement de modèle de présentation, seuls les widgets dont l'utilisation est limitée à un emplacement sont disponibles dans la fenêtre Ajout de widgets dans des emplacements.

Pourquoi et quand exécuter cette tâche

Les groupes de restrictions de widgets sont utilisés pour restreindre les emplacements dans les modèles de présentation pour qu'ils n'incluent que des widgets provenant de groupes de widgets définis. Lorsqu'un utilisateur professionnel sélectionne un emplacement de modèle qui est limité pour inclure uniquement des widgets dans un groupe de restrictions de widgets, l'utilisateur peut sélectionner uniquement les widgets de groupe dans la fenêtre Ajout de widgets dans des emplacements. Si un widget est inclus dans un groupe de restrictions de widgets, les utilisateurs peuvent toujours inclure le widget dans les emplacements qui ne sont pas limités à ce groupe de restrictions de widgets. Par exemple, dans un modèle de présentation de page de catégorie, vous pouvez restreindre un emplacement dans la barre latérale gauche pour inclure uniquement les widgets Navigation de catégorie et navigation dans les facettes.

Par défaut, vous pouvez inclure un widget dans les groupes de widgets suivants et restreindre un emplacement de modèle pour inclure uniquement les widgets qui appartiennent à l'un des groupes suivants :

AnyPage: Ensemble de widgets à utiliser sur n'importe quelle page.
CategoryPage: Ensemble de widgets à utiliser sur les pages de catégorie.
CatalogEntryPage: Ensemble de widgets à utiliser sur les pages d'entrée de catalogue.
SearchPage: Ensemble de widgets à utiliser sur une page de résultats de recherche.
WidgetForTabTitle: Ensemble de widgets à utiliser comme titre d'onglet dans un modèle d'agencement qui inclut les emplacements à onglets. Par défaut, le widget Editeur de texte est inclus dans ce groupe et peut être utilisé comme titre d'onglet. Par défaut, ce groupe est le seul groupe de widgets que les emplacements de modèle incluent en tant que groupe de restrictions de widgets spécifié.

Les groupes de restrictions de widgets qui sont autorisés à être inclus dans un emplacement sont définis pour l'emplacement dans la colonne PROPRIETES de la table de base de données PLWIDGETSLOT. Vous pouvez ajouter un widget à un groupe de restrictions de widgets en mettant à jour la définition XML du widget. Pour qu'un widget soit inclus dans un emplacement de modèle restreint, la valeur de la propriété du groupe de restrictions de widgets dans le XML de définition de widget doit correspondre à la valeur de la propriété du groupe de restrictions de widgets pour l'emplacement de modèle dans la table PLWIDGETSLOT. Les administrateurs peuvent utiliser Data Load utility code pour mettre à jour le XML de définition afin de mettre à jour les groupes auxquels appartient un widget. Les administrateurs peuvent également utiliser Data Load utility pour mettre à jour les groupes de restrictions de widgets pour un emplacement de modèle dans la table PLWIDGETSLOT.

Remarque : Si vous devez copier un groupe de restrictions de widgets Commerce Composer d'une instance vers une autre, vous pouvez utiliser les utilitaires d'extraction de données et de chargement de données. Utilisez Data Extract utility pour extraire les données du modèle de présentation, qui inclut les données du groupe de restrictions de widgets. Ensuite, utilisez Data Load utility pour charger uniquement les données d'enregistrement de widgets et de définition d'emplacement de maquette fonctionnelle de modèle en spécifiant le paramètre -DLoadOrder lorsque vous exécutez l'utilitaire. Pour plus d'informations, voir .Pour plus d'informations, voir Extraction de données Commerce Composer avec l'Utilitaire d'extraction de donnée.

Procédure

Définissez le groupe de restrictions de widgets pour l'emplacement du modèle de présentation.

Créez un fichier CSV pour mettre à jour la définition de l'emplacement du modèle de présentation pour l'emplacement que vous souhaitez restreindre afin d'inclure uniquement les widgets dans un groupe.
Votre fichier CSV doit inclure des valeurs pour toutes les colonnes obligatoires et inclure les valeurs existantes pour toutes les colonnes facultatives définies. Si vous n'incluez pas ces valeurs, Data Load utility remplace les valeurs existantes. Votre fichier CSV doit inclure le nom du groupe de restrictions de widgets dans la colonne qui se charge dans la colonne PROPRIETES de la table PLWIDGETSLOT. Vous devez redéfinir la maquette fonctionnelle pour l'emplacement et ajouter le groupe de restrictions de widgets à cette définition de maquette fonctionnelle. Utilisez une liste séparée par des virgules dans les guillemets pour inclure les deux propriétés dans un fichier CSV. Utilisez le format suivant pour définir la valeur pour cette colonne :
```
"xLocation:00;yLocation:00;width:00;height:00;allowedWidgetGroups:WidgetGroupIdentifier"
```
Où WidgetGroupIdentifier est la valeur de l'identificateur que vous souhaitez utiliser pour nommer votre nouveau groupe de restrictions de widgets.
Par exemple, le fichier CSV suivant met à jour un emplacement dans le modèle de présentation DefaultSearchResultLayout qui ne peut inclure que des widgets qui appartiennent au groupe de restrictions de widgets SearchPage.
```
LayoutName,AdminName,SlotAdminName,SlotID,SlotType,SlotProperty
DefaultSearchResultLayout,SearchResultPageContainer,8,8,1,"xLocation:40;yLocation:164;width:126;height:54;allowedWidgetGroups:SearchPage"
```
Vous pouvez définir plusieurs groupes de restrictions de widgets pour un emplacement et inclure plus de lignes pour définir les groupes de restrictions de widgets pour d'autres emplacements que vous souhaitez restreindre.
Pour en savoir plus sur la manière de remplir ce fichier CSV, voir fichier d'entrée slotDefinition.
Configurez Data Load utility pour charger ce fichier CSV dans votre base de données HCL Commerce avec Data Load utility.
Pour charger ces informations, vous devez disposer des fichiers de configuration de chargement des données requis. Des exemples de fichiers de configuration sont notamment disponibles pour que vous puissiez charger les informations du modèle de présentation.
Localisez le fichier de configuration de la commande de chargement wc-dataload-template.xml. Accédez au répertoire suivant d'un utilitaire de gestionnaire de fichiers :
- WCDE_installdir\components\foundation\samples\DataLoad\CommerceComposer\template
Copiez ce fichier. Mettez à jour l'exemple de fichier de configuration de commande de chargement copié pour pointer vers votre fichier CSV au lieu du fichier slotDefinition.csv par défaut. Commentez les fichiers CSV restants de sorte que seul votre fichier CSV se charge lorsque vous exécutez Data Load utility. Le fichier de configuration de commande de chargement identifie l'ordre selon lequel Data Load utility charge les exemples de fichier CSV. Le fichier de l'ordre de chargement identifie également le fichier de configuration d'objet métier approprié à utiliser pour charger chaque fichier d'entrée. Pour plus d'informations sur les fichiers de configuration de commande de chargement, voir Configuration de l'ordre de chargement des données.
Recherchez l'exemple de fichier de configuration de l'environnement wc-dataload-env.xml. Accédez au répertoire suivant d'un utilitaire de gestionnaire de fichiers :
- WCDE_installdir\components\foundation\samples\DataLoad\CommerceComposer
Mettez à jour le fichier pour qu'il corresponde aux valeurs de votre environnement. Vérifiez que les valeurs Business Context et Database spécifiées sont correctes. Pour plus d'informations, voir Configuration des paramètres d'environnement de chargement de données.
Localisez l'exemple de fichier de configuration d'objet métier wc-loader-widgetslot.xml. Accédez au répertoire suivant d'un utilitaire de gestionnaire de fichiers :
- WCDE_installdir\components\foundation\samples\DataLoad\CommerceComposer
Si vous n'avez pas donné aux colonnes de votre fichier CSV un nom différent de celui des colonnes identifiées dans le sujet fichier d'entrée slotDefinition, vous n'avez pas besoin de modifier ce fichier. Si vous avez utilisé différents noms de colonne, vous devez copier ce fichier et mettre à jour la copie pour configurer le fichier afin qu'il corresponde à vos nouveaux noms de colonne. Pour plus d'informations sur la configuration de ce fichier, voir Configuration du fichier de configuration d'objet métier.
Exécutez Data Load utility pour définir le groupe de restrictions de widgets pour l'emplacement du modèle.
1. Ouvrez un utilitaire de ligne de commande et accédez au répertoire approprié :
  - WCDE_installdir\bin
2. Entrez la commande suivante pour exécuter le fichier de commande de chargement des données afin de charger les informations sur la définition d'emplacement du modèle mises à jour :
  - ./dataload.sh ../components/foundation/samples/DataLoad/CommerceComposer/template/wc-dataload-template.xml
  - dataload.bat ..\components\foundation\samples\DataLoad\CommerceComposer\template\wc-dataload-template.xml
  - dataload ..\components\foundation\samples\DataLoad\CommerceComposer\template\wc-dataload-template.xml
3. Vérifiez les résultats du processus de chargement en examinant le rapport récapitulatif du chargement des données. Pour plus d'informations sur l'emplacement et le contenu de ce rapport récapitulatif, voir Vérification du résultat du chargement des données.
  Vous pouvez également vérifier que le groupe de restrictions de widgets est défini comme une propriété pour l'emplacement du modèle en exécutant les instructions SQL suivantes sur votre base de données HCL Commerce :
```
select * from PLWIDGETSLOT;
```
  Assurez-vous que les données qui se trouvent dans votre fichier d'entrée CSV existent dans les tables de base de données PLWIDGETSLOT.

Mettez à jour le XML de définition pour tous les widgets appropriés afin d'inclure les widgets dans votre nouveau groupe de restrictions de widgets.

Créez un fichier d'entrée CSV pour mettre à jour le XML de définition de chaque widget que vous souhaitez inclure dans le groupe de restrictions de widgets.
Votre fichier CSV doit identifier les groupes de restrictions de widgets pour un widget qui se présente sous la forme d'une paire nom-valeur de propriété dans le XML de définition qui se charge dans la colonne DEFINITIONXML de la table de base de données PLWIDGETDEF.
Utilisez le format suivant pour définir le XML de définition et la propriété du groupe de restrictions d'un widget pour un widget :
```
<Definition> <widget-property name="widgetRestrictionGroups"><value>WidgetGroupIdentifier</value></widget-property> </Definition>
```
Où
nom

Nom de la propriété. Dans ce cas, vous devez spécifier le nom en tant que "widgetRestrictionGroups".

valeur
Les identificateurs de tous les groupes de restrictions de widgets auxquels le widget appartient. Utilisez une liste séparée par des virgules pour inclure plusieurs groupes. Par exemple, le XML de définition suivant définit qu'un widget appartient à trois groupes de restrictions de widgets :
<Definition> <widget-property name="widgetRestrictionGroups"><value>SearchPage,CatalogEntryPage,AnyPage</value></widget-property> </Definition>
Le fichier CSV suivant met à jour le XML de définition de SearchSummaryWidget pour qu'il se trouve dans le groupe de restrictions de widgets SearchPage et AnyPage. Ce CSV inclut les noms de colonne et seul un enregistrement, qui est séparé sur trois lignes à des fins de lisibilité. Lorsque vous chargez votre fichier d'entrée CSV, ne séparez pas un enregistrement unique sur plusieurs lignes.
```
WidgetDefIdentifier,WidgetStoreUniqueID,WidgetUIObjectName,WidgetType,WidgetVendor,WidgetPath,WidgetState,WidgetDefinitionxml,WidgetDisplayName,WidgetDescription,Delete
SearchSummary,0,SearchSummaryWidget,1,ibm,/Widgets/com.ibm.commerce.store.widgets.SearchSummary/SearchSummary.jsp,1,
<Definition><widget-property name="widgetRestrictionGroups"><value>SearchPage,AnyPage</value></widget-property></Definition>,Search Summary Widget,	
'Displays the search term that the customer used, the number of search results, and offers suggested search terms when there are no matches.'  
```
Vous pouvez inclure un widget dans plusieurs groupes de restrictions dans votre fichier CSV. Ajoutez plus de lignes pour inclure plus de widgets dans les groupes de restrictions de widgets.
Pour en savoir plus sur la manière de remplir ce fichier CSV, voir fichier d'entrée registerWidgetdef.
Configurez Data Load utility pour charger ce fichier CSV dans votre base de données HCL Commerce avec Data Load utility.
Pour charger ces informations, vous devez disposer des fichiers de configuration de chargement des données requis. Des exemples de fichiers de configuration sont notamment disponibles pour que vous puissiez les utiliser pour charger les informations de définition de widget.
Localisez le fichier de configuration de la commande de chargement wc-dataload-widget.xml. Accédez au répertoire suivant d'un utilitaire de gestionnaire de fichiers :
- WCDE_installdir\components\foundation\samples\DataLoad\CommerceComposer\widget
Copiez ce fichier. Mettez à jour l'exemple de fichier de configuration de commande de chargement copié pour pointer vers votre fichier CSV au lieu du fichier registerWidgetdef.csv par défaut. Commentez les fichiers CSV restants de sorte que seul votre fichier CSV se charge lorsque vous exécutez Data Load utility =.
Data Load utility utilise le même fichier de configuration d'environnement wc-dataload-env.xml que celui que vous avez utilisé pour charger les informations d'emplacement du modèle afin de charger les informations de définition de widget.
Localisez l'exemple de fichier de configuration d'objet métier wc-loader-registerWidgetdef.xml. Accédez au répertoire suivant d'un utilitaire de gestionnaire de fichiers :
- WCDE_installdir\components\foundation\samples\DataLoad\CommerceComposer
Si vous n'avez pas donné aux colonnes de votre fichier CSV un nom différent de celui des colonnes identifiées dans le sujet fichier d'entrée registerWidgetdef, vous n'avez pas besoin de modifier ce fichier. Si vous avez utilisé différents noms de colonne, vous devez copier ce fichier et mettre à jour la copie pour configurer le fichier afin qu'il corresponde à vos nouveaux noms de colonne.
Exécutez Data Load utility pour définir le groupe de restrictions de widgets pour le widget.
1. Ouvrez un utilitaire de ligne de commande et accédez au répertoire approprié :
  - WCDE_installdir\bin
2. Entrez la commande suivante pour exécuter le fichier de commande de chargement des données afin de charger les informations de définition de widget :
  - ./dataload.sh ../components/foundation/samples/DataLoad/CommerceComposer/widget/wc-dataload-widget.xml
  - dataload.bat ..\components\foundation\samples\DataLoad\CommerceComposer\widget\wc-dataload-widget.xml
  - dataload ..\components\foundation\samples\DataLoad\CommerceComposer\widget\wc-dataload-widget.xml
3. Vérifiez les résultats du processus de chargement en examinant le rapport récapitulatif du chargement des données.
  Vous pouvez également vérifier que le groupe de restriction de widgets est défini comme une propriété pour l'emplacement du modèle en exécutant les instructions SQL suivantes sur votre base de données HCL Commerce :
```
select * from PLWIDGETDEF;
select * from PLWDIGETDEFDESC;
```
  Assurez-vous que les données qui se trouvent dans votre fichier d'entrée CSV existent dans les tables de base de données.
Vérifiez que les emplacements de modèle de présentation mis à jour sont limités dans Commerce Composer pour inclure uniquement les widgets que vous avez inclus dans vos nouveaux groupes de restrictions de widgets. Pour vérifier que le groupe de widgets est créé et appliqué avec succès, créez une présentation dans Commerce Composer. Lorsque vous créez cette présentation, sélectionnez le modèle de votre présentation mis à jour à utiliser. Lorsque vous choisissez de renseigner l'emplacement du modèle mis à jour, assurez-vous que seuls les widgets de votre nouveau groupe de widgets sont disponibles pour que vous puissiez les inclure dans l'emplacement du modèle.