AEM-Tagging-Framework aem-tagging-framework

Tagging ermöglicht die Kategorisierung und Organisation von Inhalten. Tags können anhand eines Namespace und einer Taxonomie klassifiziert werden. Ausführliche Informationen zur Verwendung von Tags:

Dieser Artikel konzentriert sich auf das zugrunde liegende Framework, das Tagging in AEM unterstützt, und darauf, wie man es als Entwicklerin bzw. Entwickler nutzen kann.

Einführung introduction

Taggen von Inhalten und Verwenden der AEM-Tagging-Infrastruktur:

Tags: cq:Tag-Knotentyp tags-cq-tag-node-type

Die Deklaration eines Tags wird im Repository in einem Knoten vom Typ cq:Tag erfasst

Ein Tag kann ein einfaches Wort sein (zum Beispiel sky) oder stellen eine hierarchische Taxonomie dar (z. B. fruit/apple, d. h. sowohl das generische fruit und spezifischere apple).

Tags werden anhand einer eindeutigen Tag-ID identifiziert.

Ein Tag weist optionale Metadaten auf, z. B. einen Titel, lokalisierte Titel und eine Beschreibung. Der Titel sollte, falls vorhanden, auf Benutzeroberflächen anstelle der Tag-ID angezeigt werden.

Das Tagging-Framework bietet außerdem die Möglichkeit, Autoren und Website-Besuchern die Verwendung bestimmter, vordefinierter Tags vorzugeben.

Tag-Eigenschaften tag-characteristics

Da Tags lediglich JCR-Knoten sind, müssen die Knotennamen der JCR-Namenskonvention entsprechen.

TagID (Tag-ID) tagid

Eine Tag-ID identifiziert einen Pfad, der einen Tag-Knoten im Repository ergibt.

Normalerweise ist die Tag-ID eine kurze Tag-ID, die mit dem Namespace beginnt. Sie kann auch eine absolute Tag-ID sein, die mit dem Stammknoten der Taxonomie beginnt.

Wenn Inhalte mit Tags versehen werden, wird, sofern noch nicht vorhanden, die Eigenschaft [cq:tags](#tagged-content-cq-tags-property) zum Inhaltsknoten und die Tag-ID zum String-Array-Wert hinzugefügt.

Die Tag-ID besteht aus einem Namespace gefolgt von der lokalen Tag-ID. Container-Tags weisen untergeordnete Tags auf, die eine hierarchische Reihenfolge in der Taxonomie darstellen. Untergeordnete Tags können dazu verwendet werden, auf Tags sowie auf andere lokale Tag-IDs zu verweisen. Beispielsweise ist es erlaubt, Inhalte mit dem Tag fruit zu versehen, auch wenn es sich um ein Container-Tag mit untergeordneten Tags handelt, z. B. fruit/apple oder fruit/banana.

Stammknoten der Taxonomie taxonomy-root-node

Der Stammknoten der Taxonomie ist der Basispfad für alle Tags im Repository. Der Stammknoten der Taxonomie darf kein Knoten vom Typ cq:Tag sein.

In AEM ist der Basispfad /content/cq:tags und der Stammknoten ist vom Typ cq:Folder.

Tag-Namespace tag-namespace

Mithilfe von Namespaces können Sie Elemente gruppieren. Der häufigste Anwendungsfall ist ein Namespace pro Site (z. B. öffentlich, intern und portal) oder pro größerer Anwendung (z. B. WCM, Assets, Communities). Namespaces können aber auch anderweitig eingesetzt werden. Namespaces werden in der Benutzeroberfläche verwendet, um nur die Untergruppe von Tags anzuzeigen (d. h. die Tags eines bestimmten Namespace), die für den aktuellen Inhalt gültig ist.

Der Namespace des Tags ist die erste Ebene im Teilbaum der Taxonomie, der den Knoten direkt unterhalb des Stammknotens der Taxonomie darstellt. Ein Namespace ist ein Knoten vom Typ cq:Tag, dessen übergeordnetes Element nicht vom Knotentyp cq:Tag ist.

Alle Tags haben einen Namespace. Wenn kein Namespace angegeben ist, wird das Tag dem standardmäßigen Namespace zugeordnet, der Tag-ID default mit dem Titel Standard Tags, d. h /content/cq:tags/default.

Container-Tags container-tags

Container-Tags sind Knoten vom Typ cq:Tag, die eine beliebige Anzahl untergeordneter Knoten von beliebigen Typen enthalten. Das ermöglicht die Erweiterung des Tag-Modells mit benutzerdefinierten Metadaten.

Darüber hinaus dienen Container-Tags (oder Super-Tags) in einer Taxonomie als Oberbegriff aller untergeordneten Tags. Beispielsweise werden Inhalte, die mit fruit/apple getaggt sind, auch als mit fruit getaggt erachtet. Das heißt, bei der Suche nach Inhalten, die mit fruit getaggt sind, werden auch Inhalte gefunden, die mit fruit/apple getaggt sind.

Auflösen von Tag-IDs resolving-tagids

Wenn die Tag-ID einen Doppelpunkt (:) enthält, trennt der Doppelpunkt den Namespace vom Tag oder der Untertaxonomie, die dann mit Schrägstrichen (/) weiter voneinander getrennt werden. Wenn in der Tag-ID kein Doppelpunkt vorkommt, wird vom Standard-Namespace ausgegangen.

Der standardmäßige und einzige Speicherort von Tags befindet sich unter /content/cq:tags.

Tags, die auf nicht vorhandene Pfade oder auf Pfade verweisen, an deren Ende sich kein cq:Tag-Knoten befindet, werden als ungültig betrachtet und ignoriert.

Die folgende Tabelle zeigt einige Beispiel-Tag-IDs, ihre Elemente und wie die Tag-ID einen absoluten Pfad im Repository ergibt:

Lokalisierung des Tag-Titels localization-of-tag-title

Wenn das Tag die optionale Titelzeichenfolge enthält (jcr:title), ist es möglich, den Titel zur Anzeige zu lokalisieren, indem die Eigenschaft jcr:title.<locale> hinzugefügt wird.

Weitere Informationen finden Sie in den folgenden Dokumenten:

Zugriffssteuerung access-control

Tags bestehen als Knoten im Repository unter dem Stammknoten der Taxonomie. Sie erlauben oder verweigern Autorinnen und Autoren sowie Besucherinnen und Besuchern von Sites die Erstellung von Tags in einem bestimmten Namespace, indem im Repository entsprechende ACLs festgelegt werden.

Durch das Verweigern von Leseberechtigungen für bestimmte Tags oder Namespaces wird die Möglichkeit gesteuert, Tags auf bestimmte Inhalte anzuwenden.

Eine typische Vorgehensweise umfasst Folgendes:

Tag-barer Inhalt: cq:Taggable-Mixin taggable-content-cq-taggable-mixin

Damit Anwendungsentwicklerinnen und -entwickler einen Inhaltstyp mit Tags versehen können, muss die Registrierung eines Knotens (CND) das Mixin cq:Taggable oder das Mixin cq:OwnerTaggable umfassen.

Das Mixin cq:OwnerTaggable, das von cq:Taggable übernimmt, soll anzeigen, dass der Inhalt vom Besitzer/Autor klassifiziert werden kann. In AEM handelt es sich hierbei nur um ein Attribut des Knotens cq:PageContent. Das Mixin cq:OwnerTaggable wird vom Tagging-Framework nicht benötigt.

Knotentypnotation (CND) node-type-notation-cnd

Knotentypdefinitionen sind im Repository als CND-Dateien vorhanden. Die CND-Notation wird als Teil der JCR-Dokumentation hier definiert.

Die wichtigsten Definitionen für die Knotentypen in AEM sind wie folgt:

[cq:Tag] > mix:title, nt:base
    orderable
    - * (undefined) multiple
    - * (undefined)
    + * (nt:base) = cq:Tag version

[cq:Taggable]
    mixin
    - cq:tags (string) multiple

[cq:OwnerTaggable] > cq:Taggable
    mixin

Inhalt mit Tags: cq:tags-Eigenschaft tagged-content-cq-tags-property

Die Eigenschaft cq:tags ist ein String-Array, das zum Speichern mindestens einer Tag-ID verwendet wird, wenn diese von Autorinnen und Autoren oder Besucherinnen und Besuchern von Sites auf Inhalte angewendet werden. Die Eigenschaft hat nur dann eine Bedeutung, wenn sie einem Knoten hinzugefügt wird, der mit dem Mixin [cq:Taggable](#taggable-content-cq-taggable-mixin) definiert wird.

Verschieben und Zusammenführen von Tags moving-and-merging-tags

Im Folgenden finden Sie eine Beschreibung der Auswirkungen, die im Repository auftreten, wenn Sie Tags mit der Tagging-Konsole verschieben oder zusammenführen:

Tag-Migration tags-migration

Seit Adobe Experience Manager 6.4 werden Tags unter /content/cq:tags gespeichert, in früheren Versionen unter /etc/tags.

Beim Aktualisieren eines AEM-Systems von einer früheren Version als 6.4 müssen Tags zu /content/cq:tags migriert werden. Weitere Informationen finden Sie unter Repository-Neustrukturierung für alle Lösungen in AEM 6.5.