Best Practices für die Indizierung in AEM

Erfahren Sie mehr über Best Practices für die Indizierung in Adobe Experience Manager (AEM). Die Inhaltssuche in AEM wird durch Apache Jackrabbit Oak gestützt. Beachten Sie die folgenden wichtigen Punkte:

Damit die Suchfunktion effizient und ordnungsgemäß arbeitet und sich nicht auf die Leistung der AEM-Instanz auswirkt, ist es wichtig, die Best Practices für die Indizierung zu verstehen.

Benutzerdefinierte und vorkonfigurierte Indizes

Manchmal müssen Sie benutzerdefinierte Indizes erstellen, damit Ihre Suchanforderungen erfüllt werden. Befolgen Sie jedoch die nachstehenden Richtlinien, bevor Sie benutzerdefinierte Indizes erstellen:

Anpassen des vorkonfigurierten Index

Vollständig benutzerdefinierter Index

Das Erstellen eines vollständig benutzerdefinierten Index sollte Ihre allerletzte Option sein. Greifen Sie nur dann darauf zurück, wenn die oben genannte Option nicht funktioniert.

Beispiele

Um die Best Practices zu verstehen, sehen wir uns einige Beispiele an.

Nicht ordnungsgemäße Verwendung der Eigenschaft „tags“

Die folgende Abbildung zeigt eine benutzerdefinierte und eine vorkonfigurierte Indexdefinition. Die Eigenschaft tags ist hervorgehoben und beide Indizes verwenden den gleichen Wert visualSimilaritySearch.

Analyse

Hier wird die Eigenschaft tags im benutzerdefinizerten Index nicht ordnungsgemäß verwendet. Aufgrund der niedrigeren geschätzten Kosten wählt die Oak-Abfrage-Engine den benutzerdefinierten Index anstelle des vorkonfigurierten Index aus.

Die richtige Vorgehensweise besteht darin, den vorkonfigurierten Index anzupassen und im Knoten indexRules die erforderlichen Eigenschaften hinzuzufügen. Weitere Informationen finden Sie unter Anpassen des vorkonfigurierten Index.

Index auf dem Knotentyp dam:Asset

Die folgende Abbildung zeigt den benutzerdefinierten Index für den Knotentyp dam:Asset, wobei die Eigenschaft includedPaths auf einen bestimmten Pfad gesetzt ist.

Analyse

Wenn Sie eine Omnisearch auf Assets durchführen, werden falsche Ergebnisse ausgegeben, da der benutzerdefinierte Index niedrigere geschätzte Kosten aufweist.

Erstellen Sie keinen benutzerdefinierten Index auf dem Knotentyp dam:Asset, sondern passen Sie im Knoten damAssetLucene den vorkonfigurierten Index indexRules mit den erforderlichen Eigenschaften an.

Mehrere Knotentypen unter den Indizierungsregeln

Die folgende Abbildung zeigt einen benutzerdefinierten Index mit mehreren Knotentypen unter dem Knoten indexRules.

Analyse

Es wird nicht empfohlen, mehrere Knotentypen in einem einzigen Index hinzuzufügen. Knotentypen können jedoch im selben Index indiziert werden, wenn die Knotentypen eng miteinander zusammenhängen, z. B. cq:Page und cq:PageContent.

Eine gültige Lösung besteht darin, die vorkonfigurierten Indizes cqPageLucene und damAssetLucene anzupassen und zusätzliche Eigenschaften unter dem vorhandenen Knoten indexRules hinzuzufügen.

Fehlen der Eigenschaft queryPaths

Die folgende Abbildung zeigt einen benutzerdefinierten Index (der auch nicht der Namenskonvention folgt) ohne die Eigenschaft queryPaths.

Analyse

Setzen Sie den Wert queryPaths immer auf den gleichen Wert wie includedPaths. Um die Pfadbeschränkung zu erzwingen, setzen Sie außerdem die Eigenschaft evaluatePathRestrictions auf true.

Abfrage mit Index-Tag

Die folgende Abbildung zeigt einen benutzerdefinierten Index mit der Eigenschaft tags und die Verwendung bei Abfragen.

/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

Zeigt, wie ein nicht im Konflikt stehender und richtiger Eigenschaftswert tags im Index festgelegt und bei Abfragen verwendet wird. Die allgemeine Abfragesyntax lautet <query> option(index tag <tagName>). Siehe auch Index-Tag der Abfrageoption

Benutzerdefinierter Index

Die folgende Abbildung zeigt einen benutzerdefinierten Index mit dem Knoten suggestion, um die erweiterte Suchfunktion zu erzielen.

Analyse

Es ist durchaus angebracht, einen benutzerdefinierten Index für die erweiterte Suchfunktion zu erstellen. Der Indexname sollte jedoch der Namenskonvention <prefix>.<customIndexName>-<version>-custom-<customVersion> folgen.

Indexoptimierung durch Deaktivieren von Apache Tika

AEM verwendet Apache Tika für das Extrahieren von Metadaten und Textinhalten aus Dateien, wie z. B. PDF, Word, Excel und anderen. Die extrahierten Inhalte werden im Repository gespeichert und durch den Oak Lucene-Index indiziert.

Manchmal benötigen Benutzerinnen und Benutzer nicht die Möglichkeit, innerhalb des Inhalts einer Datei oder eines Assets zu suchen. In solchen Fällen können Sie die Indizierungsleistung verbessern, indem Sie Apache Tika deaktivieren. Die Vorteile:

Deaktivieren nach MIME-Typ

Um Apache Tika nach MIME-Typ zu deaktivieren, gehen Sie wie folgt vor:

/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>

Die folgende Abbildung zeigt den vorkonfigurierten Index damAssetLucene mit dem Knoten tika und der Datei config.xml, die PDF- und andere MIME-Typen deaktiviert.

Vollständiges Deaktivieren

Um Apache Tika vollständig zu deaktivieren, gehen Sie wie folgt vor:

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

Hilfreiche Tools

Sehen wir uns einige Tools an, die Ihnen beim Definieren, Analysieren und Optimieren der Indizes helfen können.

Tool zur Indexerstellung und Oak-Tools

Das Tool Oak Index Definition Generator hilft beim Generieren der Indexdefinition basierend auf den Eingabeabfragen. Es bietet einen guten Ausgangspunkt zum Erstellen eines benutzerdefinierten Index.

Die Oak-Tools enthalten auch andere
-Dienstprogramme für Indizierung und Abfrage, z. B. zum Konvertieren von Indizes zwischen JSON- und XML-Format,
, um XPath-Abfragen in SQL-2 zu konvertieren und Indizes zu vergleichen.

Abfrageleistungs-Tool

Das vorkonfigurierte Abfrageleistungs-Tool ist im lokalen SDK und AEMCS über die Developer Console oder unter https://author-pXXXX-eYYYY.adobeaemcloud.com/ui#/aem/libs/granite/operations/content/diagnosistools/queryPerformance.html?appId=aemshell verfügbar und hilft beim Analysieren der Abfrageleistung und der JCR-Abfrage-Schnellübersicht, um die optimale Abfrage zu definieren.

Tools und Tipps zur Fehlerbehebung

Die meisten der folgenden Ressourcen gelten für AEM 6.X und lokale Fehlerbehebungszwecke.

Zusätzliche Ressourcen

Weitere Informationen finden Sie in der folgenden Dokumentation: