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:

• Informationen zum Taggen von Inhalten als Inhaltsersteller finden Sie unter Verwenden von Tags.
• Informationen zur Erstellung und Verwaltung von Tags durch einen Administrator sowie dazu, welchen Inhalten Tags zugewiesen werden, finden Sie unter „Verwalten von Tags“.

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

Einführung

Versehen Sie Inhalte mit Tags und nutzen Sie die AEM-Tagging-Infrastruktur wie folgt:

• Das Tag muss unterhalb des Stammknotens der Taxonomie als Knoten vom Typ cq:Tag vorhanden sein.
• Der NodeType des mit Tags versehenen Inhaltsknotens muss das Mixin cq:Taggable beinhalten.
• Die TagID wird der Eigenschaft cq:tags des Inhaltsknotens hinzugefügt und ergibt einen Knoten vom Typ cq:Tag.

Knotentyp cq:Tag

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

• Ein Tag kann ein einfaches Wort (z. B. sky) sein oder eine hierarchische Taxonomie (z. B. fruit/apple, womit sowohl die Frucht im Allgemeinen als auch der Apfel im Speziellen gemeint sind) darstellen.
• Tags werden anhand einer eindeutigen TagID 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 TagID angezeigt werden.

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

Tag-Eigenschaften

• Der Knotentyp ist cq:Tag.
• Der Knotenname ist eine Komponente der TagID.
• Die TagID umfasst immer einen Namespace.
• Die Eigenschaft jcr:title (der Titel, der in der Benutzeroberfläche angezeigt werden soll) ist optional.
• Die Eigenschaft jcr:description ist optional.
• Wird als Container-Tag bezeichnet, wenn untergeordnete Knoten enthalten sind.
• Das Tag wird im Repository unterhalb eines Basispfads gespeichert, der als Stammknoten der Taxonomie bezeichnet wird.

TagID (Tag-ID)

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

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

Wenn Inhalte mit Tags versehen werden, aber noch nicht vorhanden sind, wird dem Inhaltsknoten die Eigenschaft cq:tags und dem String-Array-Wert der Eigenschaft die TagID hinzugefügt.

Die TagID besteht aus einem Namespace gefolgt von der lokalen TagID. Container-Tags weisen untergeordnete Tags auf, die eine hierarchische Reihenfolge in der Taxonomie darstellen. Untergeordnete Tags können dazu verwendet werden, auf Tags genau wie auf eine andere lokale TagID 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

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

Namespaces ermöglichen das Gruppieren von Elementen. Der vorherrschende Anwendungsfall besteht darin, einen Namespace pro Website (z. B. öffentlich versus intern) oder pro größerer Anwendung (z. B. Sites oder Assets) zu verwenden. Namespaces können aber auch anderweitig eingesetzt werden. Namespaces werden in der Benutzeroberfläche verwendet, um nur die Untergruppe von Tags (d. h. die Tags eines bestimmten Namespace) anzuzeigen, die auf den aktuellen Inhalt anwendbar sind.

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 TagID default lautet, d. h. /content/cq:tags/default. Der Titel ist in diesen Fällen standardmäßig auf Standard Tags eingestellt.

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 Untersummierung aller untergeordneten Tags: Beispielsweise werden Inhalte, die mit dem Tag fruit/apple versehen sind, auch als mit dem Tag fruit versehen betrachtet. Wenn also nach Inhalten gesucht wird, die mit dem Tag fruit versehen sind, werden auch Inhalte mit dem Tag fruit/apple gefunden.

Auflösen von Tag-IDs

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

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 werden ignoriert.

Die folgende Tabelle zeigt einige TagID-Beispiele, ihre Elemente und wie die TagID einen absoluten Pfad im Repository ergibt:

Lokalisierung des Tag-Titels

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 unter:

• Tags in verschiedenen Sprachen (beschreibt die Verwendung der APIs als Entwickler)
• Verwalten von Tags in verschiedenen Sprachen (beschreibt die Verwendung der Tagging-Konsole als Administrator)

Zugriffssteuerung

Tags bestehen als Knoten im Repository unter dem Stammknoten der Taxonomie. Sie erlauben oder verweigern Autoren und Website-Besuchern die Erstellung von Tags in einem jeweiligen Namespace, indem Sie im Repository entsprechende ACLs festlegen.

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:

• Gewähren von Schreibzugriff auf alle Namespaces für die Gruppe/Rolle tag-administrators (unter /content/cq:tags hinzufügen/ändern). Diese Gruppe enthält AEM standardmäßig.
• Gewähren von Lesezugriff für Benutzer/Autoren auf alle Namespaces, die sie lesen können müssen (meist alle).
• Gewähren von Schreibzugriff für Benutzer/Autoren auf die Namespaces, bei denen Tags durch Benutzer/Autoren frei definierbar sein müssen (add_node unter /content/cq:tags/some_namespace).

Tag-barer Inhalt: cq:Taggable-Mixin

Damit Anwendungsentwickler 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)

Knotentypdefinitionen sind im Repository als CND-Dateien vorhanden. Die CND-Notation wird als Teil der JCR-Dokumentation 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

Eigenschaft cq:tags

Die Eigenschaft cq:tags ist ein String-Array, das zum Speichern mindestens einer TagID verwendet wird, wenn diese von Autoren oder Website-Besuchern auf Inhalte angewendet werden. Die Eigenschaft hat nur dann eine Bedeutung, wenn sie einem Knoten hinzugefügt wird, der mit dem Mixin cq:Taggable definiert wird.

Verschieben und Zusammenführen von Tags

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

Wenn ein Tag A verschoben oder mit Tag B unter /content/cq:tags zusammengeführt wird:

• Tag A wird nicht gelöscht und erhält eine cq:movedTo-Eigenschaft.

  • cq:movedTo verweist auf Tag B.

  • Diese Eigenschaft bedeutet, dass Tag A in Tag B verschoben oder zusammengeführt wurde.

  • Durch Verschieben von Tag B wird diese Eigenschaft entsprechend aktualisiert.

  • Tag A ist somit ausgeblendet und wird nur im Repository behalten, um Tag-IDs in Inhaltsknoten aufzulösen, die auf Tag A verweisen.

  • Der Garbage Collector für Tags entfernt Tags wie Tag A, sobald keine Inhaltsknoten mehr darauf verweisen.

  • Ein spezieller Wert für die Eigenschaft cq:movedTo ist nirvana: Er wird angewendet, wenn das Tag gelöscht wird, aber nicht aus dem Repository entfernt werden kann, weil untergeordnete Tags mit cq:movedTo vorhanden sind, die nicht entfernt werden dürfen.

    HINWEIS

    Die cq:movedTo-Eigenschaft wird dem verschobenen oder zusammengeführten Tag nur hinzugefügt, wenn eine der folgenden Bedingungen erfüllt ist:

    1. Das Tag wird im Inhalt verwendet (d. h. es wird darauf verwiesen). ODER
    2. Das Tag enthält bereits verschobene untergeordnete Elemente.

• Tag B wird erstellt (im Falle einer Verschiebung) und erhält eine cq:backlinks-Eigenschaft.

  • cq:backlinks speichert Verweise in die andere Richtung, d. h. sie enthält eine Liste aller Tags, die verschoben oder mit Tag B zusammengeführt wurden.

  • Dies ist hauptsächlich erforderlich, um cq:movedTo-Eigenschaften auf dem aktuellen Stand zu halten, wenn Tag B auch verschoben/zusammengeführt/gelöscht oder aktiviert wird. In diesem Fall müssen all seine backlinks-Tags ebenso aktiviert werden.

    HINWEIS

    Die cq:backlinks-Eigenschaft wird dem verschobenen oder zusammengeführten Tag nur hinzugefügt, wenn eine der folgenden Bedingungen erfüllt ist:

    1. Das Tag wird im Inhalt verwendet (d. h. es wird darauf verwiesen). ODER
    2. Das Tag enthält bereits verschobene untergeordnete Elemente.

Das Lesen einer cq:tags-Eigenschaft eines Inhaltsknotens umfasst die folgende Auflösung:

1. Wenn unter /content/cq:tags keine Übereinstimmung verfügbar ist, wird kein Tag zurückgegeben.
2. Wenn das Tag eine cq:movedTo-Eigenschaft aufweist, steht danach die referenzierte Tag-ID.
   • Dieser Schritt wird so lange wiederholt, wie das angehängte Tag eine cq:movedTo-Eigenschaft aufweist.
3. Falls das angehängte Tag nicht über eine cq:movedTo-Eigenschaft verfügt, wird das Tag gelesen.

Um eine Änderung zu veröffentlichen, wenn ein Tag verschoben oder zusammengeführt wurde, müssen der Knoten cq:Tag und all seine Backlinks repliziert werden. Dies geschieht automatisch, wenn das Tag in der Tag-Verwaltungskonsole aktiviert wird.

Spätere Aktualisierungen der cq:tags-Eigenschaft der Seite bereinigen automatisch die alten Verweise. Dies wird ausgelöst, da die Auflösung eines verschobenen Tags über die API das Ziel-Tag zurückgibt und so die Ziel-Tag-ID bereitstellt.

Ressourcen für Business.Adobe.com