Création de groupes d'affichage de widgets Commerce Composer

Créez un groupe d'affichage de widgets pour organiser les widgets disponibles dans la fenêtre Ajout de widgets dans des emplacements. Lorsque les utilisateurs professionnels choisissent d'ajouter un widget à un emplacement de modèle de présentation, l'utilisateur peut utiliser le groupe d'affichage de widgets pour filtrer les widgets qui s'affichent dans la fenêtre Ajout de widgets dans des emplacements.

Pourquoi et quand exécuter cette tâche

La fenêtre Ajouter des widgets aux emplacements inclut tous les widgets auxquels un magasin est abonné et qui sont enregistrés dans la structure Commerce Composer. Par défaut, ces widgets sont organisés en groupes d'affichage de widgets suivants pour filtrer les widgets qui s'affichent en même temps dans la fenêtre :
AnyPage
Ensemble de widgets à utiliser sur n'importe quelle page. Ce groupe s'affiche en tant qu'option Widgets de page quelconque dans la fenêtre Ajout de widgets dans des emplacements.
CategoryPage
Ensemble de widgets à utiliser sur les pages de catégorie. Ce groupe s'affiche en tant qu'option Widgets de page de catégorie dans la fenêtre Ajout de widgets dans des emplacements.
CatalogEntryPage
Ensemble de widgets à utiliser sur les pages d'entrée de catalogue. Ce groupe s'affiche en tant qu'option Widgets de page d'entrée de catalogue dans la fenêtre Ajout de widgets dans des emplacements.
SearchPage
Ensemble de widgets à utiliser sur une page de résultats de recherche. Ce groupe s'affiche en tant qu'option Widgets de page de résultats de recherche dans la fenêtre Ajout de widgets dans des emplacements.
Figure 1. Fenêtre Ajouter des widgets aux emplacements. La fenêtre inclut la liste déroulante avec les groupes d'affichage de widgets disponibles.

Fenêtre Ajouter des widgets aux emplacements.

Si vous créez des widgets personnalisés, vous pouvez créer un groupe d'affichage de widgets pour inclure vos widgets personnalisés. Si vous créez de nouveaux types de pages à gérer avec l'outil Commerce Composer, vous pouvez créer un groupe d'affichage de widgets pour ce type de page. Votre nouveau groupe peut inclure tous les widgets qu'un utilisateur Management Center peut ajouter aux emplacements de modèle de présentation pour ce nouveau type de page.

Pour créer un groupe d'affichage de widgets, vous devez créer une définition d'objet Management Center pour le groupe et définir les propriétés de texte du groupe. Après avoir défini la définition d'objet de votre nouveau groupe et reconstruit le projet LOBTools, la structure Management Center est mise à jour pour inclure votre groupe dans l'outil Commerce Composer. Pour créer les fichiers de code source pour décrire la définition de l'objet de groupe d'affichage de widgets et les propriétés du texte, vous pouvez utiliser l'une des options suivantes :
  • Utilisez une définition d'objet de groupe d'affichage de widgets existante comme modèle pour créer la définition d'objet de votre nouveau groupe d'affichage de widgets. Les étapes suivantes décrivent la procédure de cette option.
  • Utilisez la transformation JET avec un fichier d'entrée du modèle pour générer un nouveau package de code qui inclut les fichiers de code source pour votre nouveau groupe d'affichage de widgets. Si vous choisissez d'utiliser cette méthode, vous devez déplacer ou fusionner les fichiers générés dans votre projet LOBTools existant. Lorsque vous créez le fichier d'entrée du modèle à utiliser avec la transformation JET, assurez-vous d'inclure l'élément <widgetGroup> et les attributs correspondants pour générer les fichiers de votre groupe d'affichage de widgets. Si vous créez uniquement les fichiers de code source pour un groupe d'affichage de widgets, n'incluez pas l'élément <widgetDef>. Vous pouvez utiliser la transformation JET pour créer les fichiers de code source pour un seul groupe d'affichage de widgets lorsque vous exécutez la transformation.

    Pour plus d'informations sur l'utilisation de la transformation JET afin de générer vos fichiers de code source, voir Génération du code source du widget Commerce Composer. Pour plus d'informations sur le déplacement des fichiers générés dans votre projet LOBTools, voir Ajout de la prise en charge Management Center pour un widget Commerce Composer.

Procédure

  1. Démarrez HCL Commerce Developer. Basculez vers la vue Explorateur d'entreprise.
  2. Facultatif : Si la structure de fichiers n'existe pas, créez la structure de fichiers pour inclure vos actifs Commerce Composer personnalisés.
    1. Accédez au répertoire LOBTools\WebContent\WEB-INF\src\xml.
    2. Créez un dossier pour contenir vos actifs personnalisés.
      Par exemple, vous pouvez nommer le répertoire MyCompany.
    3. Dans ce répertoire, créez la structure de dossiers pagelayout\widgetDefinitions.
    4. Accédez au répertoire LOBTools\src\com.
    5. Créez un dossier pour contenir vos actifs personnalisés.
      Par exemple, vous pouvez nommer le répertoire MyCompany.
    6. Dans ce répertoire, créez la structure de dossiers commerce\pagelayout\client\lobtools\properties.
    7. Accédez au répertoire LOBTools\WebContent\WEB-INF\src\xml.
    8. Créez un dossier pour contenir vos actifs personnalisés.
      Par exemple, vous pouvez nommer le répertoire MyCompany.
    9. Ce répertoire peut être créé dans le répertoire pagelayout.
  3. Créez un fichier de définition d'objet pour votre nouveau groupe d'affichage de widgets.
    1. Accédez au répertoire LOBTools\WebContent\WEB-INF\src\xml\commerce\pagelayout\widgetDefinitions.
    2. Copiez d'un des fichiers de définition d'objet de groupe de widgets fournis par défaut.
      Par exemple, copiez le fichier AnyPageWidgetGroup.xml.
    3. Accédez au répertoire LOBTools\WebContent\WEB-INF\src\xml\MyCompany\pagelayout\widgetDefinitions.
    4. Ajoutez votre fichier de définition d'objet copié dans ce répertoire.
    5. Renommez votre fichier de définition d'objet copié. Utilisez le format WidgetGroupIdentifierWidgetGroup.xml, où WidgetGroupIdentifier est la valeur de l'identificateur de votre nouveau groupe d'affichage de widgets.
      Par exemple, si vous créez un groupe d'affichage de widgets pour les widgets personnalisés créés par votre entreprise, vous pouvez nommer le fichier, MyCompanyCustomPageWidgetGroup.xml.
    6. Ouvrez le fichier pour l'éditer.
      Par défaut, le fichier inclut le code suivant pour définir un groupe d'affichage de widgets :
      <?xml version="1.0" encoding="UTF-8"?>
      <!--
       =================================================================
        Licensed Materials - Property of IBM
      
        HCL Commerce
      
        (C) Copyright IBM Corp. 2015 All Rights Reserved.
      
        US Government Users Restricted Rights - Use, duplication or
        disclosure restricted by GSA ADP Schedule Contract with
        IBM Corp.
       =================================================================
      -->
      <Definitions>
      	<LayoutWidgetGroup definitionName="cmc/pagelayout/AnyPageWidgetGroup" 
                                displayName="${pageLayoutResources.widgetGroupDisplayName_AnyPage}" 
                                identifier="AnyPage" 
                                package="cmc/pagelayout" 
                                parentDefinition="cmc/pagelayout/NewPageLayoutWidgetDialog">
      		<dependency localName="pageLayoutResources" moduleName="cmc/pagelayout/PageLayoutResources"/>
      	</LayoutWidgetGroup>
      </Definitions>
      
      definitionName
      Le nom de la définition de la définition de l'objet de groupe d'affichage de widgets.
      displayName
      Le nom du groupe d'affichage de widgets qui s'affiche dans la fenêtre Ajout de widgets dans des emplacements dans l'outil Commerce Composer. La valeur de cet attribut est définie dans le fichier de propriétés du texte PageLayoutLOB.properties. Ce fichier se trouve dans le répertoire LOBTools\src\com\ibm\commerce\pagelayout\client\lobtools\properties.
      identifier
      Le nom d'identification du groupe d'affichage de widgets.
      lot
      Le nom du package pour les groupes d'affichage de widgets dans l'espace de travail.
      parentDefinitionName
      Le nom de la définition d'objet parent.
    7. Mettez à jour les valeurs de la définition d'objet pour définir votre nouveau groupe de widgets.
    8. Enregistrez et fermez le fichier.
  4. Créez ou mettez à jour un fichier de propriétés pour inclure le texte de votre groupe d'affichage de widgets.
    1. Accédez au répertoire LOBTools\src\com\ibm\commerce\pagelayout\client\lobtools\properties.
    2. Facultatif : Si un fichier de propriétés n'existe pas pour vos actifs personnalisés, créez-en. Nommez le fichier PageLayoutLOB.properties.
    3. Ouvrez le fichier PageLayoutLOB.properties pour l'éditer.
    4. Ajoutez le code suivant pour définir le nom d'affichage de votre groupe d'affichage de widgets :
      widgetGroupDisplayName_WidgetGroupIdentifier=widgetGroupDisplayName
      WidgetGroupIdentifier est la valeur de l'identificateur de votre nouveau groupe d'affichage de widgets. Par exemple,
      widgetGroupDisplayName_MyCompanyCustomPage=Custom widgets for any page
    5. Enregistrez et fermez le fichier.
  5. Enregistrez la propriété de texte de votre groupe d'affichage de widgets dans un regroupement de ressources.
  6. Si vous avez créé un fichier de regroupement de ressources pour enregistrer les propriétés de texte de votre groupe d'affichage de widgets, incluez le nouveau regroupement de ressources partout où il est utilisé.
  7. Incluez n'importe quel widget approprié dans votre nouveau groupe d'affichage de widgets. Pour chaque widget que vous souhaitez inclure dans le groupe, mettez à jour la définition d'objet pour le widget.
    1. Accédez au répertoire qui inclut les définitions d'objet pour vos widgets de magasin.
      • Si vous souhaitez inclure un widget disponible par défaut, accédez au répertoire suivant :
        • LOBTools\WebContent\WEB-INF\src\xml\commerce\pagelayout\widgetDefinitions
      • Si vous souhaitez inclure un widget personnalisé, accédez au répertoire suivant :
        • LOBTools\WebContent\WEB-INF\src\xml\MyCompany\pagelayout\widgetDefinitions
    2. Développez le répertoire qui inclut les définitions du widget que vous souhaitez inclure dans votre groupe d'affichage de widgets.
    3. Ouvrez le fichier de définition d'objet métier pour l'éditer.
    4. Localisez l'attribut widgetDisplayGroups dans l'élément de définition d'objet widget.
    5. Mettez à jour les valeurs de l'attribut pour inclure votre groupe d'affichage de widgets.
      Par exemple, pour un widget inclus dans le groupe d'affichage des widgets CatalogEntryPage, l'attribut mis à jour peut ressembler au code suivant :
      widgetDisplayGroups="CatalogEntryPage,MyCompanyCustomPage"
    6. Enregistrez et fermez le fichier.
  8. Vérifiez que votre groupe d'affichage de widgets est disponible dans la fenêtre Ajout de widgets dans des emplacements de l'outil Commerce Composer. Créez une présentation. Lorsque vous choisissez d'ajouter un widget à un emplacement de modèle, assurez-vous que vous pouvez filtrer en fonction de votre nouveau groupe d'affichage de widgets. Vérifiez que seuls les widgets que vous avez inclus dans ce groupe s'affichent lorsque vous sélectionnez votre groupe d'affichage de widgets.