Bonnes pratiques relatives à l’indexation dans AEM

Découvrez les bonnes pratiques d’indexation dans Adobe Experience Manager (AEM). Apache Jackrabbit Oak alimente la recherche de contenu dans AEM et les points clés suivants :

Pour disposer d’une fonctionnalité de recherche efficace et correcte qui n’affecte pas les performances de l’instance AEM, il est important de comprendre les bonnes pratiques d’indexation.

Index personnalisé ou prêt à l’emploi

Parfois, vous devez créer des index personnalisés pour répondre à vos besoins de recherche. Suivez toutefois les instructions ci-dessous avant de créer des index personnalisés :

Personnaliser l’index prêt à l’emploi

Index entièrement personnalisé

La création d’un index entièrement personnalisé doit être votre dernière option et uniquement si l’option ci-dessus ne fonctionne pas.

Exemples

Pour comprendre les bonnes pratiques, examinons quelques exemples.

Utilisation incorrecte de la propriété de balises

L’image ci-dessous présente la définition d’index personnalisés et prêts à l’emploi, en mettant en surbrillance la propriété tags, les deux index utilisent la même valeur visualSimilaritySearch.

Analyse

Il s’agit d’une utilisation incorrecte de la propriété tags sur l’index personnalisé. Le moteur de requête Oak sélectionne l’index personnalisé plutôt que l’index prêt à l’emploi en raison du coût estimé le plus faible.

La bonne méthode consiste à personnaliser l’index prêt à l’emploi et à ajouter des propriétés supplémentaires dans le nœud indexRules. Consultez Personnalisation de l’index prêt à l’emploi pour plus d’informations.

Index sur le type de nœud dam:Asset

L’image ci-dessous affiche l’index personnalisé pour le type de nœud dam:Asset avec la propriété includedPaths définie sur un chemin d’accès spécifique.

Analyse

Si vous effectuez une recherche Omnisearch sur Assets, elle renvoie des résultats incorrects, car le coût estimé de l’index personnalisé est plus faible.

Ne créez pas d’index personnalisé sur le type de nœud dam:Asset, mais personnalisez l’index damAssetLucene prêt à l’emploi avec les propriétés nécessaires dans le nœud indexRules.

Plusieurs types de nœud sous des règles d’indexation

L’image ci-dessous présente l’index personnalisé avec plusieurs types de nœud sous le nœud indexRules.

Analyse

Il n’est pas recommandé d’ajouter plusieurs types de nœuds dans un seul index. Cependant, il est recommandé d’indexer les types de nœuds dans le même index si les types de nœuds sont étroitement liés, par exemple : cq:Page et cq:PageContent.

Une solution valide consiste à personnaliser les index cqPageLucene et damAssetLucene prêts à l’emploi et à ajouter les propriétés nécessaires sous le nœud indexRules existant.

Absence de la propriété queryPaths

L’image ci-dessous affiche un index personnalisé (qui ne suit pas non plus la convention de nommage) sans la propriété queryPaths.

Analyse

Définissez toujours la valeur queryPaths pour qu’elle soit identique à la valeur includedPaths. En outre, pour forcer la restriction de chemin, définissez la propriété evaluatePathRestrictions sur true.

Interroger avec une balise d’index

L’image ci-dessous affiche un index personnalisé avec la propriété tags et la manière de l’utiliser lors de l’interrogation.

/jcr:root/content/dam//element(*,dam:Asset)[(jcr:content/@contentFragment = 'true' and jcr:contains(., '/content/sitebuilder/test/mysite/live/ja-jp/mypage'))]order by @jcr:created descending option (index tag assetPrefixNodeNameSearch)

Analyse

Indique comment définir des règles non conflictuelles et une valeur de propriété tags correcte pour l’index et comment l’utiliser lors de l’interrogation. La syntaxe de requête générale est la suivante : <query> option(index tag <tagName>). Voir également Option de requête avec balise d’index

Index personnalisé

L’image ci-dessous affiche un index personnalisé avec le nœud suggestion pour accéder à la fonctionnalité de recherche avancée.

Analyse

Il s’agit d’un cas d’utilisation valide pour créer un index personnalisé pour la fonctionnalité de recherche avancée. Cependant, le nom de l’index doit respecter la convention de nommage &lt;préfixe>.<customIndexName>-&lt;version>-custom-&lt;customVersion>.

Optimisation de l’index en désactivant Apache Tika

AEM utilise Apache Tika pour extraire les métadonnées et le contenu de texte à partir de types de fichier tels que PDF, Word, Excel, etc. Le contenu extrait est stocké dans le référentiel et indexé par l’index Oak Lucene.

Parfois, il n’est pas nécessaire de rechercher dans le contenu d’un fichier ou d’une ressource. Dans ce cas, vous pouvez améliorer les performances d’indexation en désactivant Apache Tika. Les avantages sont les suivants :

Désactiver par type MIME

Pour désactiver Apache Tika par type MIME, procédez comme suit :

/oak:index/damAssetLucene
    - jcr:primaryType = "oak:QueryIndexDefinition"
    - type = "lucene"
    ...
    <tika jcr:primaryType="nt:unstructured">
        <config.xml/>
    </tika>

<properties>
  <parsers>
    <parser class="org.apache.tika.parser.EmptyParser">
      <mime>application/pdf</mime>
      <!-- Add more mime types to disable -->
  </parsers>
</properties>

L’image suivante présente l’index damAssetLucene prêt à l’emploi avec le nœud tika et le fichier config.xml qui désactive le PDF et d’autres types MIME.

Désactiver complètement

Pour désactiver complètement Apache Tika, procédez comme suit :

/oak:index/<INDEX-NAME>/indexRules/<NODE-TYPE>/properties/data
    - jcr:primaryType = "nt:unstructured"
    - type = "String"
    - name = "jcr:data"
    - nodeScopeIndex = false
    - propertyIndex = false
    - analyze = false

Outils pratiques

Examinons quelques outils qui peuvent vous aider à définir, analyser et optimiser les index.

Outil de création d’index et outils Oak

L’outil Générateur de définitions d’index Oak permet de générer la définition d’index en fonction des requêtes d’entrée. Il s’agit d’un bon point de départ pour créer un index personnalisé.

Les outils Oak contiennent également d’autres
des utilitaires liés à l’indexation et à l’interrogation, par exemple pour convertir des index entre les formats JSON et XML ;
pour convertir des requêtes XPath en SQL-2 et pour comparer des index.

Outil de performance des requêtes

L’Outil de performance des requêtes prêt à l’emploi disponible dans le SDK local et AEMCS via la Developer Console ou https://author-pXXXX-eYYYY.adobeaemcloud.com/ui#/aem/libs/granite/operations/content/diagnosistools/queryPerformance.html?appId=aemshell permet d’analyser les performances de la requête et l’aide-mémoire de requêtes JCR pour définir la requête optimale.

Outils et conseils de dépannage

La plupart des éléments ci-dessous sont applicables pour AEM 6.X et à des fins de dépannage local.

Ressources supplémentaires

Pour plus d’informations, reportez-vous à la documentation suivante :