Il quadro di riferimento per l'assegnazione dei tag dell'AEM aem-tagging-framework

L’assegnazione tag consente di categorizzare e organizzare i contenuti. I tag possono essere classificati in base a uno spazio dei nomi e a una tassonomia. Per informazioni dettagliate sull’utilizzo dei tag:

Questo articolo si concentra sul framework sottostante che supporta l’assegnazione tag in AEM e su come utilizzarlo come sviluppatore.

Introduzione introduction

Per assegnare tag ai contenuti e utilizzare l'infrastruttura dei tag AEM:

cq:Tag Node Type cq-tag-node-type

La dichiarazione di un tag viene acquisita nell'archivio in un nodo di tipo cq:Tag.

Il framework dei tag limita inoltre l’utilizzo da parte di autori e visitatori del sito di soli tag specifici e predefiniti.

Caratteristiche tag tag-characteristics

ID tag tagid

Un TagID identifica un percorso che viene risolto in un nodo di tag nell'archivio.

In genere, TagID è una scorciatoia TagID che inizia con lo spazio dei nomi oppure può essere un TagID assoluto a partire dal nodo principale della tassonomia .

Quando il contenuto viene taggato, se non esiste ancora, la proprietà cq:tags viene aggiunta al nodo del contenuto e TagID al valore dell'array String della proprietà.

TagID è costituito da un namespace seguito dal TagID locale. I tag contenitore contengono tag secondari che rappresentano un ordine gerarchico nella tassonomia. I tag secondari possono essere utilizzati per fare riferimento ai tag come qualsiasi TagID locale. Ad esempio, è possibile assegnare tag al contenuto con fruit anche se si tratta di un tag contenitore con tag secondari, ad esempio fruit/apple e fruit/banana.

Nodo principale tassonomia taxonomy-root-node

Il nodo principale della tassonomia è il percorso di base per tutti i tag nell’archivio. Il nodo principale della tassonomia deve essere not un nodo di tipo cq:Tag.

In AEM, il percorso di base è /content/cq:tags e il nodo principale è di tipo cq:Folder.

Spazio dei nomi dei tag tag-namespace

Gli spazi dei nomi consentono di raggruppare gli elementi. Il caso d’uso più tipico consiste nell’avere uno spazio dei nomi per sito (ad esempio, pubblico rispetto a interno) o per applicazione più grande (ad esempio, Sites o Assets), ma gli spazi dei nomi possono essere utilizzati per varie altre esigenze. Nell’interfaccia utente, gli spazi dei nomi vengono utilizzati per mostrare solo il sottoinsieme di tag (ovvero i tag di un determinato spazio dei nomi) applicabile al contenuto corrente.

Lo spazio dei nomi del tag è il primo livello della sottostruttura della tassonomia, ovvero il nodo immediatamente sotto il nodo principale della tassonomia . Uno spazio dei nomi è un nodo di tipo cq:Tag il cui elemento padre non è un tipo di nodo cq:Tag.

Tutti i tag hanno uno spazio dei nomi. Se non viene specificato alcuno spazio dei nomi, il tag viene assegnato allo spazio dei nomi predefinito, ovvero TagID default, ovvero /content/cq:tags/default. In questi casi, il valore predefinito è Standard Tags.

Tag contenitore container-tags

Un tag contenitore è un nodo di tipo cq:Tag contenente un numero e un tipo qualsiasi di nodi figlio, che consente di migliorare il modello di tag con metadati personalizzati.

Inoltre, i tag contenitore (o super-tag) in una tassonomia fungono da sommatoria di tutti i tag secondari. Ad esempio, anche il contenuto con tag fruit/apple è considerato con tag fruit. In altre parole, la ricerca del contenuto con tag fruit troverebbe anche il contenuto con tag fruit/apple.

Risoluzione di TagID resolving-tagids

Se l'ID tag contiene i due punti (:), lo spazio dei nomi viene separato dal tag o dalla sottotassonomia, che vengono quindi separati con barre normali (/). Se l’ID tag non ha due punti, viene implicito lo spazio dei nomi predefinito.

La posizione standard e unica dei tag è inferiore a /content/cq:tags.

I tag che fanno riferimento a percorsi non esistenti o che non fanno riferimento a un nodo cq:Tag vengono considerati non validi e vengono ignorati.

Nella tabella seguente vengono illustrati alcuni TagID di esempio, i relativi elementi e il modo in cui TagID viene risolto in un percorso assoluto nell'archivio:

Localizzazione del titolo del tag localization-of-tag-title

Quando il tag include la stringa opzionale del titolo jcr:title, è possibile localizzare il titolo da visualizzare aggiungendo la proprietà jcr:title.<locale>.

Per ulteriori dettagli, vedi:

Controllo accesso access-control

I tag esistono come nodi nell'archivio nel nodo principale della tassonomia . È possibile consentire o negare agli autori e ai visitatori del sito la creazione di tag in un determinato spazio dei nomi impostando ACL appropriati nell'archivio.

Il rifiuto delle autorizzazioni di lettura per alcuni tag o spazi dei nomi controlla la possibilità di applicare tag a contenuto specifico.

Una pratica tipica include:

Contenuto assegnabile : cq:Taggable Mixin taggable-content-cq-taggable-mixin

Affinché gli sviluppatori di applicazioni possano associare tag a un tipo di contenuto, la registrazione del nodo (CND) deve includere il mixin cq:Taggable o il mixin cq:OwnerTaggable.

Il mixin cq:OwnerTaggable, che eredita da cq:Taggable, ha lo scopo di indicare che il contenuto può essere classificato dal proprietario/autore. In AEM è solo un attributo del nodo cq:PageContent. Il mixin cq:OwnerTaggable non è richiesto dal framework di assegnazione tag.

Notazione del tipo di nodo (CND) node-type-notation-cnd

Le definizioni dei tipi di nodo esistono nell’archivio come file CND. La notazione CND è definita nella documentazione JCR.

Le definizioni essenziali per i tipi di nodo inclusi nell’AEM sono le seguenti:

[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

cq:tags, proprietà cq-tags-property

La proprietà cq:tags è un array String utilizzato per memorizzare uno o più TagID quando vengono applicati al contenuto da autori o visitatori del sito. La proprietà ha un significato solo quando viene aggiunta a un nodo definito con il mixin cq:Taggable.

Spostamento e unione di tag moving-and-merging-tags

Di seguito è riportata una descrizione degli effetti nell’archivio durante lo spostamento o l’unione di tag tramite la console Assegnazione tag.

Quando il tag A viene spostato o unito al tag B in /content/cq:tags:

La lettura di una proprietà cq:tags di un nodo di contenuto richiede la seguente risoluzione:

Per pubblicare la modifica quando un tag è stato spostato o unito, è necessario replicare il nodo cq:Tag e tutti i relativi collegamenti. Questa replica viene eseguita automaticamente quando il tag viene attivato nella console di amministrazione dei tag.

Gli aggiornamenti successivi alla proprietà cq:tags della pagina eliminano automaticamente i riferimenti precedenti. La pulizia viene attivata perché la risoluzione di un tag spostato tramite l’API restituisce il tag di destinazione, fornendo così l’ID del tag di destinazione.