UIでのXDM フィールドの定義
Adobe Experience Platform ユーザーインターフェイスのSchema Editorを使用すると、カスタム Experience Data Model （XDM） クラスとスキーマフィールドグループ内で独自のフィールドを定義できます。 このガイドでは、各フィールドタイプで使用可能な設定オプションを含め、UIでXDM フィールドを定義する手順について説明します。
前提条件
このガイドでは、XDM システムに関する実用的な理解が必要です。 Experience Platform エコシステム内でのXDMの役割の概要については、XDMの概要を参照し、XDM スキーマにフィールドを提供するクラスとフィールドグループの方法については、 スキーマ構成の基本を参照してください。
このガイドでは必須ではありませんが、UIでのスキーマの作成に関するチュートリアルに従って、Schema Editorの様々な機能に慣れることもお勧めします。
フィールドを追加するリソースを選択 select-resource
UIで新しいXDM フィールドを定義するには、まずSchema Editor内のスキーマを開く必要があります。 現在Schema Libraryで利用できるスキーマに応じて、新しいスキーマを作成するか、既存のスキーマを選択して編集することができます。
Schema Editorを開くと、フィールドを追加するためのコントロールがキャンバスに表示されます。 これらのコントロールは、スキーマの名前の横に表示されます。また、選択したクラスまたはフィールドグループの下で定義されているオブジェクトタイプフィールドも表示されます。
リソースに新しいフィールドを追加するには、キャンバス内のスキーマ名の横にあるプラス（+） アイコン、または下のフィールドを定義するオブジェクトタイプフィールドの横にあるアイコンを選択します。
スキーマまたはその構成クラスとフィールドグループにフィールドを直接追加するかどうかに応じて、フィールドを追加するために必要な手順は異なります。 このドキュメントの残りの部分では、スキーマ内のフィールドの表示場所に関係なく、フィールドのプロパティを設定する方法に焦点を当てます。 スキーマにフィールドを追加するさまざまな方法について詳しくは、スキーマ UI ガイドの次の節を参照してください。
フィールドのプロパティの定義 define
プラス （+） アイコンを選択すると、キャンバスにUntitled field プレースホルダーが表示されます。
Field propertiesの下の右側のパネルで、新しいフィールドの詳細を設定できます。 各フィールドには次の情報が必要です。
フィールドの一意のわかりやすい名前。 スキーマを保存した後は、フィールドの名前は変更できません。 この値は、コードやその他のダウンストリームアプリケーションでフィールドを識別および参照するために使用されます
名前は理想的にはcamelCaseで記述する必要があります。 英数字またはアンダースコアが含まれている場合がありますが、はアンダースコアで始まらない場合があります。
- 正解:
fieldName - 許容：
field_name2、fieldName_3 - 正しくない:
_fieldName
タイプ固有のフィールド プロパティ について詳しくは、「フィールドの定義」の概要を参照してください。
また、各フィールドの説明とメモを入力することもできます。 Description フィールドを使用してコンテキストを追加し、マップデータタイプの機能を説明します。 これは、実装の保守性と読みやすさに貢献します。 また、最初の説明を補足するためにメモを追加することもできます。 これにより、開発者がコードベースのコンテキストでマップを効果的に理解、維持、利用するのに役立つ、より詳細で具体的な情報を提供する必要があります。 |
フィールドの設定が完了したら、Applyを選択します。
キャンバスが更新され、一意のテナント IDに名前空間が設定されたオブジェクト内に新しく追加されたフィールドが表示されます（以下の例では_tenantIdと表示されます）。 スキーマに追加されたすべてのカスタムフィールドは、Adobeが提供するクラスやフィールドグループから他のフィールドと競合するのを防ぐために、自動的にこの名前空間内に配置されます。 右側のパネルには、フィールドのパスとその他のプロパティが一覧表示されるようになりました。
上記の手順に引き続き従って、スキーマにさらにフィールドを追加できます。 スキーマが保存されると、そのベースクラスとフィールドグループも、変更が加えられた場合に保存されます。
タイプに固有のフィールドプロパティ type-specific-properties
新しいフィールドを定義する場合、フィールドに対して選択した Type に応じて、右側のパネルに追加の設定オプションが表示される場合があります。 次の表に、これらの追加のフィールドプロパティと互換性のあるタイプの概要を示します。
Pattern、Format、長さや数値の境界などのプロパティは、設定時に取り込み中に適用されます。 Default valueは異なります。情報スキーマのメタデータを記録し、取り込んだデータを検証または入力しません。 以下の Default value 行と、表の後に続くメモを参照してください。
注意：APIを通じて作成されたマップ データ型のうち、文字列または整数型のいずれでもないデータ型は、‘Complex’データ型として表示されます。 UIを使用して’Complex’ データ型を作成することはできません。
値が準拠する必要がある文字列の事前定義済み書式のリストから選択します。 使用可能な形式は次のとおりです。
defaultをサポートするスキーマエディターのスカラー型（StringやBooleanなど）default セマンティクスと整合し、スキーマ定義に格納されます。 設定された値は、取り込み中またはデータ準備フロー中に自動的に適用されません。 データフローで明示的にマッピングまたは変換されない限り、省略されたフィールドは存在しません。 必須フィールドの定義を参照してください。特殊フィールドタイプ special
右側のパネルには、選択したフィールドに特別な役割を指定するためのチェックボックスがいくつか用意されています。 これらのオプションのユースケースの中には、データモデリング戦略に関する重要な考慮事項や、ダウンストリームのExperience Platform サービスを使用する方法が含まれます。
これらの特殊なタイプについて詳しくは、次のドキュメントを参照してください。
技術的には特別なフィールドタイプではありませんが、 オブジェクト型フィールドの定義に関するガイドにアクセスして、スキーマ構造の場合のネストされたサブフィールドの定義について詳しく学ぶことをお勧めします。
次の手順
このガイドでは、UIでXDM フィールドを定義する方法の概要を説明しました。 フィールドは、クラスとフィールドグループを使用してスキーマにのみ追加できます。 UIでこれらのリソースを管理する方法について詳しくは、 クラス および フィールドグループ の作成と編集に関するガイドを参照してください。
Schemas ワークスペースの機能について詳しくは、Schemas ワークスペースの概要を参照してください。