AEM タグ付けフレームワーク

コンテンツにタグを付けてAEMタグ付けインフラストラクチャを活用するには:

  • タグは、cq:Tag タイプのノードとして分類階層のルートノードの下に存在する必要があります。
  • タグ付けされたコンテンツノードのNodeTypeには、cq:Taggable Mixin が含まれている必要があります。
  • この タグ ID がコンテンツノードの cq:tags プロパティを持ち、型のノードに解決されます。 cq:Tag.

タグ:cq:Tag ノードタイプ

タグの宣言は、リポジトリーにおける cq:Tag. タイプのノードにキャプチャされます。

タグは、単純な単語 ( 例: fruit) または階層的な分類 ( 例: fruit/appleというのは、果物全般と、より具体的なリンゴの両方を意味している )。

タグは一意のタグ ID によって識別されます。

タグには、タイトル、ローカライズされたタイトル、説明など、オプションのメタ情報が含まれます。 ユーザーインターフェイスには、TagID ではなくタイトル(存在する場合)が表示されます。

タグ付けフレームワークでは、作成者やサイト訪問者に、特定の事前定義されたタグだけを使用するよう制限を設けることもできます。

タグの特徴

タグ ID

TagID は、リポジトリー内のタグノードに解決されるパスを識別します。

通常、 TagID は、名前空間で始まる略記法か、 分類のルートノード.

コンテンツがタグ付けされているときに、コンテンツがまだ存在しない場合は、 cq:tags プロパティがコンテンツノードに追加され、 TagID がプロパティの文字列配列値に追加されます。

TagID は、名前空間とそれに続くローカルTagID で構成されます。コンテナタグにはサブタグがあり、これは分類における階層順序を表します。サブタグは、任意のローカルTagID と同じタグを参照するのに使用できます。例えば、fruit というタグが fruit/applefruit/banana などのサブタグを含むコンテナタグであっても、コンテンツにこのタグを付けることができます。

分類のルートノード

分類のルートノードは、リポジトリー内にあるすべてのタグの基本パスです。分類のルートノードは、cq:Tag タイプのノードにすることができません。

AEM の基本パスは /content/cq:tags であり、ルートノードのタイプは cq:Folder です。

タグの名前空間

名前空間はグループ化を可能にします。 最も一般的な使用例は、サイトごとに名前空間(公開、内部、ポータルなど)を持つ場合、または大規模なアプリケーションごとに名前空間を持つ場合ですが、名前空間は他の様々なニーズに使用できます。 名前空間は、現在のコンテンツに適用できるタグのサブセット(特定の名前空間のタグなど)のみを表示するために、ユーザーインターフェイスで使用されます。

タグの名前空間は、分類サブツリーの最初のレベルです。これは、分類のルートノードの直下のノードです。の直下のノードです。名前空間は cq:Tag タイプのノードで、その親は cq:Tag ノードタイプではありません。

すべてのタグには名前空間があります。名前空間が指定されていない場合、タグはデフォルトの名前空間 ( TagID default ( タイトルは Standard Tags) を /content/cq:tags/default.

コンテナタグ

コンテナタグは、任意の数およびタイプの子ノードを含む、cq:Tag タイプのノードです。これにより、カスタムメタデータを使用してタグモデルを強化できます。

さらに、分類のコンテナタグ(スーパータグ)は、すべてのサブタグの小計として機能します。例えば、 fruit/apple は、 fruit 同様に。 つまり、でタグ付けされたコンテンツを検索します fruit また、次のタグが付いたコンテンツも見つかります: fruit/apple.

タグ ID の解決

タグ ID にコロンが含まれる場合 :の場合、コロンでタグまたはサブ分類から名前空間が区切られ、その後通常のスラッシュで区切られます /. タグ ID にコロンが含まれていない場合は、デフォルトの名前空間が暗示されます。

タグの標準の場所は /content/cq:tags の下のみです。

存在しないパスまたはを指さないパスを参照するタグ cq:Tag ノードは無効と見なされ、無視されます。

次の表に、いくつかのサンプルを示します TagIDs、要素、および方法 TagID リポジトリ内の絶対パスに解決されます。

TagID 名前空間 ローカル ID コンテナタグ リーフタグ 絶対リポジトリパス
dam:fruit/apple/braeburn dam fruit/apple/braeburn fruitapple braeburn /content/cq:tags/dam/fruit/apple/braeburn
color/red default color/red color red /content/cq:tags/default/color/red
sky default sky なし sky /content/cq:tags/default/sky
dam: dam なし なし なし /content/cq:tags/dam
/content/cq:tags/category/car category car car car /content/cq:tags/category/car

タグタイトルのローカリゼーション

タグにオプションのタイトル文字列 (jcr:titleを参照 ) プロパティを追加することで、表示するタイトルをローカライズすることができます。 jcr:title.<locale>.

詳しくは、以下を参照してください。

アクセス制御

タグは、リポジトリー内で分類のルートノード 作成者やサイト訪問者に対し、特定の名前空間でタグを作成する機能を許可または拒否するには、リポジトリで適切な ACL を設定します。

また、特定のタグまたは名前空間に対する読み取り権限を拒否すると、特定のコンテンツにタグを適用する機能が制御されます。

典型的な設定は次のとおりです。

  • すべての名前空間への書き込みアクセス(tag-administrators 下への add/modify)を/content/cq:tags グループ/役割に許可する。
    • このグループは、追加設定なしで使用できる AEM に付属しています。
  • 読み取り可能にする必要があるすべての名前空間への読み取りアクセスをユーザー/作成者に許可する。
  • ユーザー/作成者がタグを自由に定義できる名前空間への書き込みアクセス(/content/cq:tags/some_namespace 下への add_node)をユーザー/作成者に許可する。

タグ付け可能なコンテンツ:cq:Taggable Mixin

アプリケーション開発者がコンテンツタイプにタグ付けを付加するには、ノードの登録(CND)に cq:Taggable Mixin または cq:OwnerTaggable Mixin を含める必要があります。

cq:OwnerTaggable Mixin は cq:Taggable から継承されており、その目的は、所有者または作成者がコンテンツを分類できることを示すことです。AEM では、cq:PageContent ノードの属性にすぎません。cq:OwnerTaggable Mixin は、タグ付けフレームワークには必要ありません。

メモ

集約されたコンテンツアイテムの最上位ノード(またはその jcr:content ノード)では、タグの有効化だけを行うことをお勧めします。以下に例を示します。

  • ページ ( cq:Page) で、 jcr:contentノードのタイプは cq:PageContent これには cq:Taggable mixin.
  • jcr:content/metadata ノードに常に cq:Taggable Mixin があるアセット(cq:Asset)。

ノードタイプの表記(CND)

ノードタイプの定義は、リポジトリー内に CND ファイルとして存在します。CND 表記は JCR ドキュメントの一部として定義されます ここ.

AEM に含まれるノードタイプの基本的な定義は、次のようになります。

[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 プロパティ

この cq:tags プロパティは、1 つ以上の TagID作成者またはサイト訪問者がコンテンツに適用した場合。 このプロパティは、cq:Taggable Mixin で定義されているノードに追加した場合にのみ意味があります。

メモ

AEM のタグ付け機能を使用するには、カスタムで開発されたアプリケーションで cq:tags 以外のタグプロパティを定義しないでください。

タグの移動と統合

次に、タグ付けコンソールを使用してタグの移動または統合を実行した場合のリポジトリ内での影響について説明します。

  • タグ A がの下のタグ B に移動または結合されたとき /content/cq:tags:

    • タグ A は削除されず、 cq:movedTo プロパティ。
    • タグ B が作成され(移動の場合)、 cq:backlinks プロパティ。
  • cq:movedTo はタグ B を指します。

    • このプロパティは、タグ A がタグ B に移動または結合されたことを意味します。

    • タグ B を移動すると、それに応じてこのプロパティが更新されます。したがって、タグ A は非表示になり、タグ A を指すコンテンツノード内のタグ ID を解決するためだけにリポジトリーに保持されます。

    • タグ A のようなタグは、それを指すコンテンツノードがなくなったら、タグのガベージコレクターによって削除されます。

    • の特別な値 cq:movedTo プロパティは nirvana:タグが削除された場合に適用されますが、リポジトリからは削除できません。これは、 cq:movedTo それは守るべきだ

      メモ

      cq:movedTo プロパティは、次のいずれかの条件を満たす場合にのみ、移動または結合されたタグに追加されます。

      1. タグがコンテンツで使用されている(つまり、参照が含まれている)。
      2. タグが、既に移動された子を持っている。
  • cq:backlinks は、それ以外を指す参照を保持します。つまり、タグ B に移動または結合されたすべてのタグのリストを保持します。

    • これは、タグ B が移動/結合/削除されたとき、またはタグ B がアクティブになったときに、cq:movedTo プロパティを最新の状態に保つために通常必要になります。この場合は、すべてのバックリンクタグもアクティブにする必要があります。
メモ

cq:backlinks プロパティは、次のいずれかの条件を満たす場合にのみ、移動または結合されたタグに追加されます。

  1. タグがコンテンツで使用されている(つまり、参照が含まれている)。
  2. タグが、既に移動された子を持っている。
  • コンテンツノードの cq:tags プロパティを読み取ると、以下のように解決されます。

    1. /content/cq:tags 下で一致するものが見つからない場合、タグは返されません。

    2. タグに cq:movedTo プロパティが設定されている場合は、参照先のタグ ID が使用されます。

      • これは、その次のタグに cq:movedTo プロパティがある限り繰り返されます。
    3. 次のタグに cq:movedTo プロパティがない場合は、そのタグが読み取られます。

  • タグを移動または結合したときに変更を発行するには、cq:Tag ノードとそのすべてのバックリンクを複製する必要があります。

    • これは、タグ管理コンソールでタグがアクティブにされたときに自動的に行われます。
  • 後でページの cq:tags プロパティに対して更新がおこなわれると、「以前の」参照が自動的にクリーンアップされます。

    • 移動したタグを API で解決すると移動先のタグが戻され、移動先のタグ ID が提供されることから、この処理がトリガーされます。

タグの移行

Adobe Experience Manager 6.4 以降では、タグは、 /content/cq:tags. ただし、Adobe Experience Managerが以前のバージョンからアップグレードされた場合、タグは古い場所に引き続き存在します /etc/tags. アップグレードされたシステムでは、タグをに移行する必要があります。 /content/cq:tags.

メモ

タグのページプロパティページでは、タグ ID( 例えば、 geometrixx-outdoors:activity/biking) の代わりに、タグの基本パス ( 例えば、 /etc/tags/geometrixx-outdoors/activity/biking) をクリックします。

タグをリストするには、 com.day.cq.tagging.servlets.TagListServlet を使用できます。

メモ

タグマネージャー API をリソースとして使用することをお勧めします。

アップグレードされたAEMインスタンスが TagManager API**をサポートしている場合

  1. コンポーネントの開始時に、TagManager API は、コンポーネントがアップグレードされたAEMインスタンスであるかどうかを検出します。 アップグレードされたシステムでは、タグは次の場所に保存されます。 /etc/tags.

  2. その後、TagManager API は下位互換性モードで実行されます。つまり、API は /etc/tags をベースパスとして使用します。 そうでない場合は、新しい場所が使用されます /content/cq:tags.

  3. タグの場所を更新します。

  4. 新しい場所にタグを移行した後、次のスクリプトを実行します。

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-------------------------------------"

スクリプトは、 /etc/tags ~の価値で cq:movedTo/cq:backLinks プロパティ。 その後、取得された結果セットを反復し、 cq:movedTo および cq:backlinks プロパティ値 /content/cq:tags パス ( /etc/tags が値で検出されました )。

アップグレードされたAEMインスタンスがクラシック UI で動作する場合**

メモ

クラシック UI は、ダウンタイムなしに準拠しておらず、新しいタグのベースパスをサポートしていません。 クラシック UI を使用する場合は、 /etc/tags を作成し、その後に cq-tagging コンポーネントを再起動します。

アップグレードされたAEMインスタンスが TagManager API でサポートされ、クラシック UI で実行される場合:

  1. 古いタグの基本パスへの参照が 1 回 /etc/tags は、tagId または新しいタグの場所を使用して置き換えられます。 /content/cq:tags、新しい場所にタグを移行できます /content/cq:tags CRX DE でコンポーネントを再起動します。

  2. 新しい場所にタグを移行した後、上記のスクリプトを実行します。

このページ