スキーマの作成と命名

スキーマの作成を開始するには、スキーマ ワークスペースの右上隅にある スキーマを作成 を選択します。

スキーマ ワークスペース 参照 タブ スキーマを作成 がハイライト表示されています。

​ スキーマを作成 ​ ダイアログが表示されます。 このダイアログでは、フィールドとフィールドグループを追加して手動でスキーマを作成するか、CSV ファイルをアップロードして ML アルゴリズムを使用してスキーマを生成するかを選択できます。 ダイアログからスキーマ作成ワークフローを選択します。

ワークフローオプションと「選択」がハイライト表示されたスキーマを作成ダイアログ

Beta 手動または ML で支援されたスキーマの作成

ML アルゴリズムを使用して、アップロードされたファイルに基づいてスキーマ構造をレコメンデーションする方法については、 機械学習を利用したスキーマ作成ガイドを参照してください。 この UI ガイドは、手動作成ワークフローを中心としています。

基本クラスを選択

​ スキーマを作成 ​ ワークフローが表示されます。 次に、スキーマの基本クラスを選択します。 XDM 個人プロファイル ​ のコアクラスと XDM ExperienceEvent の間で、または ​ その他 ​ のクラスが目的に合わない場合は、これらのクラスを選択できます。 ​ その他 ​ クラスオプションを使用すると、 新しいクラスを作成するか、他の既存のクラスから選択できます。

これらのクラスについて詳しくは、XDM 個人プロファイル ​ および XDM ExperienceEvent のドキュメントを参照してください。 このチュートリアルでは、「XDM 個人プロファイル」に続いて「次へ」を選択します。

XDM 個人プロファイル オプションと 次へ がハイライト表示された スキーマを作成 ワークフロー

名前とレビュー

クラスを選択すると、「名前とレビュー ​ セクションが表示され ​ す。 このセクションでは、スキーマを識別するための名前と説明を指定します。 スキーマの名前を決定する際に考慮すべき重要な点がいくつかあります。

  • 後でスキーマを簡単に見つけられるように、スキーマ名は短くわかりやすい名前にしてください。
  • スキーマ名は一意である必要があります。つまり、将来再利用されないように十分に具体的でなければなりません。例えば、組織が異なるブランドに対して別々のロイヤルティプログラムを持つ場合、後で定義する他のロイヤルティ関連スキーマと区別しやすいように、スキーマに「ブランド A ロイヤルティメンバー」という名前を付けると効果的です。
  • また、スキーマの説明を使用して、スキーマに関する追加のコンテキスト情報を提供することもできます。

このチュートリアルでは、ロイヤルティプログラムのメンバーに関連するデータを取り込むスキーマを作成するので、スキーマの名前は「Loyalty Members」とします。

​キャンバスにスキーマの基本構造(クラスによって提供される)が表示され、選択したクラスとスキーマ構造を確認できます。

テキストフィールドに、人間にとってわかりやすい ​ スキーマ表示名 ​ を入力します。 次に、スキーマの識別に役立つ適切な説明を入力します。 スキーマ構造をレビューし、設定に満足したら、「完了」を選択してスキーマを作成します。

スキーマ表示名 、 説明 、および 完了 がハイライト表示された スキーマを作成 ワークフローの 名前とレビュー セクション

スキーマの作成

Schema Editor が表示されます。これは、スキーマを作成するキャンバスです。エディターを開くと、選択した基本クラスに含まれている標準フィールドと共に、自己名のスキーマがキャンバスの 構造 セクションに自動的に作成されます。 スキーマに割り当てられたクラスは、「構成」セクションの「クラス」にもリストされています。

NOTE
スキーマの表示名と説明(オプション)は、サイドバーの スキーマプロパティ から更新できます。 新しい名前を入力すると、キャンバスが自動的に更新され、スキーマの新しい名前が反映されます。

基本クラスとスキーマ図がハイライト表示されたスキーマエディター。

NOTE
スキーマが保存される前の初期構成プロセスにおける任意の時点でスキーマのクラスを変更できますが、その場合は細心の注意を払って行ってください。フィールドグループは特定のクラスにのみ適合するので、クラスを変更すると、キャンバスと追加したフィールドがリセットされます。

フィールドグループの追加

これで、フィールドグループを追加して、スキーマへのフィールドの追加を開始できます。フィールドグループは、特定の概念を記述するために一緒に使用されることが多い 1 つ以上のフィールドから成るグループです。このチュートリアルでは、フィールドグループを使用してロイヤルティプログラムのメンバーを記述し、氏名、生年月日、電話番号、住所などの重要な情報を取り込みます。

フィールドグループを追加するには、「フィールドグループ」サブセクションで「追加」を選択します。

「フィールドグループを追加」ボタンがハイライト表示されたスキーマエディター。

新しいダイアログが表示され、使用可能なフィールドグループのリストが表示されます。各フィールドグループは特定のクラスでのみ使用できるものなので、ダイアログには、選択したクラス(この場合は、XDM Individual Profile クラス)に適合するフィールドグループのみがリストされます。標準の XDM クラスを使用している場合、フィールドグループのリストは使用頻度に基づいてインテリジェントに並べ替えられます。

フィールドグループを追加 ダイアログ

左側のパネルでフィルターの 1 つを選択して、標準フィールドグループのリストを特定の業種(小売、金融機関、ヘルスケアなど)に絞り込むことができます。

業界フィールドグループがハイライト表示された フィールドグループを追加 ダイアログ

リストからフィールドグループを選択すると、右側のパネルに表示されます。必要に応じて複数のフィールドグループを選択し、各グループを右側のレールのリストに追加してから確認することができます。また、現在選択されているフィールドグループの右側にアイコンが表示され、提供されるフィールドの構造をプレビューできます。

選択したフィールドグループのプレビューアイコンがハイライト表示された フィールドグループを追加 ダイアログ

フィールドグループをプレビューする際に、右側のパネルに、フィールドグループのスキーマに関する詳細な説明が表示されます。また、提供されたキャンバスでフィールドグループのフィールド間を移動することもできます。別のフィールドを選択すると、右側のパネルが更新され、該当するフィールドの詳細が表示されます。プレビューが完了したら「戻る」を選択して、フィールドグループ選択ダイアログに戻ります。

デモグラフィックの詳細フィールドグループがプレビューされた プレビューフィールドグループ ダイアログ

このチュートリアルでは、「デモグラフィックの詳細」フィールドグループを選択し、次に「フィールドグループを追加」をクリックします。

[ デモグラフィックの詳細フィールドグループが選択され ] フィールドグループを追加 がハイライト表示された フィールドグループを追加」ダイアログ

スキーマキャンバスが再び表示されます。「フィールドグループ」セクションにはデモグラフィックの詳細がリストされ、「構造」セクションにはフィールドグループによって提供されたフィールドが含まれます。「フィールドグループ」セクションでフィールドグループの名前を選択して、キャンバス内で提供される特定のフィールドをハイライト表示できます。

デモグラフィックの詳細フィールドグループがハイライト表示されたスキーマエディター。

NOTE
スキーマエディター内では、標準(Adobeが生成した)クラスおよびフィールドグループは、南京錠アイコン( A 南京錠アイコン)で示されます。 。南京錠は、クラスまたはフィールドグループ名の横の左側のパネルに表示されるほか、システム生成リソースの一部であるスキーマ図のフィールドの横にも表示されます。
南京錠アイコンがハイライトされたスキーマエディター

このフィールドグループでは、データタイプが「ユーザー」の最上位の名前 person の下にいくつかのフィールドが提供されます。このフィールドグループは、名前、生年月日、性別など、個人に関する情報を説明します。

NOTE
フィールドでは、スカラータイプ(文字列、整数、配列、日付など)のほかに、Schema Registry 内で定義されている任意のデータタイプ(一般的な概念を表すフィールドのグループ)も使用できることを覚えておいてください。

name フィールドのデータタイプは「フルネーム」であることに注意してください。これは一般的な概念を表しており、名、姓、敬称、接尾辞など、名前に関連するサブフィールドを含みます。

キャンバス内の様々なフィールドをクリックすると、それらがスキーマ構造に寄与する追加のフィールドが表示されます。

さらなるフィールドグループの追加

これで、同じ手順を繰り返して、別のフィールドグループを追加できるようになりました。この段階で​ フィールドグループを追加 ​ダイアログを表示しても、「デモグラフィックの詳細」フィールドグループがグレー表示されており、その横のチェックボックスを選択できないことに注意してください。これにより、現在のスキーマに既に含まれているフィールドグループが誤って複製されるのを防止できます。

このチュートリアルでは、標準フィールドグループである​ 個人の連絡先の詳細 ​と​ ロイヤルティの詳細 ​をリストから選択したあと、「フィールドグループを追加」を選択してこれらのフィールドグループをスキーマに追加します。

![2 つの新しいフィールドグループが選択され、​ フィールドグループを追加 ​ がハイライト表示された ] フィールドグループを追加 ​ ダイアログ ​

キャンバスが再び表示され、追加したフィールドグループが「構成」セクションの「フィールドグループ」にリストされます。また、スキーマ構造に追加されたそれらの複合フィールドも表示されます。

新しい複合スキーマ構造がハイライト表示されたスキーマエディター。

カスタムフィールドグループの定義

ロイヤルティメンバースキーマは、ロイヤルティプログラムのメンバーに関連するデータを取り込むためのもので、スキーマに追加した標準のロイヤルティの詳細フィールドグループは、プログラムタイプ、ポイント、加入日など、これらのほとんどを提供します。

ただし、場合によっては、ユースケースを達成するために、標準フィールドグループでカバーされない追加のカスタムフィールドを含める必要がある状況も考えられます。 カスタムロイヤルティフィールドを追加する場合は、次の 2 つの選択肢があります。

  1. 新しいカスタムフィールドグループを作成して、これらのフィールドを取り込みます。 この方法については、このチュートリアルで説明します。
  2. 標準のロイヤルティの詳細フィールドグループを拡張して、カスタムフィールドを追加します。 この場合、ロイヤルティの詳細はカスタムフィールドグループに変換され、元の標準フィールドグループは使用できなくなります。 標準フィールドグループの構造にカスタムフィールドを追加する方法について詳しくは、スキーマ UI ガイドを参照してください。

新しいフィールドグループを作成するには、前と同様に「フィールドグループ」サブセクションの「追加」を選択しますが、今回は、表示されるダイアログの上部付近の「新しいフィールドグループを作成」を選択します。次に、新しいフィールドグループの表示名と説明を入力するように求められます。 このチュートリアルでは、新しいフィールドグループに「Custom Loyalty Details」という名前を付けたうえで、「フィールドグループを追加」を選択します。

新しいフィールドグループを作成 、 表示名 および 説明 がハイライト表示された フィールドグループを追加 ダイアログ

NOTE
クラス名の場合と同様に、フィールドグループ名は簡潔かつシンプルで、フィールドグループがスキーマにどのように寄与するかがよくわかるものにしてください。これらも一意なので、名前を再利用できません。名前が十分に具体的なものになるようにしてください。

これで、キャンバスの左側にある「フィールドグループ」に「Custom Loyalty Details」が表示されますが、まだフィールドは関連付けられていないので、「構造」には新しいフィールドは表示されません。

フィールドグループにフィールドを追加します。

これで「Custom Loyalty Details」フィールドグループを作成したので、このフィールドグループがスキーマに提供するフィールドをようやく定義できます。

まず、キャンバスでスキーマ名の横にある​ プラス(+) ​アイコンを選択します。

プラスアイコンがハイライト表示されたスキーマエディター。

「名称未設定フィールド」プレースホルダーがキャンバスに表示されます。また、右側のパネルが更新されて、このフィールドの設定オプションが表示されます。

名称未設定フィールド とスキーマ フィールドプロパティ がハイライト表示されたスキーマエディター

このシナリオでは、スキーマには、人物の現在のロイヤルティ層の詳細を記述するオブジェクトタイプのフィールドが必要です。 右側のパネルのコントロールを使用して、関連フィールドを保持するのに使用される「オブジェクト」タイプの loyaltyTier フィールドの作成を開始します。

割り当て先」で、フィールドの割り当て先となるフィールドグループを選択する必要があります。 すべてのスキーマフィールドはクラスかフィールドグループのどちらかに属していますが、このスキーマは標準クラスを使用しているので、フィールドグループの選択のみ可能です。 「Custom Loyalty Details」という名前を入力し始めると、該当するフィールドグループがリストに表示されるので、それを選択します。

完了したら、「適用」を選択します。

スキーマに追加されたロイヤルティ層オブジェクトを含むスキーマエディター フィールドプロパティ がハイライト表示されている様子

変更内容が適用され、新しく作成された loyaltyTier オブジェクトが表示されます。これはカスタムフィールドなので、組織のテナント ID を名前空間とするオブジェクト内に自動的にネストされ、先頭にアンダースコアが付きます(この例では _tenantId)。

スキーマ図でハイライト表示されたテナント ID とロイヤルティ層を含むスキーマエディター。

NOTE
テナント ID オブジェクトの存在は、追加しようとしているフィールドが組織の名前空間に含まれていることを示しています。
つまり、追加しようとしているフィールドは組織に固有のもので、組織のみがアクセスできる特定の領域にある Schema Registry に保存されることになります。他の標準クラス、フィールドグループ、データタイプおよびフィールドの名前との競合を防ぐために、定義するフィールドは、必ずテナント名前空間に追加する必要があります。

loyaltyTier オブジェクトの横にある​ プラス(+) ​アイコンを選択して、サブフィールドの追加を開始します。新規フィールドプレースホルダーが表示され、「フィールドプロパティ」セクションがキャンバスの右側に表示されます。

テナント ID と新しいサブフィールドがスキーマ図のロイヤルティ層に追加されたスキーマエディター。

各フィールドには、次の情報が必要です。

  • フィールド名: ​フィールドの名前(なるべくキャメルケースで記述)。スペース文字は使用できません。 これは、コード内および他のダウンストリームアプリケーションでフィールドを参照するために使用される名前です。
    • 例:loyaltyLevel
  • 表示名: ​単語の先頭のみ大文字で書かれたフィールド名。これは、スキーマの表示または編集時にキャンバスに表示される名前です。
    • 例:Loyalty Level
  • 型: ​フィールドのデータタイプ。これには、基本的なスカラータイプと、Schema Registry に定義されている任意のデータタイプが含まれます。例:文字列、整数、ブーリアン、人物、住所、電話番号など
  • 説明: ​フィールドの説明(オプション)は、200 文字以内で指定してください。

loyaltyTier オブジェクトの最初のフィールドは、id という文字列になります。これは、ロイヤルティメンバーの現在の階層の ID を表します。 この会社では、様々な要因に基づいて顧客ごとに異なるロイヤルティ層ポイントしきい値を設定しているので、階層 ID はロイヤルティメンバーごとに一意になります。 新しいフィールドのタイプを「​ 文字列 ​」に設定すると、デフォルト値、形式、最大長など、制約を適用するためのオプションが フィールドプロパティ セクションに自動的に入力されます。 詳しくは、 データ検証フィールドのベストプラクティスに関するドキュメントを参照してください。

新しい ID フィールドのフィールドプロパティ値がハイライト表示されたスキーマエディター。

id はランダムに生成されるフリーフォーム文字列なので、それ以上の制約は必要ありません。「適用」を選択して変更を適用します。

ID フィールドが追加されハイライト表示されたスキーマエディター。