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

注意

AEM GraphQL API for Content Fragments配信は、リクエストに応じて使用できます。

お使いのAEM用のAPIをCloud Serviceプログラムとして有効にするには、Adobeサポートにお問い合わせください。

コンテンツフラグメントモデルは、コンテンツフラグメントのコンテンツの構造を定義します。

コンテンツフラグメントモデルを使用するには:

  1. インスタンスに対するコンテンツフラグメントモデル機能の有効化
  2. コンテンツフラグメントモデルの作成設定
  3. コンテンツフラグメントの作成時に使用するコンテンツフラグメ ントの作成時に使用するコンテンツフラグメントモデルの有効化

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

  1. ツールアセット​に移動し、コンテンツフラグメントモデル​を開きます。

  2. 目的の設定に適したフォルダーに移動します。

  3. 作成」を使用してウィザードを開きます。

    注意

    コンテンツフラグメントモデルの使用が有効になっていない場合、「作成」オプションは使用できません。

  4. モデルタイトル」を指定します。また、必要に応じて​タグ​と​説明​を追加することもできます。

    タイトルと説明

  5. 作成」を使用して空のモデルを保存します。操作の成功を示すメッセージが表示されます。「開く」を選択してモデルをすぐに編集するか、「完了」を選択してコンソールに戻ることができます。

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

コンテンツフラグメントモデルは、データタイプ​の選択を使用して、結果のコンテンツフラグメントの構造を効果的に定義します。 モデルエディターを使用して、データ型のインスタンスを追加し、それらを設定して必須フィールドを作成できます。

注意

既存のコンテンツフラグメントモデルを編集すると、依存するフラグメントが影響を受ける可能性があります。

  1. ツールアセット​に移動し、コンテンツフラグメントモデル​を開きます。

  2. コンテンツフラグメントモデルが含まれているフォルダーに移動します。

  3. 必要なモデルを​編集​用に開きます。クイック操作を使用するか、モデルを選択してツールバーから操作を選択します。

    モデルを開くと、モデルエディターに次の情報が表示されます。

    • 左:既に定義されているフィールド
    • 右:フィールドの作成に使用できる​データタイプ(およびフィールドの作成後に使用する​プロパティ
    メモ

    あるフィールドを​必須​として指定した場合、左側のウィンドウに表示される​ラベル​にアスタリスク(*)が付きます。

  4. フィールドを追加するには

    • 必要なデータ型をフィールドの目的の場所にドラッグします。

    • フィールドがモデルに追加されると、その特定のデータタイプに対して定義できる​プロパティ​が右側のパネルに表示されます。ここで、そのフィールドに必要な項目を定義することができます。多くのプロパティは説明がなく、詳しくはプロパティを参照してください。

  5. フィールドを削除するには

    必要なフィールドを選択し、ごみ箱アイコンをクリックまたはタップします。この操作の確認が求められます。

  6. す追加べての必須フィールドを選択し、必要に応じて関連するプロパティを定義します。

  7. 保存」を選択して、定義を保持します。

データタイプ

モデルの定義には、次のデータタイプを選択できます。

  • 1 行のテキスト
    • 追加1行のテキストの1つ以上のフィールド最大長は定義できます
  • 複数行テキスト
    • リッチテキスト、プレーンテキストまたはマークダウンのテキスト領域
  • 番号
    • 数追加値フィールド
  • Boolean
    • 追加ブール型チェックボックス
  • 日時
    • 日追加時
  • 列挙
    • チェック追加ボックス、ラジオボタン、ドロップダウンフィールドのセット
  • タグ
    • フラグメント作成者がタグの領域にアクセスして選択できるようにします。
  • コンテンツ参照

プロパティ

多くのプロパティは説明がなく、プロパティによっては次に示す追加の詳細情報があります。

  • Render
    Asフラグメント内のフィールドを実現/レンダリングするための様々なオプション。これにより、作成者に対して、フィールドの1つのインスタンスを表示するか、複数のインスタンスを作成するかを定義できます。

  • フィールド
    ラベル入力
    フィールド ラベルは プロパティ名を自動生成します。プロパティ名は必要に応じて手動で更新できます。

  • ValidationBasic検証は、
    ​Requiredプロパティなどのメカニズムで使用できます。一部のデータ型には、追加の検証フィールドがあります。 詳しくは、検証を参照してください。

  • データタイプが​複数行テキスト​の場合、「デフォルトの種類」を次のいずれかとして定義できます。

    • リッチテキスト
    • Markdown
    • プレーンテキスト

    指定しなかった場合は、デフォルト値の​リッチテキスト​がこのフィールドで使用されます。

    コンテンツフラグメントモデルで「デフォルトの種類」を変更した場合、その影響が既存の関連コンテンツフラグメントに及ぶのは、そのフラグメントがエディターで開かれて保存された後です。

検証

様々なデータ型に、結果のフラグメントにコンテンツが入力される際の検証要件を定義できるようになりました。

  • 1 行のテキスト
    • 事前定義された正規表現と比較します。
  • 番号
    • 特定の値を確認します。

コンテンツフラグメントモデルの有効化または無効化

コンテンツフラグメントモデルの使用を完全に制御するには、ステータスを設定できます。

コンテンツフラグメントモデルの有効化

モデルを作成したら、次の操作を行うために有効にする必要があります。

  • は、新しいコンテンツフラグメントの作成時に選択できます。
  • コンテンツフラグメントモデル内から参照できます。
  • GraphQLで使用可能スキーマが生成されます。

次のいずれかとしてフラグ付けされたモデルを有効にするには:

  • ドラフト :mew(無効)
  • 無効 :は特に無効になっています。

​を有効にする」オプションは、次のいずれかから使用します。

  • 上部のツールバー(必要なモデルが選択されている場合)。
  • 対応するクイックアクション(必要なモデルにマウスを移動)。

ドラフトまたは無効なモデルの有効化

コンテンツフラグメントモデルの無効化

モデルを無効にして、次の操作を行うこともできます。

  • このモデルは、新しい​コンテンツフラグメントを作成する際の基盤としては使用できなくなりました。
  • However:
    • GraphQLスキーマは生成され続け、クエリーも可能です(JSON APIへの影響を回避するため)。
    • モデルに基づくコンテンツフラグメントは、引き続きGraphQLエンドポイントからクエリーおよび返すことができます。
  • モデルは参照できなくなりますが、既存の参照は変更されず、引き続きGraphQLエンドポイントからクエリーおよび戻すことができます。

有効」としてフラグ付けされたモデルを無効にするには、次のいずれかの​無効​オプションを使用します。

  • 上部のツールバー(必要なモデルが選択されている場合)。
  • 対応するクイックアクション(必要なモデルにマウスを移動)。

有効なモデルの無効化

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

注意

コンテンツフラグメントモデルを削除すると、依存するフラグメントが影響を受ける可能性があります。

コンテンツフラグメントモデルを削除するには:

  1. ツールアセット​に移動し、コンテンツフラグメントモデル​を開きます。

  2. コンテンツフラグメントモデルが含まれているフォルダーに移動します。

  3. モデルを選択し、次にツールバーの「削除」を選択します。

    メモ

    モデルが参照されている場合は、警告が表示されます。適切に対処します。

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

コンテンツフラグメントモデルは、依存するコンテンツフラグメントの公開時または公開前に公開する必要があります。

コンテンツフラグメントモデルを公開するには:

  1. ツールアセット​に移動し、コンテンツフラグメントモデル​を開きます。

  2. コンテンツフラグメントモデルが含まれているフォルダーに移動します。

  3. モデルを選択し、次にツールバーの「公開」を選択します。発行済みのステータスがコンソールに示されます。

    メモ

    まだ公開されていないモデルのコンテンツフラグメントを公開すると、選択リストにそのことが示され、モデルがフラグメントと共に公開されます。

コンテンツフラグメントモデルの非公開

コンテンツフラグメントモデルがフラグメントによって参照されていない場合は、そのモデルを非公開にできます。

コンテンツフラグメントモデルを非公開にするには:

  1. ツールアセット​に移動し、コンテンツフラグメントモデル​を開きます。

  2. コンテンツフラグメントモデルが含まれているフォルダーに移動します。

  3. モデルを選択し、次にツールバーから​非公開​を選択します。
    発行済みのステータスがコンソールに示されます。

このページ