UI でのスキーマリソースの調査
Adobe Experience Platformでは、Adobeが提供する標準リソースや組織で定義されるカスタムリソースなど、すべてのエクスペリエンスデータモデル(XDM)スキーマリソースが Schema Library に保存されます。 Experience PlatformUI では、Schema Library ージ内の既存のスキーマ、クラス、フィールドグループ、データタイプの構造とフィールドを確認できます。 UI は、これらの XDM リソースで提供される各フィールドの想定されるデータタイプとユースケースに関する情報を提供するので、データ取り込みを計画および準備する際に特に役立ちます。
このチュートリアルでは、Experience PlatformUI で既存のスキーマ、クラス、フィールドグループおよびデータタイプを調べる手順を説明します。
スキーマリソースの検索 lookup
Platform UI の左側のナビゲーションで「スキーマ」を選択します。 スキーマ ワークスペースには、組織内のすべてのスキーマを調べる 参照 タブと、それぞれ クラス、フィールドグループ、データタイプ、関係 を調べる専用のタブが用意されています。
フィルターアイコン( )をクリックすると、左側のパネルにコントロールが表示され、リストされた結果を絞り込むことができます。 リソースフィルターは、「参照」タブと「関係 タブのスキーマと関係に対して それぞれ使用 き す。
スキーマ ワークスペースの 参照 タブで、スキーマインベントリをフィルタリングできます。 リアルタイム顧客プロファイル で使用するために有効になっているスキーマのみを表示するには、「 プロファイルに含まれる」切替スイッチを使用します。 アドホックスキーマを表示 切替スイッチを使用して、単一のデータセットでのみ使用するために名前空間が設定されたフィールドで作成されたスキーマのリストをフィルタリングします。
スキーマ ワークスペースの 関係 タブでは、4 つの条件に基づいて関係のリストをフィルタリングできます。 フィルターには、Source スキーマ 、 宛先スキーマ 、Source クラス 、および 宛先クラス が含まれます。 次の表にフィルターの説明を示します。
検索バーを使用して、結果をさらに絞り込むこともできます。
検索結果に表示されるリソースは、タイトル一致順、説明一致順に並べ替えられます。 次に、これらのカテゴリのいずれかに一致する単語が多いほど、リストにリソースが高く表示されます。
参照するリソースが見つかったら、その名前をリストから選択して、キャンバスに構造を表示します。
キャンバスでの XDM リソースの参照 explore
リソースを選択すると、その構造がキャンバスで開きます。
サブプロパティを含むすべてのオブジェクトタイプフィールドは、キャンバスに初めて表示されたときに、デフォルトで折りたたまれます。 任意のフィールドのサブプロパティを表示するには、名前の横にあるアイコンを選択します。
標準クラスおよびフィールドグループインジケーター standard-class-and-field-group-indicator
スキーマエディター内では、標準(Adobe生成)のクラスおよびフィールドグループは、南京錠アイコン( 。南京錠は、クラスまたはフィールドグループ名の横の左側のパネルに表示されるほか、システム生成リソースの一部であるスキーマ図のフィールドの横にも表示されます。
詳しくは、 標準フィールドグループへのカスタムフィールドの追加ドキュメントを参照してください。 標準クラスは編集できません。
システム生成フィールド system-fields
フィールド名の前には、_repo
や _id
のようにアンダースコアが付いているものもあります。 これらは、データの取り込み時にシステムが自動的に生成して割り当てるフィールドのプレースホルダーを表します。
したがって、これらのフィールドのほとんどは、Platform に取り込む際にデータの構造から除外する必要があります。 このルールの主な例外は、組織の下で作成されたすべての XDM フィールドの下に名前空間を設定する必要がある _{TENANT_ID}
フィールドです。
データタイプ data-types
キャンバスに表示される各フィールドに対応するデータタイプが名前の横に表示され、フィールドが取り込みに必要なデータのタイプを一目で示します。
角かっこ([]
)が付いたデータ型は、その特定のデータ型の配列を表します。 例えば、String[] というデータタイプは、フィールドが文字列値の配列を想定していることを示します。 Payment Item[] のデータタイプは、Payment Item データタイプに準拠するオブジェクトの配列を示します。
配列フィールドがオブジェクトタイプに基づいている場合、キャンバスでそのアイコンを選択して、各配列項目に期待される属性を表示できます。
フィールドプロパティ field-properties
キャンバスで任意のフィールドの名前を選択すると、右側のパネルが更新され、フィールドプロパティ の下にそのフィールドに関する詳細が表示されます。 これには、フィールドの意図されたユースケースの説明、デフォルト値、パターン、形式、フィールドが必須かどうかなどが含まれます。
検査しているフィールドが列挙フィールドの場合、右側のパネルには、フィールドが受け取ると予想される許容値も表示されます。
ID フィールド identity
ID フィールドを含むスキーマを検査すると、これらのフィールドは、スキーマに提供するクラスまたはフィールドグループの下の左側のパネルに表示されます。 左側のパネルで ID フィールド名を選択すると、ネストの深さに関係なく、キャンバスにフィールドが表示されます。
キャンバス内で ID フィールドが指紋アイコン( )でハイライト表示されます。 ID フィールドの名前を選択すると、ID 名前空間や、フィールドがスキーマのプライマリ ID かどうかなどの追加情報が表示されます。
関係フィールド relationship
関係フィールドを含むスキーマを検査する場合、そのフィールドは 関係 の下の左側のパネルに表示されます。 左側のパネルで関係フィールド名を選択すると、ネストの深さに関係なく、キャンバスにフィールドが表示されます。 関係フィールドもキャンバス内で一意にハイライト表示され、フィールドのリンク先の参照スキーマの名前が表示されます。 B2B 機能を持つ組織の場合、カスタム関係名を書き込むことができ、この場合はキャンバスに表示されます。
参照スキーマのプライマリ ID の ID 名前空間を表示するには、関係フィールドを選択し、フィールドプロパティ サイドバーの 関係を編集 を選択します。 関係のパラメーターは、表示される 関係を編集 ダイアログに表示されます。
XDM スキーマでの関係の使用について詳しくは、UI での関係の作成に関するチュートリアルを参照してください。
次の手順
このドキュメントでは、Experience PlatformUI で既存の XDM リソースを調べる方法について説明しました。 スキーマ ワークスペースおよび Schema Editor の様々な機能について詳しくは、 スキーマ ワークスペースの概要を参照してください。