メタデータリファレンス

プロパティは、オントロジー内で次のメタデータによって表されます。

• ID： プロパティの一意の識別子で、主にアプリケーションの設定時にプロパティを参照するために使用されます。たとえば、開始日プロパティの ID は start-date になります。
• 表示名： ユーザーアプリケーションでこのプロパティの値にアクセスするすべてのユーザーに表示される名前です。たとえば、開始日プロパティの表示名は「開始日」になります。
• 説明： ユーザーアプリケーションで誰でも読むことができる、プロパティについての説明です。たとえば、開始日プロパティの説明は「従業員が新入社員研修を開始した日」になります。
• RID： Foundry のすべてのリソースに対して自動生成される一意の識別子です。プロパティの RID は、プラットフォーム全体のエラーメッセージで参照されます。
• ステータス： プロパティが開発プロセスのどの段階にあるかを、ユーザーやほかのオントロジー構築者に示します。アクティブ、試験的、非推奨のいずれかになります。デフォルトでは、開始日プロパティのステータスは試験的になります。ステータスについて詳しくはこちら。
• API名： コード内でプログラムからプロパティを参照するときに使用する名前です。たとえば、開始日プロパティのAPI名は startDate になります。API名 (TSv1)について詳しくはこちら。
• キー： プロパティがオブジェクトタイプのタイトルキーまたは主キーであるかどうかを示します。
  • タイトルキーは、このタイプのオブジェクトの表示名として機能するプロパティです。たとえば、従業員オブジェクトタイプのタイトルキーとして氏名プロパティを設定すると、架空の従業員「Melissa Chang」や「Diego Rodriguez」などのプロパティ値が、それぞれの従業員オブジェクトの表示名として使用されます。
  • プライマリーキーは、オブジェクトタイプの各インスタンスの一意の識別子として機能するプロパティです。つまり、元データソースの各行で、このプロパティの値が異なる必要があります。たとえば、従業員番号プロパティの値を使用して、「Melissa Chang」を組織内の一意の従業員として識別できます。
• ベースタイプ： このプロパティの値のデータ型を示し、ユーザーアプリケーションで利用可能な操作を決定します。たとえば、開始日プロパティのベースタイプは date になります。ユーザーアプリケーションでは、このプロパティを使用してタイムラインウィジェットを設定できます。
• 値の書式設定： プロパティのベースタイプに応じて、数値、日付と時刻、ユーザーID、リソースIDの書式設定をプロパティに適用し、生の値をユーザーアプリケーションでより読みやすい形式に変換できます。値の書式設定について詳しくはこちら。
• 条件付き書式設定： ユーザー向けアプリケーションでプロパティ値をどのように表示するか（色分け、配置など）を定める、プロパティに設定されたルールです。たとえば、ユーザーアプリケーションで新入社員であることを示すために、開始日プロパティの値が2週間前より後の日付の場合に、氏名プロパティの値を緑色にするルールを設定できます。条件付き書式設定について詳しくはこちら。
• タイプクラス： ユーザーアプリケーションによって解釈される追加のメタデータです。タイプクラスについて詳しくはこちら。
• レンダリングヒント： 同じベースタイプのほとんどのプロパティとは異なる方法でプロパティを表示するよう、ユーザーアプリケーションに指示するものです。多くのレンダリングヒントは、プロパティが定義されているオブジェクトタイプの再インデックスのパフォーマンスに影響を与えるために使用できます。たとえば、ユーザーアプリケーションで開始日プロパティを検索や並べ替えに使用するユーザーがいないと想定される場合は、[検索可能] と [並べ替え可能] のレンダリングヒントの選択を解除して、従業員オブジェクトタイプの再インデックスのパフォーマンスを向上させることができます。レンダリングヒントについて詳しくはこちら。
• 重要性： プロパティをどの程度目立たせて表示するかをユーザーアプリケーションに示します。強調に設定されたプロパティは、アプリケーションでユーザーに最初に表示されます。非表示に設定されたプロパティは、ユーザーアプリケーションに表示されません。デフォルトでは、開始日プロパティの重要性は通常になります。

オントロジーでのプロパティの作成と設定、およびプロパティメタデータの検証要件について詳しくはこちら。

サポートが限定的なプロパティのベースタイプ

一部のプロパティのベースタイプは、サポートが限定的です。これらのタイプには、プロパティのベースタイプピッカーに表示される「限定的なサポート」タグが付いています。

• byte:
  • このデータ型のプロパティは、アクションタイプ内では使用できません。
• float:
  • このデータ型のプロパティは、アクションタイプ内では使用できません。
• short:
  • このデータ型のプロパティは、アクションタイプ内では使用できません。
• vector:
  • ベクトルは、KNN (TSv1) でのみクエリできます。
  • ベクトルの最大次元数は2048です。

アクションタイプにおけるプロパティのベースタイプの制限については、サポートされているプロパティタイプに関するドキュメントを参照してください。