AEM-Tagging-Framework

So taggen Sie Inhalte und nutzen die AEM Tagging-Infrastruktur :

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 sein (z. B. fruit) oder stellen eine hierarchische Taxonomie dar (z. B. fruit/apple, d. h. sowohl Obst im Allgemeinen als auch der spezifischere Apfel).

Tags werden anhand einer eindeutigen Tag-ID identifiziert.

Ein Tag verfügt über optionale Metainformationen wie 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.
  • Optional jcr:title -Eigenschaft (der Titel, der in der Benutzeroberfläche angezeigt werden soll)
  • Optional jcr:description property
  • Wenn untergeordnete Knoten enthalten, wird dies als Container-Tag.
  • Sie wird im Repository unter einem Basispfad gespeichert, der als Stammknoten der Taxonomie.

TagID (Tag-ID)

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

In der Regel wird die TagID ist eine Kurzform, die mit dem -Namespace beginnt oder absolut beginnend mit der Stammknoten der Taxonomie.

Wenn Inhalt mit Tags versehen ist und noch nicht vorhanden ist, wird die cq:tags -Eigenschaft zum Inhaltsknoten hinzugefügt wird und die TagID wird zum String-Array-Wert der Eigenschaft 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 erlauben Gruppeneinträge. Der häufigste Anwendungsfall besteht darin, einen Namespace pro Site (z. B. öffentlich, intern und portal) oder pro größerer Anwendung (z. B. Sites, Assets, Forms) zu verwenden. Namespaces können jedoch 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, der TagID default (Titel ist Standard Tags), das /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 Unter-Zusammenfassung aller Unter-Tags. Beispielsweise Inhalte, die mit fruit/apple wird als mit fruit sowie Das bedeutet, dass die Suche nach Inhalten nur mit fruit auch den Inhalt finden, mit dem fruit/apple.

Auflösen von Tag-IDs

Wenn die Tag-ID einen Doppelpunkt enthält :, trennt der Doppelpunkt den Namespace vom Tag oder der Unter-Taxonomie, die dann durch normale Schrägstriche 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.

Verweisen auf nicht vorhandene Pfade oder Pfade, die nicht auf eine cq:Tag -Knoten werden als ungültig betrachtet und ignoriert.

Die folgende Tabelle zeigt einige Beispiele TagIDs, ihre Elemente und wie die TagID wird in einen absoluten Pfad im Repository aufgelöst.

TagID Namespace Lokale ID Container-Tag(s) Leaf-Tag Absoluter Repository-Pfad
dam:fruit/apple/braeburn dam fruit/apple/braeburn fruit, apple braeburn /content/cq:tags/dam/fruit/apple/braeburn
color/red default color/red color red /content/cq:tags/default/color/red
sky default sky Keine sky /content/cq:tags/default/sky
dam: dam Keine Keine Keine /content/cq:tags/dam
/content/cq:tags/category/car category car car car /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 können Autoren und Site-Besuchern die Möglichkeit geben, Tags in einem bestimmten Namespace zu erstellen oder zu verweigern, indem Sie entsprechende ACLs im Repository festlegen.

Außerdem wird durch das Verweigern von Leseberechtigungen für bestimmte Tags oder Namespaces die Fähigkeit gesteuert, Tags auf bestimmte Inhalte anzuwenden.

Eine typische Konfiguration umfasst:

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

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 die jcr:contentnode is type cq:PageContent , der Folgendes umfasst: cq:Taggable Mixin.
  • Assets (cq:Asset), deren Knoten jcr:content/metadata immer das Mixin cq:Taggable umfassen

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 cq:tags -Eigenschaft ist ein Zeichenfolgen-Array, mit dem eine oder mehrere TagIDist, wenn sie von Autoren oder Site-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.

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 zusammengeführt wird unter /content/cq:tags:

    • Tag A wird nicht gelöscht und erhält eine cq:movedTo -Eigenschaft.
    • Tag B wird erstellt (im Fall eines Verschiebevorgangs) 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 cq:movedTo Eigenschaft ist nirvana: wird angewendet, wenn das Tag gelöscht wird, aber nicht aus dem Repository entfernt werden kann, da es Untertags mit einer cq:movedTo die gehalten 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. Das Tag wird im Inhalt verwendet (d. h. es wird darauf verwiesen).
      2. Das Tag enthält bereits verschobene untergeordnete Elemente.
  • 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).
  2. Das Tag enthält bereits verschobene untergeordnete Elemente.
  • 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.

Migration von Tags

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

HINWEIS

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

So listen Sie Tags auf: 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.

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

  3. Aktualisieren Sie den Tag-Speicherort.

  4. Nachdem Sie Tags an den neuen Speicherort migriert haben, führen Sie 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 von cq:movedTo/cq:backLinks -Eigenschaft. Anschließend wird der abgerufene Ergebnissatz durchlaufen und der cq:movedTo und cq:backlinks Eigenschaftswerte in /content/cq:tags Pfade (in dem Fall, dass /etc/tags im Wert erkannt wird).

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

HINWEIS

Die klassische Benutzeroberfläche ist nicht mit Ausfallzeiten kompatibel und unterstützt nicht den neuen Tag-Basispfad. Wenn Sie die klassische Benutzeroberfläche als /etc/tags muss erstellt werden, gefolgt von cq-tagging Komponenten neu starten.

Falls die aktualisierten AEM-Instanzen von der TagManager-API unterstützt werden und in der klassischen Benutzeroberfläche ausgeführt werden:

  1. Einmal verweist auf alten Tag-Basispfad /etc/tags werden durch TagId oder den neuen Tag-Speicherort ersetzt. /content/cq:tags, können Sie Tags an den neuen Speicherort migrieren /content/cq:tags in CRX DE gefolgt vom Komponenten-Neustart.

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

Auf dieser Seite