fichier d'entrée registerWidgetdef

Utilisez un fichier d'entrée registerWidgetdef pour enregistrer un nouveau widget ou conteneur destiné à être utilisé dans l'outil Commerce Composer. Ce fichier d'entrée prend en charge l'enregistrement au niveau du site ou du magasin.

Après avoir utilisé ce fichier d'entrée pour enregistrer le widget ou le conteneur, vous devez utiliser le fichier d'entrée subscribeWidgetdef pour abonner un ou plusieurs magasins au widget ou au conteneur.

Pour des exemples qui expliquent comment utiliser ce fichier d'entrée dans divers scénarios de chargement, voir :

Vous pouvez extraire des données d'enregistrement de widget avec Data Extract utility pour créer un fichier registerWidgetdef.csv à charger avec Data Load utility. Vous pouvez ainsi copier et déplacer les widgets d'un magasin ou d'une instance à l'autre, par exemple pour créer un ou plusieurs environnements de test.

Les exemples de fichier de configuration dont vous pouvez vous servir avec l'Data Extract utility sont fournis pour l'extraction des données d'enregistrement de widgets depuis les tables de base de données suivantes :Pour plus d'informations sur l'extraction de données Commerce Composer, voir :

Définitions

UniqueID
(Entier) Numéro de référence interne pour la définition de widget ou de conteneur, par exemple, 10001. L'ID UniqueID est généré automatiquement lorsque vous enregistrez le widget. En mode de suppression, cette zone ou la zone WidgetDefIdentifier (voir colonne suivante) est requise.
Remarque : L'exemple de fichier CSV n'inclut pas cette colonne ; l'exemple montre l'utilisation de WidgetDefIdentifier uniquement pour identifier le widget.
Mappé à :
  • PLWIDGETDEF.PLWIDGETDEF_ID
  • PLWIDGETDEFDESC.PLWIDGETDEF_ID
WidgetDefIdentifier
(Chaîne) Nom de référence externe pour la définition de widget ou de conteneur, par exemple, ContentRecommendation. Vous pouvez utiliser n'importe quel nom, mais il doit être unique pour le magasin. En mode d'insertion ou de remplacement, cette zone ne peut pas être null et le nom doit être unique. En mode de suppression, cette zone ou la zone UniqueID (voir colonne précédente) est requise.

Mappé à : PLWIDGETDEF.IDENTIFIER

WidgetStoreIdentifier
(Chaîne) Nom de référence unique du magasin dans lequel vous souhaitez enregistrer le widget ou le conteneur, par exemple, Aurora.
Important : Si vous enregistrez un widget au niveau du site, définissez la colonne WidgetStoreUniqueID sur 0 (voir colonne suivante) et laissez cette colonne vide.
Remarque : L'exemple de fichier CSV n'inclut pas cette colonne ; l'exemple montre l'utilisation de l'ID WidgetStoreUniqueID pour identifier le magasin dans lequel enregistrer le widget.

Mappé à : STOREENT.IDENTIFIER

WidgetStoreUniqueID
(Entier) Numéro de référence unique du magasin dans lequel vous souhaitez enregistrer le widget ou le conteneur. Les valeurs admises sont les suivantes :
storeId
Enregistrez ce widget ou ce conteneur dans un magasin spécifique. Par conséquent, le widget ou le conteneur ne peut pas être partagé avec d'autres magasins. La valeur storeId est définie dans la colonne STORE_ID de la table STORE. 12345 est un exemple de valeur storeId.
0
Enregistrez ce widget ou ce conteneur au niveau du site. Par conséquent, le widget ou le conteneur peut être partagé entre les magasins du site.

Si vous ne spécifiez pas de valeur, le widget est enregistré au niveau du magasin pour le magasin spécifié dans votre fichier de configuration d'environnement (wc-dataload-env.xml).

Mappé à : PLWIDGETDEF.STOREENT_ID

WidgetUIObjectName
(Chaîne) Nom qui identifie la définition du centre de gestion de ce widget, par exemple, ContentRecommendationWidget. Lorsque vous créez le fichier de définition qui définit le widget pour le centre de gestion, vous devez spécifier ce nom pour l'attribut ui_object_name dans le code XML.

Mappé à : PLWIDGETDEF.UI_OBJECT_NAME

WidgetType
(Entier) Type de widget. Les valeurs admises sont les suivantes :
  • 1 (pour un widget)
  • 2 (pour un conteneur)

Mappé à : PLWIDGETDEF.WIDGETTYPE

WidgetVendor
(Chaîne) Nom de l'entreprise ou du fournisseur qui a créé le widget, par exemple IBM.

Mappé à : PLWIDGETDEF.VENDOR

WidgetPath
(Chaîne) Chemin d'accès relatif au JSP (de niveau supérieur) du point d'entrée pour le widget ou le conteneur.
  • Pour les widgets ou les conteneurs au niveau du site :
    • (Le chemin doit être relatif au répertoire WCDE_installdir/workspace/Stores/WebContent.)
    • Faites commencer le chemin par une barre oblique.

    Exemple :/Widgets/com.ibm.commerce.store.widgets.ContentRecommendation/ContentRecommendation.jsp

  • Pour les widgets ou les conteneurs au niveau du magasin :
    • (Le chemin doit être relatif au répertoire WCDE_installdir/workspace/Stores/WebContent/storedir/.)
    • Ne faites pas commencer le chemin par une barre oblique.

    Exemple :Widgets/com.ibm.commerce.store.widgets.ContentRecommendation/ContentRecommendation.jsp

Mappé à : PLWIDGETDEF.JSPPATH

WidgetState
(Entier) Indicateur qui détermine l'état de l'enregistrement : Les valeurs admises sont les suivantes :
1
Active (actif) ; ce widget est utilisé par un ou plusieurs magasins.
0
Deprecated (obsolète) ; ce widget n'est utilisé par aucun magasin.

Mappé à : PLWIDGETDEF.STATE

WidgetDefinitionxml
(CLOB) Définition XML du widget ou du conteneur. Copiez le code XML complet dans cette colonne.

Mappé à : PLWIDGETDEF.DEFINITIONXML

LanguageId
(Entier) ID de langue pour les zones qui dépendent de la langue dans ce fichier d'entrée. Sauf indication contraire, utilisation par défaut de la langue spécifiée dans le contexte métier du fichier de configuration de l'environnement. Exemples de valeur valide :
-1
Anglais
-2
Français

Vous pouvez rechercher des valeurs d'ID de langue dans la table LANGUAGE.

Mappé à : PLWIDGETDEFDESC.LANGUAGE_ID

WidgetDisplayName
Nom d'affichage spécifique à la langue du widget, par exemple, Widget de recommandation de contenu. Ce nom est affiché dans l'outil Commerce Composer dans le centre de gestion pour aider les utilisateurs professionnels à identifier le widget. Utilisez le jeu de caractères UTF-8.

Mappé à : PLWIDGETDEFDESC.DISPLAYNAME

WidgetDescription
Description spécifique à la langue du widget, par exemple, . Affiche le contenu, comme les images, le texte, le HTML statique et les vidéos. Prend en charge les activités Web.. Cette description est affichée dans l'outil Commerce Composer dans le centre de gestion pour aider les utilisateurs professionnels à identifier le widget. Utilisez le jeu de caractères UTF-8.

Mappé à : PLWIDGETDEFDESC.DESCRIPTION

Supprimer
(Chaîne) Indicateur qui détermine si la définition de widget ou conteneur doit être supprimée. Spécifiez 1 pour supprimer la ligne.