AEM-Tagging-Framework

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

  • Das Tag muss unterhalb des cq:TagStammknotens der Taxonomie als Knoten vom Typ vorhanden sein

  • Der NodeType des mit Tags versehenen Inhaltsknotens muss das Mixin cq:Taggable beinhalten.

  • Die TagID wird der cq:tags-Eigenschaft des Inhaltsknotens hinzugefügt und wird zu einem Knoten des Typs cq:Tag aufgelöst.

Tags: cq:Tag-Knotentyp

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

Ein Tag kann ein einfaches Wort (z. B. Himmel) sein oder eine hierarchische Taxonomie (z. B. Frucht/Apfel, womit sowohl die Frucht im Allgemeinen als auch der Apfel im Speziellen gemeint sind) darstellen.

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

  • Knotentyp ist cq:Tag

  • Knotenname ist eine Komponente von TagID

  • TagID enthält immer einen Namespace

  • optionale Eigenschaft jcr:title (der Titel, der in der Benutzeroberfläche angezeigt werden soll)

  • optionale Eigenschaft jcr:description

  • wird als Container-Tag bezeichnet, wenn untergeordnete Knoten enthalten sind

  • wird im Repository unterhalb eines Basispfads gespeichert, der als Stammknoten der Taxonomie bezeichnet wird

TagID (Tag-ID)

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

Normalerweise ist die TagID eine kurze TagID, die mit dem Namespace beginnt, oder es kann sich um eine absolute TagID handeln, die vom Taxonomie-Stammknoten aus beginnt.

Wenn Inhalte mit Tags versehen werden, aber noch nicht vorhanden sind, wird dem Inhaltsknoten die Eigenschaft cq:tags und dem String-Array-Wert die Tag-ID 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. Unter-Tags können verwendet werden, um Tags zu referenzieren, die mit jeder lokalen Tag-ID übereinstimmen. Beispielsweise ist das Tagging von Inhalten mit "Frucht"zulässig, selbst wenn es sich um ein Container-Tag mit Untertags wie "Frucht/Apfel"und "Frucht/Banane"handelt.

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 häufigste Anwendungsfall besteht darin, einen Namespace pro (Website)-Site (z. B. öffentlich, intern und portal) oder pro größerer Anwendung (z. B. WCM, Assets, Communities) zu haben, jedoch können Namespaces für verschiedene andere Anforderungen verwendet 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 Standard-Namespace zugewiesen, d. h. TagID default (Titel ist Standard Tags),d. h. /content/cq:tags/default.

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 „Frucht/Apfel“ versehen sind, auch als mit dem Tag „Frucht“ versehen betrachtet. Wenn also nach Inhalten gesucht wird, die mit dem Tag „Frucht“ versehen sind, werden auch Inhalte mit dem Tag „Frucht/Apfel“ 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 Pfade verweisen, die nicht auf einen cq:Tag-Knoten verweisen, 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:

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

TagID (Tag-ID)
Namespace Lokale ID Container-Tag(e) Leaf-Tag Repository
Absoluter Tag-Pfad
dam:frucht/apple/braeburn dam Obst/Apfel/Braeburn Obst, Apfel Braeburn /content/cq:tags/dam/frucht/apple/braeburn
color/red default color/red color red /content/cq:tags/default/color/red
Himmel default Himmel (keine) Himmel /content/cq:tags/default/sky
dam: dam (keine) (keine) (keines, der Namespace) /content/cq:tags/dam
/content/cq:tags/category/car category Auto Auto Auto /content/cq:tags/category/car

Lokalisierung des Tag-Titels

Wenn das Tag den optionalen Titelstring 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

Zugriffssteuerung

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

Außerdem können Sie die Fähigkeit zur Anwendung von Tags auf bestimmte Inhalte steuern, indem Sie Leseberechtigungen für bestimmte Tags oder Namespaces einschränken.

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).

  • Benutzern/Autoren Schreibzugriff auf die Namespaces zu gewähren, in denen Tags von Benutzern/Autoren frei definiert werden sollen (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.

HINWEIS

Es wird empfohlen, Tags nur auf dem Knoten der obersten Ebene eines aggregierten Inhaltselements (oder dessen jcr:content-Knoten) zu aktivieren. Beispiele dafür sind:

  • Seiten ( cq:Page), wobei der Knoten jcr:contentvom Typ cq:PageContent ist, der das Mixin cq:Taggable enthält.

  • Assets ( cq:Asset), wobei der Knoten jcr:content/metadata immer das Mixin cq:Taggable aufweist.

Knotentypnotation (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

Die Eigenschaft cq:tags ist ein String-Array, das zum Speichern mindestens einer Tag-ID verwendet wird, wenn diese von Autoren oder Websitebesuchern 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.

HINWEIS

Um die AEM-Tagging-Funktionalität zu nutzen, sollten benutzerdefinierte entwickelte Anwendungen keine anderen Tag-Eigenschaften als cq:tags definieren.

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.
    • Tag B wird erstellt (im Falle einer Verschiebung) und erhält eine cq:backlinks-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: wird angewendet, wenn das Tag gelöscht wird, aber nicht aus dem Repository entfernt werden kann, da es Untertags mit einem cq:movedTo gibt, die beibehalten werden müssen.

    HINWEIS

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

    1. Tag wird im Inhalt verwendet (d. h. es hat einen Verweis) ODER
    2. Tag enthält untergeordnete Elemente, die bereits verschoben wurden.
  • 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. Tag wird im Inhalt verwendet (d. h. es hat einen Verweis) ODER
  2. Tag enthält untergeordnete Elemente, die bereits verschoben wurden.
  • Das Lesen einer cq:tags-Eigenschaft eines Inhaltsknotens umfasst die folgenden Auflösungen:

    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.

Tags-Migration

Ab Experience Manager 6.4 werden Tags unter /content/cq:tags gespeichert, die zuvor unter /etc/tags gespeichert wurden. In Szenarien, in denen Adobe Experience Manager von der vorherigen Version aktualisiert wurde, sind die Tags jedoch immer noch unter dem alten Speicherort /etc/tags vorhanden. In aktualisierten Systemen müssen Tags unter /content/cq:tags migriert werden.

HINWEIS

Auf der Seite Seiteneigenschaften der Tags wird empfohlen, Tag-ID (z. B. geometrixx-outdoors:activity/biking) zu verwenden, anstatt den Tag-Basispfad fest zu codieren (z. B. /etc/tags/geometrixx-outdoors/activity/biking).

Zum Auflisten von Tags kann com.day.cq.tagging.servlets.TagListServlet verwendet werden.

HINWEIS

Es wird empfohlen, die Tag-Manager-API als Ressource zu verwenden.

Wenn die aktualisierte AEM-Instanz die TagManager-API unterstützt

  1. Zu Beginn der Komponente erkennt die TagManager-API, ob es sich um eine aktualisierte AEM handelt. In einem aktualisierten System werden Tags unter /etc/tags gespeichert.

  2. Die TagManager-API wird dann im Abwärtskompatibilitätsmodus ausgeführt, d. h. die API verwendet /etc/tags als Basispfad. Wenn nicht, wird der neue Speicherort /content/cq:tags verwendet.

  3. Aktualisieren Sie den Tag-Speicherort.

  4. Führen Sie nach der Migration von Tags an den neuen Speicherort das folgende Skript aus:

import org.apache.sling.api.resource.*
import javax.jcr.*

ResourceResolverFactory resourceResolverFactory = osgi.getService(ResourceResolverFactory.class);
ResourceResolver resolver = resourceResolverFactory.getAdministrativeResourceResolver(null);
Session session = resolver.adaptTo(Session.class);

def queryManager = session.workspace.queryManager;
def statement = "/jcr:root/content/cq:tags//element(*, cq:Tag)[jcr:contains(@cq:movedTo,\'/etc/tags\') or jcr:contains(@cq:backlinks,\'/etc/tags\')]";
def query = queryManager.createQuery(statement, "xpath");

println "query = ${query.statement}\n";

def tags = query.execute().getNodes();


tags.each { node ->
        def tagPath = node.path;
        println "tag = ${tagPath}";

        if(node.hasProperty("cq:movedTo") && node.getProperty("cq:movedTo").getValue().toString().startsWith("/etc/tags")){

                def movedTo = node.getProperty("cq:movedTo").getValue().toString();

                println "cq:movedTo = ${movedTo} \n";

                movedTo = movedTo.replace("/etc/tags","/content/cq:tags");
                node.setProperty("cq:movedTo",movedTo);
        } else if(node.hasProperty("cq:backlinks")){

               String[] backLinks = node.getProperty("cq:backlinks").getValues();
               int count = 0;

               backLinks.each { value ->
                       if(value.startsWith("/etc/tags")){
                               println "cq:backlinks = ${value}\n";
                               backLinks[count] = value.replace("/etc/tags","/content/cq:tags");
    }
                       count++;
               }

               node.setProperty("cq:backlinks",backLinks);
  }
}
session.save();

println "---------------------------------Success-------------------------------------"

Das Skript ruft alle Tags ab, die /etc/tags im Wert der Eigenschaft cq:movedTo/cq:backLinks aufweisen. Anschließend wird der abgerufene Ergebnissatz durchlaufen und die Eigenschaftswerte cq:movedTo und cq:backlinks werden in /content/cq:tags Pfade aufgelöst (sofern /etc/tags im Wert erkannt wird).

Wenn die aktualisierte AEM-Instanz auf der klassischen Benutzeroberfläche ausgeführt wird

HINWEIS

Die klassische Benutzeroberfläche ist nicht mit Ausfallzeiten kompatibel und unterstützt keinen neuen Tag-Basispfad. Wenn Sie die klassische Benutzeroberfläche verwenden möchten, müssen Sie /etc/tags erstellen, gefolgt von cq-tagging Komponenten-Neustart.

Bei aktualisierten AEM von TagManager-API unterstützten Instanzen, die in der klassischen Benutzeroberfläche ausgeführt werden:

  1. Sobald Verweise auf den alten Tag-Basispfad /etc/tags durch tagId oder den neuen Tag-Speicherort /content/cq:tags ersetzt werden, können Sie Tags in CRX an den neuen Speicherort /content/cq:tags migrieren und anschließend einen Komponenten-Neustart durchführen.

  2. Nachdem Sie Tags an den neuen Speicherort migriert haben, führen Sie das oben genannte Skript aus.

Auf dieser Seite