コンテンツフラグメントのカスタマイズと拡張 customizing-and-extending-content-fragments
Adobe Experience Manager as a Cloud Service 内で、コンテンツフラグメントは標準アセットを拡張します。
-
コンテンツフラグメントについて詳しくは、コンテンツフラグメントの作成と管理およびコンテンツフラグメントを使用したページオーサリングを参照してください。
-
「アセットの管理」を参照してください。
アーキテクチャ architecture
コンテンツフラグメントの基本的な構成要素は次のとおりです。
- コンテンツフラグメント 自体
- 1 つ以上の コンテンツ要素 で構成されます
- 1 つ以上の コンテンツバリエーション を含めることができます
個々のコンテンツフラグメントは、コンテンツフラグメントモデルに基づいています。
-
コンテンツフラグメントモデルでは、コンテンツフラグメントの作成時にその構造を定義します。
-
フラグメントはモデルを参照するので、モデルに対する変更は、依存するフラグメントにも影響する可能性があります。
-
モデルはデータタイプで構成されています。
-
新しいバリエーションを追加するときなどは、それに合わせてフラグメントを更新する必要があります。
note note NOTE コンテンツフラグメントを表示およびレンダリングするには、アカウントにモデルへの read権限が必要です。note caution CAUTION 既存のコンテンツフラグメントモデルに変更を加えると、そのモデルに関連付けられているフラグメントに影響が生じる場合があり、対象のフラグメントで孤立プロパティが生まれることもあります。
Sites と Assets の統合 integration-of-sites-with-assets
コンテンツフラグメント管理（CFM）は、次の理由から Adobe Experience Manager（AEM）Assets の一部と考えられます。
- コンテンツフラグメントはアセットである。
- 既存のアセット機能を使用します。
- Assets と完全に統合されています（管理コンソールなど）。
コンテンツフラグメントは、次のように AEM Sites の機能と見なされます。
- ページのオーサリング時に使用されます。
コンテンツフラグメントとアセットのマッピング mapping-content-fragments-to-assets
コンテンツフラグメントモデルがベースのコンテンツフラグメントは、単一のアセットにマッピングされます。
-
すべてのコンテンツはアセットの
jcr:content/dataノードに格納されます。-
要素データは次のプライマリサブノードに格納されます。
jcr:content/data/master -
バリエーションは、そのバリエーション名のサブノードに格納されます。
例：jcr:content/data/myvariation -
各要素のデータは、その要素名のプロパティとしてそれぞれのサブノードに格納されます。
例えば、text要素のコンテンツは、textプロパティとしてjcr:content/data/masterに格納されます。
-
-
メタデータと関連コンテンツは、
jcr:content/metadataに格納されます。
ただし、タイトルと説明は従来のメタデータと見なされないので、jcr:contentに格納されます。
アセットの場所 asset-location
標準アセットの場合、コンテンツフラグメントは次の場所に保持されます。
/content/dam
アセットの権限 asset-permissions
詳しくは、コンテンツフラグメント - 削除に関する考慮事項を参照してください。
機能の統合 feature-integration
Assets コアと統合するには：
-
コンテンツフラグメント管理（CFM）機能は、アセットコアを基に構築されます。
-
CFM は、カード／列／リスト表示の項目に独自の実装を提供します。つまり、それらの項目が、既存のアセットコンテンツのレンダリング実装に挿入されます。
-
コンテンツフラグメントに対応するために、いくつかのアセットコンポーネントが拡張されています。
ページでのコンテンツフラグメントの使用 using-content-fragments-in-pages
コンテンツフラグメントは、他のアセットタイプと同様に、AEM ページから参照できます。AEM では、コンテンツフラグメントコアコンポーネント を利用できます。これは、コンテンツフラグメントをページ上に含めることができるコンポーネントです。この コンテンツフラグメント コアコンポーネントを拡張することもできます。
-
このコンポーネントは、
fragmentPathプロパティを使用して、実際のコンテンツフラグメントを参照します。fragmentPathプロパティは、その他のアセットタイプの類似プロパティと同じ方法で処理されます。例えば、コンテンツフラグメントが別の場所に移動された場合などです。 -
このコンポーネントを使用して、表示するバリエーションを選択できます。
-
また、一定範囲の段落を選択して、出力を制限することもできます。例えば、複数列の出力に利用できます。
-
このコンポーネントは、中間コンテンツを許可します。
-
ここでは、コンポーネントを使用して、参照されるフラグメントの段落の間に他のアセット（画像など）を配置できます。
-
中間コンテンツの場合：
-
参照が不安定になる可能性があります。中間コンテンツ（ページのオーサリング時に追加）には、その横に配置された段落との固定的な関係がありません。中間コンテンツの位置の前に（コンテンツフラグメントエディターで）新しい段落を挿入すると、相対位置が失われる場合があります。
-
ページにレンダリングされる内容を設定するには、追加のパラメーター（バリエーションや段落フィルターなど）を検討します。
-
-
その他のフレームワークとの統合 integration-with-other-frameworks
コンテンツフラグメントは、次と統合できます。
-
翻訳
コンテンツフラグメントは、AEM の翻訳ワークフローと完全に統合されています。つまり、アーキテクチャレベルでは以下を意味します。
-
コンテンツフラグメントの個々の翻訳は、別々のフラグメントです。例えば、以下のようになります。
-
それぞれ異なる言語のルートの下に位置していますが、関連する言語ルートの下の同じ相対パスを共有します。
/content/dam/<path>/en/<to>/<fragment>上記に対して次のようになります。
/content/dam/<path>/de/<to>/<fragment>
-
-
ルールベースのパス以外に、コンテンツフラグメントの異なる言語バージョン間には他の接続はありません。2 つの別個のフラグメントとして処理されますが、UI は言語バリアント間を移動する手段を提供します。
note note NOTE AEM 翻訳ワークフローでは、 /contentが使用されます。- コンテンツフラグメントモデルは
/conf内に配置されるので、これらの翻訳には含まれません。UI 文字列を国際化できます。
-
-
メタデータスキーマ
-
コンテンツフラグメントは、標準アセットで定義できるメタデータスキーマを使用および再使用します。
-
CFM には、次のような独自の固有のスキーマがあります。
/libs/dam/content/schemaeditors/forms/contentfragment必要に応じて拡張できます。
-
各スキーマフォームは、フラグメントエディターと統合されます。
-
コンテンツフラグメント管理 API - サーバーサイド the-content-fragment-management-api-server-side
サーバー側 API を使用して、コンテンツフラグメントにアクセスできます。以下を参照してください。
主要インターフェイス key-interfaces
次の 3 つのインターフェイスが、入口の役割を果たします。
-
コンテンツフラグメント（ContentFragment）
このインターフェイスでは、コンテンツフラグメントを抽象化して使用できます。
このインターフェイスでは、次のことを実行できます。
-
基本データを管理する（名前の取得、タイトルまたは説明の取得／設定など）
-
メタデータにアクセスする
-
要素にアクセスする
-
要素をリスト表示する
-
要素を名前で取得する
-
要素を作成する（注意事項を参照）
-
要素データにアクセスする（
ContentElementを参照）
-
-
そのフラグメントに対して定義されているバリエーションをリスト表示する
-
バリエーションをグローバルに作成する
-
関連コンテンツを管理する
- コレクションをリスト表示する
- コレクションを追加する
- コレクションを削除する
-
フラグメントのモデルにアクセスする
フラグメントの主要要素を表すインターフェイスは、次のとおりです。
-
コンテンツ要素（ContentElement）
-
コンテンツのバリエーション（ContentVariation）
- 基本データ（名前、タイトル、説明）を取得
- コンテンツを取得／設定する
- 最終変更情報に基づく単純な同期
3 つのインターフェイス（
ContentVariation、ContentFragment、ContentElement、）すべてによってVersionableインターフェイスを拡張し、コンテンツフラグメントに必要な次のバージョン管理機能を追加します。- 要素のバージョンを作成する
- 要素のバージョンをリスト表示する
- バージョン管理されている要素の特定のバージョンのコンテンツを取得する
-
適応 - adaptTo() の使用 adapting-using-adaptto
次のものを適応させることができます。
-
ContentFragmentは、次のものに適応させることができます。-
Resource- 基になる Sling リソース。基になるResourceを直接更新するにはContentFragmentオブジェクトを再構築します。 -
Asset- コンテンツフラグメントを表す DAMAssetの抽象化。Assetを直接更新するにはContentFragmentオブジェクトを再構築する必要があります。
-
-
ContentElementは、次のものに適応させることができます。ElementTemplate- 要素の構造に関する情報にアクセスするためのものです。
-
Resourceは、次のものに適応させることができます。ContentFragment
注意事項 caveats
次のことに注意してください。
-
API 全体は、（API JavaDoc で特に記載がない限り）変更を自動的に永続化 しない ように設計されています。したがって、各リクエストのリソースリゾルバー（または実際に使用しているリゾルバー）を常にコミットします。
-
追加の作業が必要になる可能性のあるタスクは、次のとおりです。
-
アドビでは、
ContentFragmentからバリエーションを作成することをお勧めします。こうすることで、すべての要素がこのバリエーションを共有することになり、適切なグローバルデータ構造が必要に応じて更新され、新しいバリエーションがコンテンツ構造に反映されます。 -
ContentElement.removeVariation()を使用して、要素を介して既存のバリエーションを削除しても、バリエーションに割り当てられたグローバルデータ構造は更新されません。これらのデータ構造を確実に同期させるには、代わりにContentFragment.removeVariation()を使用すると、バリエーションがグローバルに削除されます。
-
コンテンツフラグメント管理 API - クライアント側 the-content-fragment-management-api-client-side
追加情報 additional-information
次のファイルを参照してください。
-
filter.xmlコンテンツフラグメント管理のための
filter.xmlは、アセットのコアコンテンツパッケージと重複しないように設定されています。
編集セッション edit-sessions
複数のビュー（= HTML ページ）にまたがる可能性があるコンテンツフラグメントの編集はアトミックです。このようなアトミックなマルチ表示編集機能は、一般的な AEM の概念ではないので、コンテンツフラグメントは、編集セッション と呼ばれるものを使用します。
編集セッションは、ユーザーがエディターでコンテンツフラグメントを開くと開始されます。ユーザーが「保存」または「キャンセル」を選択してエディターから移動すると、編集セッションは終了します。
技術的には、他のすべての AEM 編集と同様に、すべての編集は ライブ コンテンツに対して行われます。編集セッションが開始されると、現在の未編集ステータスのバージョンが作成されます。ユーザーが編集をキャンセルすると、そのバージョンが復元されます。編集が ライブ コンテンツに対して行われたことにより、すべての変更が既に保持されるので、ユーザーが「保存」をクリックしても、特定の操作は行われません。また、「保存」をクリックすると、フルテキスト検索情報の作成や混合メディアアセットの処理など、一部のバックグラウンド処理がトリガーされます。
エッジケースには、いくつかの安全対策があります。例えば、ユーザーが編集セッションを保存またはキャンセルせずにエディターを終了しようとした場合などです。また、データの損失を防ぐために、定期的な自動保存を使用できます。
2 人のユーザーが同じコンテンツフラグメントを同時に編集できるので、相互の変更が上書きされます。これを防ぐには、フラグメントに DAM 管理の チェックアウト アクションを適用して、コンテンツフラグメントをロックする必要があります。
例 examples
例：既存のコンテンツフラグメントへのアクセス example-accessing-an-existing-content-fragment
既存のコンテンツフラグメントにアクセスするには、API を表すリソースを以下に適応させます。
com.adobe.cq.dam.cfm.ContentFragment
次に例を示します。
// first, get the resource
Resource fragmentResource = resourceResolver.getResource("/content/dam/fragments/my-fragment");
// then adapt it
if (fragmentResource != null) {
ContentFragment fragment = fragmentResource.adaptTo(ContentFragment.class);
// the resource is now accessible through the API
}
例：コンテンツフラグメントの作成 example-creating-a-new-content-fragment
コンテンツフラグメントをプログラムで作成するには、モデルリソースから適応させた FragmentTemplate を使用します。
次に例を示します。
Resource modelRsc = resourceResolver.getResource("...");
FragmentTemplate tpl = modelRsc.adaptTo(FragmentTemplate.class);
ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");
例：自動保存間隔の指定 example-specifying-the-auto-save-interval
自動保存間隔（秒単位）は、設定マネージャー（ConfMgr）を使用して定義できます。
-
ノード：
<conf-root>/settings/dam/cfm/jcr:content -
プロパティ名：
autoSaveInterval -
型：
Long -
デフォルト：
600（10 分）。/libs/settings/dam/cfm/jcr:contentで定義されています
自動保存間隔を 5 分に設定する場合は、ノードにプロパティを定義します。
次に例を示します。
-
ノード：
/conf/global/settings/dam/cfm/jcr:content -
プロパティ名：
autoSaveInterval -
型：
Long -
値：
300（5 分は 300 秒です）
ページオーサリング用コンポーネント components-for-page-authoring
詳しくは、次を参照してください。