Vue d'ensemble du fichier get-data-config.xml

Le fichier get-data-config.xml sert à configurer des générateurs d'expression utilisés par la balise JSTL getData configurée par l'action HCL Commerce getData. Lorsque vous utilisez les données getData, vous devez spécifier un nom de générateur d'expression et un nom de type de données. Ces informations sont utilisées lors de la recherche dans la configuration dans le fichier get-data-config.xml afin de déterminer l'expression XPath à exécuter.

Vous devriez :

Créez un nouveau fichier get-data-config.xml lors de la création d'un nouveau module de service dont le fichier configuration ne vous a pas été fourni. La création d'un nouveau fichier de configuration vous permet de construire vos propres générateurs d'expression.
Etendez le fichier get-data-config.xml lorsque le fichier de configuration vous a été fourni. Vous ne devriez pas intervenir directement sur le fichier get-data-config.xml fourni en vue de lui apporter des modifications étant donné que celles-ci sont perdues lorsque les fichiers de configuration sont remplacés, par exemple au cours d'une mise à jour de HCL Commerce. En étendant la configuration, vous pouvez substituer par d'autres les propriétés du générateur d'expression.

Les fichiers de configuration get-data-config.xml doivent respecter les règles suivantes :

get-data-config doit constituer l'élément racine.
Un fichier de configuration doit exister pour chaque composant configuré pour son utilisation avec l'action getData.
Les fichiers de configuration de composant de base sont censés être situés sous le chemin WEB-INF/config/base/component/get-data-config.xml, où component correspond à un répertoire unique au composant.
Les extensions client doivent être situées sous le chemin WEB-INF/config/ext/.global/get-data-config. Ces extensions sont chargées après les configurations de composant de base.

Remarque : Tous les chemins dans ce fichier sont relatifs à l'emplacement d'installation de votre application Web (par exemple, le fichier WAR de portlet, MVCPortlet.war).

Tous les générateurs d'expression sont définis dans les fichiers get-data-config.xml. L'élément data-type déclare un type de données pris en charge pour l'action getData. L'élément client-facade déclare la façade client du composant qui appelle le service pour l'extraction de données. Le générateur d'expression gère la construction de l'expression XPath avec les paramètres d'entrée publiés.

Chaque générateur d'expression comporte les propriétés suivantes :

Le noeud <name> identifie de manière unique le générateur d'expression et est utilisé par les balises getData dans les pages JSP du projet pour référencer un générateur d'expression.
Le noeud <data-type-name> contient le type de nom renvoyé par le générateur d'expression.
Le noeud <expression template> fait référence à une requête XPath définie dans le fichier de modèle de requête du projet, et qui est utilisée pour extraire des informations spécifiques depuis la base de données. Des paramètres tels que $projectID$ peuvent être transmis au générateur d'expression par une balise getData.
Chaque noeud <param> contient une paire de noeuds enfant <name> et <value> qui définissent un paramètre à transmettre au fichier modèle de requête. Chaque générateur d'expression est associé ici à un profil d'accès spécifique. Ce profil d'accès, associé à la requête XPath définie ci-dessus, identifie de manière unique une requête dans le fichier modèle de requête.

Le fichier get-data-config.xml préconstruit contient les éléments suivants :

L'élément <data-type>, qui définit une interface Java avec l'objet SDO logique.
L'élément <client-facade>, qui définit une interface Java avec le code de la façade client.
L'élément <expression-builder>, qui définit un modèle d'expression XPath, de pair avec un profil d'accès et le type de données des noms renvoyés, à savoir le nom CustomAppProperties défini dans l'élément <data-type> mentionné plus haut.

L'extension du fichier get-data-config peut également modifier le comportement de composants métier. Par exemple, le composant Catalog active par défaut la possibilité de recherche par numéro de référence et par nom (avec distinction majuscules/minuscules). Vous pouvez modifier ce comportement de sorte à permettre uniquement la recherche par numéro de référence, ou bien uniquement par nom, pour optimiser les performances des recherches sur le site.

Les applications Web dans le Centre de gestion utilisent le fichier get-data-config.xml pour configurer la wcf:getData tag définie dans les pages JSP du contrôleur Get, et définissent :

Les interfaces Java avec les objets SDO logiques.
Les interfaces Java avec les façades client pour interagir avec les services HCL Commerce.
Une liste des modèles d'expression XPath utilisés par l'application client du Management Center.