UIでのスキーマリソースの確認
Adobe Experience Platformでは、すべてのExperience Data Model (XDM) スキーマリソースがSchema Libraryに保存されます。これには、Adobeが提供する標準リソースと、組織で定義されたカスタムリソースが含まれます。 Experience Platform UIでは、Schema Library内の既存のスキーマ、クラス、フィールドグループ、またはデータタイプの構造とフィールドを表示できます。 UIは、これらのXDM リソースによって提供される各フィールドの想定されるデータタイプとユースケースに関する情報を提供するため、データ取り込みの計画と準備を行う際に特に役立ちます。
このチュートリアルでは、Experience Platform UIで既存のスキーマ、クラス、フィールドグループ、データタイプを調べる手順について説明します。
スキーマリソースの検索 lookup
Experience Platform UIで、左側のナビゲーションで「Schemas」を選択します。 Schemas ワークスペースには、組織内のすべてのスキーマを探索するためのBrowse タブと、それぞれClasses、Field groups、Data typesおよび Relationships を探索するための追加の専用タブが用意されています。
フィルターアイコン(
Schemas ワークスペースの「Browse」タブで、スキーマインベントリをフィルタリングできます。 Included in Profile トグルを使用すると、 リアルタイム顧客プロファイル で使用が有効になっているスキーマのみを表示できます。 Show adhoc schemas トグルを使用して、1つのデータセットでのみ使用できるように名前空間が設定されたフィールドで作成されたスキーマのリストをフィルタリングします。
Schemas ワークスペースの「Relationship」タブで、4つの条件に基づいて関係のリストをフィルタリングできます。 フィルターには、Source schema、Destination schema、Source classおよびDestination classが含まれます。 次の表に、フィルターの説明を示します。
検索バーを使用して、結果をさらに絞り込むこともできます。
検索結果に表示されるリソースは、最初にタイトルの一致、次に説明の一致で順序付けされます。 次に、これらのカテゴリのいずれかで一致する単語が多いほど、リソースがリストに表示されます。
探索するリソースが見つかったら、リストから名前を選択して、キャンバスで構造を表示します。
スキーマ、クラス、フィールドグループ、データタイプの管理:アクションと削除 xdm-resource-actions
XDM リソースを管理または削除する必要がある場合、またはアクション(削除など)が使用できず、その理由を把握する必要がある場合は、この節を使用します。
アクションの検索場所(インラインと詳細ページ) where-to-find-actions
リソースの削除、書き出し、コピーなどのアクションを実行するには、次のいずれかのエントリポイントを使用します。
Browse、Classes、Field groupsおよび Data types のタブでは、管理アクションは2つの場所で使用できます。
- テーブル内のインライン:各リソース行には、使用可能なアクションへの直接アクセスを提供するアクション メニュー(例:…)が含まれています。
- リソース詳細ビュー:詳細ビューで完全なアクションにアクセスするには、カスタム(テナント定義) リソースを選択する必要があります。 標準(Adobeが提供する)リソースのアクションは限られており、削除、JSON構造のコピー、パッケージに追加などのオプションは表示されません。 在庫からカスタムリソースを選択して詳細ビューを開き、ページヘッダーのMore メニューを使用して使用可能なアクションにアクセスします。
これらのアクションは、サポートされているリソースタイプ(スキーマ、クラス、フィールドグループ、データタイプ)の両方のエントリポイントで一貫しています。
使用可能なアクション available-actions
リソースタイプと権限に応じて、次のアクションを使用できます。
- Delete – 組織からカスタムリソースを完全に削除します(制約が許可されている場合)。 削除がブロックされている場合は、制約を参照してください。
- Download sample file — リソース構造に基づいてサンプル データ ファイルを生成します。 手順: サンプル XDM データを生成。
- Copy JSON structure – 再利用、書き出し、または検査のために、リソース定義をJSON形式でコピーします。 手順:XDM スキーマを書き出し。
- Add to package — サンドボックス間で書き出しまたは読み込みを行うために、サンドボックスパッケージにリソースを含めます。 ステップバイステップ: オブジェクトをパッケージに書き出す。
リソースタイプの種類は、次のとおりです。
-
カスタム(テナント定義) スキーマ、クラス、フィールドグループ、データタイプの場合、上記のすべてのアクションを使用できます。
-
標準(Adobe定義)のクラス、フィールドグループ、およびデータタイプの場合:
- Download sample fileのみが利用できます。
- 削除、コピーJSON構造、パッケージに追加は使用できません。
動作を削除 delete-behavior
不要になったカスタムリソースを削除する場合は、Delete アクションを使用します。
リソースを削除するには:
- テーブル内のリソースを見つけるか、その詳細ビューを開きます。
- アクションメニュー(…またはMore)を選択します。
- Delete を選択します。
- もう一度 Delete を選択して、ダイアログのアクションを確認します。
確認後、リソースは組織から完全に削除されます。
リソースに対して削除が使用できない場合、アクションを実行できない理由を説明するツールヒントが表示され、このオプションは無効になります。
制約(データセット、プロファイル、RBAC、テナントとグローバル) delete-constraints
Deleteなどのアクションが使用できない、または無効になっている場合は、通常、次のいずれかの条件が原因です。
-
権限(RBAC):管理アクションを実行するには、必要な権限(Manage Schemasなど)が必要です。 権限がない場合は、ツールヒントでアクションが無効に表示されます。 権限の設定方法については、 アクセス制御UIの概要を参照してください。
-
データセットの関連付け: 1つ以上のデータセット(データセットに関連付けられたスキーマなど)で使用されているリソースを削除できません。 データセットの依存関係を特定して削除するには、 データセットの削除を参照してください。
-
プロファイルの有効化: リアルタイム顧客プロファイルに対して有効になっているスキーマを削除できません。 プロファイルの有効化がスキーマにどのような影響を与えるかについては、 リアルタイム顧客プロファイルの有効化の計画を参照してください。
-
テナントとグローバルリソース:テナント定義(カスタム)リソースは削除できますが(制約が適用されます)、標準(Adobe提供)クラス、フィールドグループ、データタイプは削除できません。
これらの制約は、UIに直接反映されます。 アクションが使用できない場合は、無効と表示され、特定の制限について説明するツールヒントが含まれます。
リソースを削除できない場合は、上記の条件を確認して、権限の更新、依存関係の削除、データモデルの調整が必要かどうかを判断します。
キャンバスでのスキーマ編集ワークフローの詳細については、UIでのスキーマの作成と編集を参照してください。
キャンバスでのXDM リソースの探索 explore
リソースを選択すると、その構造がキャンバスで開きます。
サブプロパティを含むすべてのオブジェクトタイプフィールドは、最初にキャンバスに表示されたときに、デフォルトで折りたたまれます。 任意のフィールドのサブプロパティを表示するには、フィールド名の横にあるアイコンを選択します。
標準クラスおよびフィールドグループインジケーター standard-class-and-field-group-indicator
スキーマエディター内では、標準(Adobeで生成された)クラスとフィールドグループが、南京錠アイコン(
ガイダンスについては、標準フィールドグループにカスタムフィールドを追加のドキュメントを参照してください。 標準クラスは編集できません。
システム生成フィールド system-fields
フィールド名の前にはアンダースコアが付いています(_repoや_idなど)。 これらは、データが取り込まれる際にシステムが自動的に生成して割り当てるフィールドのプレースホルダーを表します。
そのため、Experience Platformに取り込む際には、これらのフィールドのほとんどをデータ構造から除外する必要があります。 このルールの主な例外は_{TENANT_ID} フィールド です。このフィールドは、組織の下で作成されたすべてのXDM フィールドの下に名前空間を設定する必要があります。
データタイプ data-types
キャンバスに表示される各フィールドの対応するデータタイプは、フィールドが取り込む必要のあるデータタイプを一目で示す名前の横に表示されます。
角括弧([])が付いたデータ型は、その特定のデータ型の配列を表します。 例えば、String[]というデータ型は、フィールドに文字列値の配列が必要であることを示します。 Payment Item[]のデータ型は、Payment Item データ型に準拠するオブジェクトの配列を示します。
配列フィールドがオブジェクトタイプに基づいている場合は、キャンバスでそのアイコンを選択して、各配列項目の期待属性を表示できます。
Field properties field-properties
キャンバス内の任意のフィールドの名前を選択すると、右側のパネルが更新され、そのフィールドの詳細が Field properties の下に表示されます。 これには、フィールドの意図されるユースケース、デフォルト値、パターン、形式、フィールドが必要かどうかなどの説明が含まれます。 フィールドグループを探索する場合、選択したフィールドのラベル関連の詳細もここに表示されます。構造図の ラベル を参照してください。
検査中のフィールドが列挙フィールドの場合、右側のパネルには、フィールドが受け取ると想定される許容値も表示されます。
ID フィールド identity
ID フィールドを含むスキーマを検査する場合、これらのフィールドは、スキーマに提供するクラスまたはフィールドグループの下の左側のパネルに一覧表示されます。 左側のパネルでID フィールド名を選択すると、ネストの深さに関係なく、カンバス内のフィールドが表示されます。
ID フィールドは、指紋アイコン (
関係フィールド relationship
関係フィールドを含むスキーマを検査する場合、そのフィールドは Relationships の下の左側のパネルに一覧表示されます。 左側のパネルで関係フィールド名を選択すると、ネストの深さに関係なく、カンバス内のフィールドが表示されます。 関係フィールドは、フィールドがリンクする参照スキーマの名前を示す、キャンバス内で一意にハイライト表示されます。 B2B機能を持つ組織の場合、カスタムの関係名を記述でき、このような場合はキャンバスに表示されます。
参照スキーマのプライマリ IDのID名前空間を表示するには、関係フィールドを選択し、Field properties サイドバーの Edit relationship を選択します。 関係のパラメーターは、表示されるEdit relationship ダイアログに表示されます。
XDM スキーマでの関係の使用について詳しくは、UIでの関係の作成に関するチュートリアルを参照してください。
フィールドグループの探索:使用状況とメタデータ explore-field-groups
Schemas > Field groupsに移動して、フィールドグループを検索します。 Field groups タブでは、追加の機能により、スキーマ全体でフィールドグループが使用されている場所と、互換性、必須フィールド (取り込み要件を適用する)、ガバナンスシグナルなど、フィールドグループに含まれる内容を把握できます。
これらの機能は、変更を加える前に影響を評価し、スキーマの設計中に関連するフィールドグループをより効率的に特定するのに役立ちます。
フィールドグループのスキーマ使用状況の表示 view-schema-usage-for-field-groups
Field groups テーブルから、フィールドグループを選択して、その詳細ビューを開きます。 キャンバスが更新され、フィールドグループ構造が表示され、プロパティパネルには選択したリソースに関する追加情報が表示されます。
このフィールドグループを使用するスキーマ
右側のプロパティパネルのSchemas using this field group セクションには、現在フィールドグループを含むスキーマが一覧表示されます。
- フィールドグループが3つ以下のスキーマで使用されている場合、すべてのスキーマ名が表示されます。
- 3つ以上のスキーマで使用されている場合は、一部の名前のみが表示され、完全なリストを表示するオプションも表示されます。
スキーマ名を選択して、その詳細ビューを新しいタブで開き、そのスキーマ内でのフィールドグループの実装方法を調べます。
スキーマリストの詳細と完全な表示
インラインで表示できる数よりも多くのスキーマが存在する場合は、View moreを選択して完全なダイアログを開きます。
Schemas using this field group ダイアログが表示され、フィールドグループを使用するスキーマの完全なリストが表示されます。
Schemas using this field group ダイアログでは、次の操作を実行できます。
- フィールドグループを使用するすべてのスキーマを参照する
- 大規模な結果セットのページ
- スキーマを選択して、その詳細ビューを新しいタブで開く
スキーマ名、クラス、その他の属性などのスキーマの詳細を表示できます。
このワークフローは、影響分析および探索のみを目的としています。 スキーマやフィールドグループは変更されません。 スキーマ構造を変更するには、UIでのスキーマの作成と編集を参照してください。
フィールドグループのメタデータとフィルタリング field-group-metadata-and-filtering
「Field groups」タブには、フィールドグループを選択する前に見つけて評価するのに役立つメタデータとフィルタリングツールが用意されています。
テーブルとフィルターを参照
フィールドグループのインベントリテーブルには、フィールドグループを適用できるクラスを示す Compatible classes など、リストビューで直接メタデータを公開する追加の列が含まれています。 フィールドグループは、表すデータ(レコードベースまたは時系列データなど)の動作に基づいて、リストされている互換性のあるクラスのいずれかを使用するスキーマにのみ追加できます。 フィールドグループがすべてのクラスと互換性がある場合、テーブルに All が表示される場合があります。 Industry tagsは、発見のためのフィールドグループの分類に役立ちます。
リストを絞り込むには、フィルターアイコン(
フィルターパネルでは、次の操作を実行できます。
- Compatible classes — ドロップダウンを使用して、クラスの互換性によってフィールドグループをフィルタリングします
- Industry tags — チェックボックスを使用して、1つ以上の業界カテゴリでフィルタリングします
参照中に、表の行を選択して情報パネルを更新します。 情報パネルには、互換性のあるクラスや業界タグなどのメタデータが表示されるため、フィールドグループを開かずにキーの詳細を確認できます。
フィールドグループ詳細メタデータ
フィールドグループを開くと、プロパティパネルにリソースに関連する追加のメタデータが表示されます。
プロパティパネルには、次のメタデータを表示できます。
- Compatible classes — フィールドグループが拡張できるクラス
- Required attributes — データ取り込み中にフィールドグループによって要求されたときに有効な値を持つ必要がある属性。 要件はデータ構造によって異なり、必要な値が欠落または無効なレコードは検証に失敗します
- Labels — ラベルはフィールドグループレベルに表示されません。 Field properties パネルでラベルの詳細を表示するフィールドを選択します
この情報は、フィールドグループを使用または変更する前に、制約と要件を理解するのに役立ちます。
構造図のラベル
フィールドグループがカンバスで開いている場合、構造内で直接ラベル情報を表示できます。 設定アイコンを選択します(
キャンバスでフィールドを選択すると、そのフィールドに適用されたラベルを含むラベルの詳細がField properties パネルに表示されます。
ラベルはカテゴリ別(IDや機密ラベルなど)にグループ化され、データに適用されるガバナンスやアクセス関連の制約を可視化します。
これらの指標は可視性のためのものであり、スキーマ構造は変更されません。 詳しくは、 スキーマのデータ使用ラベルの管理を参照してください。
次の手順
このドキュメントでは、Experience Platform UIで既存のXDM リソースを調査する方法について説明しました。 Schemas ワークスペースとSchema Editorのさまざまな機能について詳しくは、Schemas ワークスペースの概要を参照してください。