Modification des propriétés dans le fichier de configuration de recherche (wc-search.xml) (WC EAR)

Pour modifier la valeur d'une propriété existante dans le fichier de configuration (wc-search.xml), vous devez créer une version personnalisée du fichier dans un nouveau dossier. La version personnalisée du fichier ne doit contenir que les propriétés modifiées.

Avant de commencer

Pour connaître les propriétés contenues dans ce fichier, reportez-vous à la rubrique HCL Commerce Search fichier de configuration (wc-search.xml).

Pourquoi et quand exécuter cette tâche

Dans votre fichier personnalisé wc-search.xml, modifiez uniquement les types de nœuds <_config:profile> et <_config:queryMapping>.

Conseil : Pour ajouter de nouveaux éléments à l'un des profils existants du fichier wc-search.xml, vous pouvez ajouter un profil dans votre fichier wc-search.xml personnalisé qui étend le profil existant.

Procédure

  1. Ouvrez HCL Commerce Developer et basculez vers la vue Explorateur d'entreprise.
  2. Créez un fichier de configuration personnalisé (wc-search.xml) s'il n'y en a pas :
    1. Accédez au chemin suivant :

      workspace_dir\WC\xml\config\

    2. Sous le dossier config, créez un nouveau dossier com.ibm.commerce.catalog-ext de sorte que son chemin d'accès soit similaire à ceci :

      workspace_dir\WC\xml\config\com.ibm.commerce.catalog-ext\

      Si ce dossier existe déjà et s'il contient une version personnalisée du fichier wc-search.xml, ouvrez-le et passez à l'étape 4.

    3. Créez un fichier wc-search.xml vide dans le dossier com.ibm.commerce.catalog-ext. Ce fichier est votre fichier wc-search.xml personnalisé.
  3. Ajoutez les éléments XML de base requis pour votre fichier wc-search.xml personnalisé :
    1. Ouvrez votre fichier personnalisé wc-search.xml vide dans un éditeur XML.
    2. Copiez le code suivant dans le fichier :
      <?xml version="1.0" encoding="UTF-8"?>
      
      <_config:search-config
      	xmlns:_config="http://www.ibm.com/xmlns/prod/commerce/foundation/config"
      	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      	xsi:schemaLocation="http://www.ibm.com/xmlns/prod/commerce/foundation/config ../xsd/wc-search.xsd ">
      
      
      </_config:search-config>
  4. Ajoutez le fichier XML pour toutes les propriétés que vous souhaitez modifier dans votre fichier personnalisé wc-search.xml :
    1. Accédez le fichier de configuration par défaut au chemin suivant :

      workspace_dir\WC\xml\config\com.ibm.commerce.catalog-fep\wc-search.xml

      Ne modifiez pas les propriétés directement dans ce fichier, car vos modifications seraient écrasées pas les mises à jour ultérieures des produits IBM.

    2. Copiez les éléments XML des propriétés du fichier de configuration de Search par défaut que vous souhaitez modifier vers votre fichier wc-search.xml personnalisé. Insérez les éléments XML copiés au-dessus de l'élément </_config:search-config>.

      Même si vous ne copiez que certains éléments, vous devez conserver leur hiérarchie XML dans le fichier. Par exemple, si vous souhaitez modifier la propriété définie dans un élément <_config:param> spécifique, vous devez conserver les éléments parent et ancêtre de l'élément <_config:param>, mais vous pouvez supprimer tous les objets de même niveau si vous ne les modifiez pas. Vous devez également conserver l'ordre des éléments de même niveau, car ils sont attendus dans le même ordre qu'ils apparaissent dans le fichier de configuration par défaut.

    3. Modifiez les valeurs nécessaires.
    4. Au-dessus de l'élément </_config:search-config>, ajoutez une liste des profils qui héritent directement ou indirectement du profil pour lequel vous avez modifié les valeurs de propriété.

      Les profils de recherche ont une structure hiérarchique. Le fichier wc-search.xml par défaut contient un certain nombre de profils qui héritent directement et indirectement d'éléments provenant d'autres profils. Par exemple, le profil IBM_Global comporte un certain nombre de profils qui en héritent. Pour vous assurer que les valeurs que vous modifiez sont récupérées par les profils étendus, vous devez inclure une liste de ces profils dans votre fichier wc_search.xml personnalisé. En incluant cette liste, les valeurs de propriété que vous modifiez sont correctement fusionnées entre les deux fichiers. Vous pouvez afficher un exemple de cette liste de profils (voir le fragment de code entre les lettres B et C).

  5. Enregistrez et fermez votre fichier wc-search.xml personnalisé.
  6. Testez vos changements de configuration.

Exemple

L'exemple suivant montre le contenu d'un fichier wc-search.xml personnalisé qui modifie trois propriétés définies dans le profil IBM_Global :

<?xml version="1.0" encoding="UTF-8"?>
<_config:search-config
	xmlns:_config="http://www.ibm.com/xmlns/prod/commerce/foundation/config"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.ibm.com/xmlns/prod/commerce/foundation/config ../xsd/wc-search.xsd ">
A
    <_config:profile indexName="CatalogEntry" name="IBM_Global">
        <_config:query>
            <_config:param name="price" value="0" />
            <_config:param name="statistics" value="true"/>
        </_config:query>
        	<_config:spellcheck>
        		<_config:param name="limit" value="3"/>
        	</_config:spellcheck>
    </_config:profile>
B
	<_config:profile extends="IBM_Global" name="IBM_findCatalogEntryByName"/>
	<_config:profile extends="IBM_findCatalogEntryByName" name="IBM_findCatalogEntryByNameAndShortDescription"/>
	<_config:profile extends="IBM_findCatalogEntryByNameAndShortDescription" name="IBM_findCatalogEntryByNameAndShortDescriptionInDetail"/>
	<_config:profile extends="IBM_Global" name="IBM_findCatalogEntryByUnstructureField"/>
C
</_config:search-config>
Dans l'exemple précédent, le fragment de code qui commence par A et se termine par B est le code inséré qui modifie trois propriétés :
  • price : La valeur de la propriété passe de 1 à 0.
  • statistics : La valeur de la propriété passe de false à true.
  • limit : La valeur de la propriété passe de 5 à 3.
Notez que les éléments parent et ancêtre de chaque élément <_config:param> sont conservés dans le fichier wc-search.xml personnalisé.

Le fragment de code qui commence par B et se termine par C est la liste des profils qui s'étendent directement et indirectement à partir du profil IBM_Global. Ce fragment est inclus pour s'assurer que les valeurs de propriété modifiées sont récupérées par ces profils.