Copie de widgets de niveau de site HCL Commerce

Vous pouvez copier et modifier un widget Commerce Composer existant pour l'utiliser comme modèle afin de créer votre propre widget personnalisé. Si vous avez besoin d'un widget qui offre presque la même fonctionnalité qu'un widget fourni par HCL Commerce, la meilleure pratique recommandée consiste à copier les ressources du widget fourni. Vous pouvez ensuite utiliser les ressources copiées pour modéliser votre propre widget personnalisé qui est une copie du widget fourni par défaut. Avec votre version personnalisée du widget, vous pouvez ensuite modifier votre widget pour répondre aux exigences de conception et de fonctionnalité de votre magasin.

Important : Par défaut, vous ne pouvez pas modifier le code source d'un widget du Commerce Composer fourni par HCL Commerce. La fonctionnalité de ces widgets est fournie telle quelle pour aider les professionnels à créer des pages pour votre magasin. Toutefois, vous pouvez personnaliser l'apparence de ces widgets sur vos pages de magasin en modifiant le code CSS de votre magasin. Le code source des widgets fournis par HCL Commerce peut être mis à jour par les versions ultérieures, telles que les correctifs de maintenance requis ou recommandés. Toutes les modifications personnalisées à ces widgets fournis par défaut sont remplacées par ces mises à jour.

Pourquoi et quand exécuter cette tâche

Le processus de copie des actifs d'un widget fourni par HCL Commerce pour créer votre propre version personnalisée de ce widget est similaire au processus de création d'un widget. Pour en savoir plus sur la création, l'enregistrement et l'abonnement à un nouveau widget, voir Création de widgets Commerce Composer. Pour copier un widget existant, suivez les instructions suivantes :

Procédure

  1. Copiez les ressources de vitrine pour le widget que vous souhaitez copier au lieu de générer votre propre code source personnalisé. Incluez les actifs copiés dans un nouveau dossier pour votre widget personnalisé dans votre dossier widgets-vendor. Modifiez les ressources copiées pour personnaliser l'affichage et le comportement de la vitrine de ce nouveau widget.
  2. Créez un fichier CSV registerWidgetDef.csv à utiliser pour l'enregistrement du nouveau widget au sein de la structure Commerce Composer.
    Pour en savoir plus sur les données pouvant être incluses dans ce fichier, voir fichier d'entrée registerWidgetdef.
    Conseil : Copiez et modifiez les informations d'inscription pour le widget que vous copiez pour vous aider à définir les informations d'inscription de votre nouveau widget. Récupérez les informations d'enregistrement du widget dans le fichier suivant. Ce fichier inclut les informations d'enregistrement pour les widgets fournis par défaut avec HCL Commerce.
    • WCDE_installdir\schema\xml\wcs.features_bootstrap.xml
    Lorsque vous copiez et modifiez les informations, assurez-vous de convertir le format des informations pour une utilisation dans un fichier CSV.
    Par exemple, les informations d'enregistrement du widget de navigation des facettes dans le fichier XML d'amorçage des améliorations du magasin ressemblent au fragment de code suivant : 
    
<plwidgetdef 
 plwidgetdef_id="-2004" 
 storeent_id="0" 
 identifier="FacetNavigation_701" 
 ui_object_name="FacetNavigationWidget" 
 vendor="ibm" 
 widgettype="1" 
 jsppath="/Widgets_701/com.ibm.commerce.store.widgets.FacetNavigation/FacetNavigation.jsp"
 definitionxml="
 &lt;Definition&gt;
  &lt;widget-property name=&quot;widgetRestrictionGroups&quot;&gt;
   &lt;value&gt;CategoryPage,SearchPage&lt;/value&gt;
  &lt;/widget-property&gt;
  &lt;widget-property name=&quot;widgetOrientation&quot; &gt;
   &lt;value&gt;vertical&lt;/value&gt;
  &lt;/widget-property&gt;
  &lt;widget-property name=&quot;_pgl:javaScriptInclude&quot;&gt;
   &lt;value&gt;
    ${staticAssetContextRoot}${env_siteWidgetsDir}com.ibm.commerce.store.widgets.CatalogEntryList/javascript/SearchBasedNavigationDisplay.js
   &lt;/value&gt;
  &lt;/widget-property&gt;
 &lt;/Definition&gt;
 "
 state="1"
 createdate="2012-06-25 17:29:25.562"
 lastupdate="2012-06-25 17:29:25.562"
/>
    Lorsque vous convertissez le format de votre fichier CSV, mettez à jour toutes les valeurs de colonne que vous souhaitez ou devez modifier. Assurez-vous de modifier les valeurs de toutes les colonnes qui pointent vers les fichiers de ressources de vitrine pour le widget que vous avez copié pour pointer vers l'emplacement des fichiers de votre nouveau widget. Par exemple, mettez à jour la valeur de la colonne WidgetPath pour pointer vers le fichier JSP de la ressource de vitrine que vous avez copié et modifié. Une fois que vous avez converti le format de ces informations d'enregistrement, votre fichier CSV peut ressembler au format de l'exemple de fichier registerWidgetDef.csv suivant :
    Remarque : Si vous copiez un widget pour modifier uniquement les ressources et le comportement de la vitrine du widget, vous pouvez utiliser les interactions et l'affichage Management Center pour le widget que vous avez copié pour la copie de votre widget. Pour conserver la prise en charge existante Management Center intacte, ne modifiez pas la valeur de la colonne WidgetUIObjectName lorsque vous convertissez l'élément ui_object_name de votre fichier CSV. Par exemple, si vous copiez le widget de navigation des facettes, conservez la valeur pour que la valeur de la colonne WidgetUIObjectName soit définie sur FacetNavigationWidget.
  3. Exécutez l'utilitaire Chargement des données pour charger le fichier CSV afin d'enregistrer votre widget.
  4. Si vous copiez l'un des widgets suivants pour remplacer le widget fourni, mettez à jour la configuration des struts pour utiliser votre widget.
    • Widget Liste des entrées de catalogue
    • Widget IBM Product Recommendations
    • Widget Liste des contenus du site
    • Widget Recommandation d'entrée de catalogue
    • Widget Ressources associées
    • Widget Disponibilité des stocks
    Identifiez l'entrée de configuration des struts pour votre widget dans le fichier workspace_dir\Stores\WebContent\WEB-INF\struts-config-widgets.xml (pour HCL Commerce version 9.0.0.x) ou workspace_dir\Stores\WebContent\WEB-INF\classes\struts-wcs-stores-widgets.xm (pour la version 9.0.1+). Passez en revue l'entrée pour le widget que vous copiez et créez une entrée équivalente pour pointer vers votre chemin JSP de widget.
  5. Désabonnez votre magasin du widget fourni lorsque vous abonnez votre magasin à votre copie du widget.
  6. Mettez à jour ou créez des présentations pour vos pages de magasin afin d'inclure votre nouveau widget au lieu du widget fourni par défaut que vous avez copié.