オブジェクトタイプの作成

新しいオブジェクトタイプを作成および設定する主な方法は、ガイド付きステップバイステップのヘルパーを使用することです。ガイド付きヘルパーが推奨される方法ですが、オブジェクトの作成プロセスを完了する前にヘルパーを終了した場合、新しいオブジェクトタイプのメタデータ、バッキングデータソース、プロパティマッピング、キー（プライマリおよびタイトル）を指定することで、手動でプロセスを完了することもできます。

新しいオブジェクトタイプを作成した後、デフォルトの割り当てからAPI名を変更することができます。

このページには、新しいオブジェクトタイプの作成プロセスに関するトラブルシューティング情報も含まれています。

---

ヘルパーを使用して新しいオブジェクトタイプを作成する

• 新しいオブジェクトタイプを作成し、バッキングデータソースを追加する
• マップされていないすべての列を新しいプロパティとしてマップする
• プライマリキーとタイトルキーを設定する

新しいオブジェクトタイプを作成し、バッキングデータソースを追加する

新しいオブジェクトタイプを作成するには、ホームページのヘッダーから新しいオブジェクトタイプボタンを選択します。

新しいオブジェクトタイプボタンを選択すると、新しいオブジェクトタイプの作成ヘルパー（下の画像参照）が表示され、新しいオブジェクトタイプに関する以下の情報を求めます。

• 表示名： このタイプのオブジェクトにアクセスするユーザーアプリケーションで表示される名前です。
• 複数表示名： このタイプの複数のオブジェクトにアクセスするユーザーアプリケーションで表示される名前です。
• 説明： このタイプのオブジェクトにアクセスするユーザーアプリケーションでの説明文です。たとえば、Object Explorerで検索するユーザーは、検索結果でオブジェクトタイプの説明を表示します。
• ID： オブジェクトタイプの一意の識別子で、主にユーザーアプリケーションを設定する際に、このタイプのオブジェクトを参照するために使用されます。
  • IDには、小文字の英字、数字、ダッシュを含めることができます。
  • IDの最初の文字は、必ず小文字の英字である必要があります。
  • IDが保存されると、IDは変更できません。
  • IDが保存されると、すべてのオブジェクトタイプIDには、そのオントロジーに関連する短い接頭辞が付与されます。この接頭辞はランダムに生成されますが、オントロジーごとに固有です。
• アイコン： オブジェクトタイプのアイコンと色をカスタマイズするために、デフォルトのアイコンを選択します。このアイコンと色は、ユーザーがこのタイプのオブジェクトを表示するときにユーザーアプリケーションに表示されます。
• バッキングデータソース： このタイプのオブジェクトのプロパティ値として使用されるデータのソースです。

Foundryで利用可能なデータソースからバッキングデータソースを選択すると、空のフィールドがバッキングデータソースの名前に基づいて自動的に入力されます。ただし、1つのデータソースは1つのオブジェクトタイプをバックアップするためにのみ使用できます。

---

マップされていないすべての列を新しいプロパティとしてマップする

バッキングデータソースを選択すると、新しいオブジェクトタイプの作成ヘルパーは、バッキングデータソースのすべての列をオブジェクトタイプの新しいプロパティに自動的にマップします。

• プロパティのID、表示名、および基本タイプは、データソースの対応する列から推測されます。
• このオプションはデフォルトで選択されていますが、手動で列を新しいプロパティにマップする場合は、このオプションの選択を解除できます。

プロパティのIDが保存され、ユーザーアプリケーションでプロパティが参照されると、プロパティIDのいかなる変更もアプリケーションを壊します。

---

プライマリキーとタイトルキーを設定する

バッキングデータソースを選択し、マップされていない列を新しいプロパティとしてマップすると、新しいオブジェクトタイプの作成ヘルパーは、オブジェクトタイプのタイトルキーおよびプライマリキーに割り当てる新しいプロパティを選択するようにも求めます。

• タイトルキー： このタイプのオブジェクトの表示名として機能するプロパティです。
  • 例えば、Employeeオブジェクトタイプのタイトルキーとしてfull nameプロパティを選択すると、そのプロパティの値（「Melissa Chang」、「Akriti Patel」、「Diego Rodriguez」など）が、それぞれの仮想Employeeオブジェクトの表示名として使用されます。
• プライマリキー： オブジェクトタイプの各インスタンスに対する一意の識別子として機能するプロパティです。バッキングデータソースの各行は、このプロパティに異なる値を持つ必要があります。
  • 例えば、「Melissa Chang」を組織内の一意の従業員として識別するために、employee IDプロパティの値が使用されます。

これらのフィールドに入力が完了したら、作成を選択します。作成を選択しても変更はステージングされるだけで、保存されません。新しいオブジェクトタイプをオントロジーに保存する方法については、オントロジーに変更を保存する方法の説明に従ってください。

---

手動で新しいオブジェクトタイプを作成する

ヘルパーを使用して新しいオブジェクトタイプを作成する場合、新しいオブジェクトタイプの作成ヘルパーの手順のすべてのステップを完了する前に作成を選択することができます。プロセスが完了する前に作成を選択すると、ヘルパーが終了し、概要ページに移動します。

この時点で、オブジェクトタイプは保存されておらず、以下のすべての手順が完了するまで保存できません。手動で作成プロセスを完了するためのステップ（新しいオブジェクトタイプの作成ヘルパーの外側）は以下のとおりです。

• 新しいオブジェクトタイプのメタデータを追加する
• 新しいオブジェクトタイプにバッキングデータソースを追加する
• 新しいプロパティを追加する
• 単一のプロパティをデータにマップする
• マップされていないすべての列を新しいプロパティとしてマップする
• プライマリキーとタイトルキーを設定する

新しいオブジェクトタイプのメタデータを追加する

概要ページのメタデータセクションでは、オブジェクトタイプの表示名、複数表示名、説明、およびIDを編集できます。

1. 表示名： このタイプのオブジェクトにアクセスするユーザーアプリケーションで表示される名前です。
2. 複数表示名： このタイプの複数のオブジェクトにアクセスするユーザーアプリケーションで表示される名前です。
3. 説明： このタイプのオブジェクトにアクセスするユーザーアプリケーションでの説明文です。たとえば、Object Explorerで検索するユーザーは、検索結果でオブジェクトタイプの説明を表示します。
4. グループ： オブジェクトタイプを分類するための1つ以上のラベル。
5. ID： オブジェクトタイプの一意の識別子で、主にユーザーアプリケーションを設定する際に、このタイプのオブジェクトを参照するために使用されます。
   • IDには、小文字の英字、数字、ダッシュを含めることができます。
   • IDの最初の文字は、必ず小文字の英字である必要があります。
   • プロパティのIDが保存され、ユーザーアプリケーションでプロパティが参照されると、いかなるプロパティIDの変更もアプリケーションを壊します。
6. アイコン： オブジェクトタイプのアイコンと色をカスタマイズするために、オブジェクトタイプビューのサイドバーからデフォルトのアイコンを選択します。このアイコンと色は、ユーザーがこのタイプのオブジェクトを表示するときにユーザーアプリケーションに表示されます。
7. バッキングデータソース： このタイプのオブジェクトのプロパティ値として使用されるデータのソースです。

---

オブジェクトタイプにグループを追加する

グループは、オブジェクトタイプを分類するためのラベルです。オブジェクトタイプのメタデータウィジェットから、以下の操作ができます。

• 既存のグループ一覧からグループを追加する。
• 新しいグループの名前を入力して新しいグループを作成する。
• オブジェクトタイプからグループを削除する。

グループは、オントロジーマネージャの検索バーと検索バーのダイアログで検索できます。オントロジーマネージャのオブジェクトタイプのテーブルは、グループの表示とフィルタリングをサポートしています。グループは、Object Explorerのホームページでも表示されます。

---

新しいオブジェクトタイプにバッキングデータソースを追加する

このタイプのオブジェクトのプロパティ値にデータを使用するために、バッキングデータソースを追加する必要があります。これは、以下の手順で行うことができます。

• 概要ページのプロパティセクションから新規作成を選択するか、オブジェクトタイプビューのサイドバーのプロパティページからプロパティマッピングの編集ボタンを選択して、プロパティエディタに移動します。
• 次に、下の画像に示すようにバッキングデータソースを追加ボタンを選択します。これにより、Foundryの利用可能なデータソースをバッキングデータソースとして選択できます。
  • ただし、1つのデータソースは1つのオブジェクトタイプをバックアップするためにのみ使用できます。

---

新しいプロパティの追加

プロパティエディター内で、画面右側の Properties ペインで Add を選択します。これにより、オブジェクトタイプに新しいプロパティが追加されます。

---

プロパティをデータにマッピングする

プロパティを元データセット内の行にマッピングする方法は以下の通りです。

• 行を新しいプロパティにマッピングする
• 行を既存のプロパティにマッピングする
• プロパティを行にマッピングする

行を新しいプロパティにマッピングする

画面左側のデータソースペインには、データソースのすべての行が表示されています（下の画像参照）。マッピングしたい行にカーソルを合わせ、Add as a new property ボタンを選択して、この行にマッピングされた新しいプロパティを作成します。プロパティ ID、表示名、基本タイプは、行の名前から推測されます。

行を既存のプロパティにマッピングする

画面左側のデータソースペインには、データソースのすべての行が表示されています。マッピングされていない行にカーソルを合わせて、Add as a new property ボタンを選択します。行の名前が一致するプロパティ ID を持つ既存のプロパティがある場合、そのプロパティに行がマッピングされます。

プロパティを行にマッピングする

画面右側のプロパティペインで、行にマッピングしたいプロパティにカーソルを合わせ、Map to a column を選択します。これにより、ドロップダウンが開き、プロパティにマッピングする行を選択できます。

---

すべての未マッピング行を新しいプロパティとしてマッピングする

データソースペインのデータソース名の隣には、Add all unmapped columns as new properties ボタンがあります。このボタンを選択すると、データソース内のすべての未マッピング行に対してプロパティが作成されます。プロパティの ID、表示名、基本タイプは、データソース内の対応する行から推測されます。

• プロパティの ID が保存され、ユーザーアプリケーションで参照されると、プロパティ ID のいかなる変更もアプリケーションの壊れる原因となります。

---

プライマリキーとタイトルキーの設定

新しいオブジェクトタイプを作成し、元データセットを追加し、新しいプロパティにマッピングした後、オブジェクトタイプを保存できるようにするには、プライマリキーとタイトルキーを設定する必要があります。プロパティエディター内のプロパティメタデータペインに移動して、プロパティをプライマリキーおよびタイトルキーとして設定します（下の画像参照）。

• プライマリキー: オブジェクトタイプの各インスタンスに対して固有の識別子として機能するプロパティ。元データセット内の各行は、このプロパティに対して異なる値を持つ必要があります。
  • 例えば、従業員ID プロパティの値は、組織内で「Melissa Chang」をユニークな（概念上の）従業員として識別するために使用されます。
  • プライマリキーを設定するには、プロパティエディターのプロパティペインでプライマリキーに割り当てるプロパティを選択し、Primary key オプションにチェックを入れます。
• タイトルキー: このタイプのオブジェクトの表示名として機能するプロパティ。
  • 例えば、Employee オブジェクトタイプのタイトルキーとして フルネーム プロパティを選択すると、そのプロパティの値（「Melissa Chang」、「Akriti Patel」、「Diego Rodriguez」など）が、それぞれの概念上の Employee オブジェクトの表示名として使用されます。
  • タイトルキーを設定するには、プロパティエディターのプロパティペインでタイトルキーに割り当てるプロパティを選択し、Title key オプションにチェックを入れます。 ここまでの変更はステージングされていますが、まだ保存されていません。新しいオブジェクトタイプをオントロジーに保存する方法については、オントロジーへの変更の保存方法を参照してください。

---

API名の設定

API名は、オブジェクトタイプやプロパティをコード内でプログラム的に参照する際に使用する名前です。すべての新しいオブジェクトタイプとプロパティは、表示名から推測されるAPI名が自動的に割り当てられます。API名についての詳細はこちら。

自動的に割り当てられたAPI名を以下のように変更できます。

• オブジェクトタイプのAPI名は、オブジェクトタイプの Overview ページで編集できます。
• プロパティのAPI名は、プロパティエディターのプロパティペインで編集できます。

命名のガイドライン

オブジェクトタイプのAPI名は、関数型コーディング規格に従います。オブジェクトタイプのAPI名は以下の条件を満たす必要があります。

• 大文字で始まり、英数字のみで構成される。
• PascalCase（各単語の最初の文字が大文字である、例：「ThisExampleName」）で記述される。
• すべてのオブジェクトタイプで一意である。

プロパティのAPI名は以下の条件を満たす必要があります。

• 小文字で始まり、英数字のみで構成される。
• camelCase（最初の単語以降の各単語の最初の文字が大文字である、例：「thisExampleName」）で記述される。
• 同じオブジェクトタイプに属するすべてのプロパティで一意である。

---

トラブルシューティング

オブジェクトタイプの必須フィールド

新しいオブジェクトタイプを保存するためには、以下のオブジェクトタイプのフィールドが空でない必要があります。

• ID
• 表示名
• 複数形の表示名
• 元データセット
• API名

また、保存するためには以下のプロパティフィールドが空でない必要があります。

• プロパティID
• プロパティ表示名
• 元行
• プロパティAPI名
• タイトルキー
• プライマリキー

---

有効なIDのチェックリスト

オブジェクトタイプID

オブジェクトタイプIDは：

• 小文字、数字、ダッシュで構成できます。
• 文字で始めるべきです。
• すべてのオブジェクトタイプで一意である必要があります。

プロパティタイプID

プロパティタイプIDは：

• 大文字または小文字、数字、ダッシュ、アンダースコアで構成できます。
• 文字で始めるべきです。
• 同じオブジェクトタイプに属するすべてのプロパティで一意である必要があります。

API名

関数型コーディング規格に従って、オブジェクトタイプのAPI名は以下の条件を満たす必要があります。

• 大文字で始まり、英数字のみで構成される。
• PascalCaseで記述される。
• すべてのオブジェクトタイプで一意である。

プロパティのAPI名は以下の条件を満たす必要があります。

• Unicode で有効であること
• 同じオブジェクトタイプに属するすべてのプロパティで一意であること。

API名には使用できない予約語がいくつかあります。それらは、ontology, object, property, link, relation, rid, primaryKey, typeId, ontologyObject です。

エラー

エラー：Phonograph2:DatasetAndBranchAlreadyRegistered

Phonograph2:DatasetAndBranchAlreadyRegistered エラーが表示される場合、保存しようとしているオブジェクトタイプをバックアップするデータソースは、オントロジー内の別のオブジェクトタイプに既にバックアップされており、再度使用することはできません。