AEM を使用したヘッドレスのオーサリングの基本

最終更新日： 2024年7月15日

トピック：

作成対象：

管理者
開発者
ユーザー
リーダー

これまでの説明内容

AEM ヘッドレスコンテンツ作成者ジャーニーの冒頭のはじめにで、ヘッドレス向けのオーサリングに関連する基本概念と用語について説明しました。

この記事では、これらに基づいて、AEM ヘッドレスプロジェクト用に独自のコンテンツをオーサリングする方法を説明します。

目的

対象読者：初心者
目的：ヘッドレス CMS オーサリングの基本を紹介します。
- AEMaaCS を使用したオーサリングの概要
- コンテンツフラグメントの概要

基本操作

コンテンツフラグメントについて理解する前に、AEM の使用方法を簡単に説明します。実際には、ログインしてシステムを実際に使用してみるのが一番です。

オーサーとパブリッシュ

AEM インストールは、通常、少なくとも次の 2 つの環境で構成されます。

作成者
公開

ログインし、オーサー環境を使用してコンテンツを生成します。準備が整ったら、コンテンツを公開して、一般に利用できるようにします。ヘッドレスの場合は、他のアプリケーションに対して行われ、web ページの場合は、web 上の読者に対して行われます。

詳しくは、「オーサリングに関する概念」を参照してください。

アクション、選択、表示

Assets コンソールには、リソース（フォルダーやコンテンツフラグメントなど）を選択した後で使用できる専用の アクションツールバー および クイックアクション があります。

クイックアクションは、1 つのリソースに対して使用できます。下の Basel を参照してください。

クイックアクション

アクションツールバーでは、現在のシナリオに適用できるすべてのアクションにアクセスできます。使用可能なアクションは、場所や選択したリソース数（１つまたは複数）によって変わることがあります。

アクションツールバー

リソースの表示形式を表示セレクターで選択できます。

表示セレクター

項目に関する追加情報をパネルセレクター表示できます。追加のアクションにもアクセスできます。

左レール

コンテンツフラグメントのオーサリング

以上、AEM ユーザーインターフェイス（UI）について簡単に説明しました。実際に UI を試してみる機会があれば幸いです。ここからは、実際の関心事である、ヘッドレスのコンテンツフラグメンについて説明します。

最初から最後まで説明する必要がありますが、お使いのインスタンスにはフォルダーやフラグメントが既に作成されていて、それらが様々な場所に存在している可能性があります。原則はすべて同じです。

整理とナビゲーション

コンテンツフラグメントがほとんどない場合を除き、コンテンツフラグメントを整理して、作成者（および他のユーザー）が見つけやすくします。

フォルダーの作成

そのためには、Assets コンソールの「ファイル」セクション内に一連のフォルダーを作成します。「作成」オプション（右上）を選択したあと、「フォルダー」を選択します。

フォルダー作成オプション

詳細を入力できるダイアログが開くので、入力後、「作成」で確定します。

フォルダー作成ダイアログ

フォルダーで使用可能なコンテンツフラグメントモデルをパスとタグで制限する方法

この節の内容は少し上級者向けです。開始したばかりで試している段階ならそれほど必要ではありませんが、多数のフラグメントがある場合に最も便利です。まだ使わなくても、知っておいて損はありません。

コンテンツアーキテクトは、現在のプロジェクトや他のプロジェクトに必要なすべてのコンテンツフラグメントモデルを作成しています。自分自身や他の作成者が作業を簡単に行えるように、特定のフォルダーで使用できるモデルのリストを制限できます。

フォルダーを作成したら、そのフォルダーの プロパティ を開きます。ここには、フォルダーに関する情報と設定詳細の様々なタブがあります。特に、コンテンツフラグメントの場合は、「ポリシー」タブを使用して、このフォルダーに特定のパスやタグを定義できます。これにより、フォルダーで使用できるコンテンツフラグメントモデルが制限されます。つまり、コンテンツフラグメントモデルを使用してこのフォルダーでフラグメントを生成するには、これらの要件を満たす必要があるということです。

フォルダープロパティの作成 - ポリシー

NOTE

詳しくは、「コンテンツフラグメントモデル」の「アセットフォルダーでのコンテンツフラグメントモデルの許可」の節を参照してください。

次に、これらのフォルダーを移動して、コンテンツフラグメントの作成と編集を行います。

フォルダークラウドサービスの設定（参考まで）

以下は参考までに説明しておきます。

フォルダーを作成できる初期フォルダーがあらかじめ用意されているはずです。これは、一部の設定詳細を（通常は開発者またはシステム管理者が）ルートフォルダーに適用する必要があるからです。おそらく重要ではありませんが、必要に応じて、フォルダーの プロパティ の クラウドサービス で設定を確認できます。

フォルダープロパティの作成 - 設定

NOTE

詳しくは、「アセットフォルダーへの設定の適用」を参照してください。

コンテンツフラグメントの作成

コンテンツフラグメントの作成はフォルダーの作成と非常に似ています。代わりに、「コンテンツフラグメント」オプションを使用するだけです。

コンテンツフラグメントオプションの作成

今度は、ウィザードが開きます。最初の手順では、フラグメントの基になるコンテンツフラグメントモデルを選択します。

コンテンツフラグメント作成 - モデルの選択

「次へ」で続行した後、フラグメントの詳細（「基本」および「詳細」）を指定できます。

コンテンツフラグメント作成 - 名前の指定

「作成」で確定すると、フラグメントをエディターで開くことができます。

フラグメントの編集

フラグメントは、作成後すぐに開くことも、Assets コンソールから選択して開くこともできます。

エディターが初めて開くと、以下のものが表示されます。

左側のアイコンリスト - 様々な機能領域にアクセスできます。「バリエーション」タブにエディターが開きます。編集作業のほとんどは、ここで行います。「注釈」タブと「メタデータ」タブも必要になるかもしれません。
フラグメントに関する情報が表示され、様々なアクションにもアクセスできるヘッダー。
メインの編集領域 - フラグメントの作成に使用したモデルによって異なります。

例：

複数の情報（一部は特定のタイプのもの）のみを必要とするフラグメント。ヘッドレスコンテンツの場合、参照は重要です。これについては、後ほどジャーニーで説明します。
長いテキスト文を書き込むことができるフラグメント。ここには、テキストを管理および書式設定するための追加のオプションがあります。個々のテキストフィールドを全画面表示エディターで開くこともできます（右側の小さい画面アイコンを使用）。

NOTE

一部のフィールドへの正しい入力方法の詳細を作成者が理解するたに、プロジェクト固有のドキュメントが必要になる場合があります。

一般的な詳細については、「コンテンツフラグメントモデル」の「データタイプ」と「プロパティ」の節を参照してください。

「保存」または「保存して閉じる」を使用して、更新を確定します。

NOTE

詳しくは、「バリエーション - フラグメントコンテンツのオーサリング」を参照してください。

（おそらく）気にする必要がないもの

やや奇妙なタイトルの節ですが、コンテンツフラグメントエディターを開いて詳細な作業に入ると、コンテンツ作成者のヘッドレスジャーニーに（おそらく）当てはまらない様々なオプションが表示されることになります。そこで、ここでは、ヘッドレスコンテキストで無視できるものについて簡単に説明しておきます。

コンテンツフラグメントモデル

エディター上部のフラグメント名のすぐ下に、コンテンツフラグメントモデルの名前が表示されます。これは、モデルエディターに移動するリンクでもあります。
コンテンツフラグメントモデルは、使用する構造を定義するものなので、実際にはコンテンツフラグメントにとってきわめて重要です。ただし、コンテンツフラグメントモデルの作成と編集を担当するのは、（通常は）別のペルソナであるコンテンツアーキテクトです。

NOTE
詳しくは、「AEM ヘッドレスコンテンツアーキテクトジャーニー」を参照してください。
関連コンテンツ

これはエディターのタブなので明らかです。

コンテンツフラグメント機能は、AEM ではかなり前のバージョンから利用可のです。元々は、ページのオーサリング時に「従来の」用途に使用できるようになっていました。同様の使い方は使用されています。これには、フラグメントに埋め込まれてはいないものの、ページのオーサリング時に作成者が使用できる必要があるアセット（画像など）の関連付けが含まれる場合があります。
プレビュー

これはエディターの別のタブで、主に開発者向けの技術的な内容を提供します。
ページ参照を更新

このアクションは、「…」（省略記号）ドロップダウンから使用できます。これはページのオーサリングに関係するものなので、ヘッドレス作成者向けのものではありません。

公開

フラグメントが完成したら公開して、ヘッドレスアプリケーションで利用できるようにします。

公開アクションは、エディターで（または Assets コンソールのツールバーから）実行できます。

コンテンツフラグメントエディター - マイフラグメント

次の手順

これで基本を説明したので、次のステップはコンテンツフラグメントでの参照の使用についてです。ここでは、使用可能な様々な参照を紹介し、ヘッドレス向けオーサリングの重要な部分であるフラグメント参照を使用した構造レベルの作成方法について説明します。