注: 以下の翻訳の正確性は検証されていません。AIPを利用して英語版の原文から機械的に翻訳されたものです。

派生プロパティ

派生プロパティは、ほかのプロパティやリンクされたオブジェクトからクエリ時に値が計算されるプロパティです。値を保存するのではなく、リンクをたどってリンクされたオブジェクトからプロパティを選択する、多数のリンクされたオブジェクトを集計する、算術演算で値を組み合わせるといった、値の計算方法を定義します。

派生プロパティは保存されるのではなく計算されるため、基になるデータが変化しても正しい値を維持します。たとえば、リンクされた Employee オブジェクトを数える派生プロパティには、入社や退職が自動的に反映され、パイプラインを再実行したり、更新ロジックを保守したりする必要はありません。

派生プロパティは、次の3つの方法のいずれかで値を計算できます。

  • リンクされたオブジェクトを集計する: Department オブジェクトタイプで、リンクされた Employee オブジェクトの平均給与を公開できます。
  • リンクされたオブジェクトから選択する: Employee オブジェクトタイプで、リンクされた単一の Employee オブジェクトから選択した上司の名前を公開できます。
  • 式を計算する: Employee オブジェクトタイプで、salary と bonus を足し合わせて計算した報酬総額を公開できます。

派生プロパティは読み取り専用です。アクションや関数では編集できず、オブジェクトストレージにも保存されません。

オントロジー定義と実行時定義の派生プロパティ

派生プロパティは、オントロジー内または実行時に定義できます。どちらの形式を使用するかによって、設定する場所、ほかに誰が参照できるか、利用可能な機能が決まります。

派生プロパティの2つの形式の比較。オントロジー定義の派生プロパティは Ontology Manager で設定され、Workshop、オントロジー SDK、Insight などのほかのアプリケーションから使用できます。一方、実行時定義の派生プロパティは、それを宣言するワークフロー内でのみ使用できます。

オントロジーで定義実行時に定義
設定場所Ontology ManagerWorkshop モジュール、Insight ワークブック、またはオントロジー SDK リクエスト
格納先オントロジー定義オブジェクトセット定義
公開範囲オブジェクトタイプのすべての利用元定義を宣言するリクエストまたはモジュール、およびその定義を含む保存済みオブジェクトセットにアクセスできるユーザー
リンク走査の最大回数3Workshop、Insight:1、オントロジー SDK:固定の上限なし
式非対応対応
開発状況ベータ版一般提供
ベータ版

オントロジー定義の派生プロパティは、開発のベータ版フェーズにあり、お使いのエンロールメントでは利用できない場合があります。活発に開発が進められている間は、機能が変更される場合があります。実行時定義の派生プロパティは一般提供されています。

計算が組織におけるオブジェクトタイプのモデル化の一部であり、すべての利用側で参照できる必要がある場合は、オントロジー定義の派生プロパティを使用します。計算が単一のアプリケーションや分析に属する場合、または算術式や日付式が必要な場合は、実行時定義の派生プロパティを使用します。

利用可能な集計と式の完全な一覧については、派生プロパティのリファレンスを確認してください。

式とリンクベースの派生プロパティ

リンクベースの派生プロパティは、リンクされたオブジェクトから値を選択または集計します。オントロジー定義と実行時定義のどちらの派生プロパティも、リンクベースの計算をサポートしています。

式は、ネイティブプロパティ、またはリンクや集計による派生プロパティを使用して、算術計算や日付計算を行います。式は、実行時定義の派生プロパティでのみ利用できます。計算プロパティは、同じ withProperties 操作で宣言された別の計算プロパティを参照できません。代わりに、依存するプロパティを後続の操作で宣言します。

提供状況

アプリケーション対応状況
Ontology Managerオブジェクトタイプで、オントロジーで定義される派生プロパティを設定します。
Workshopオントロジーで定義された派生プロパティを使用するか、一部のウィジェット向けに、実行時に定義される派生プロパティをモジュールレベルで定義します。
オントロジー SDKオントロジーで定義された派生プロパティを使用するか、withProperties 操作で実行時に定義される派生プロパティを定義し、結果、フィルター、並べ替え、および集計で使用します。
Insightオントロジーで定義された派生プロパティを使用するか、実行時に定義される派生プロパティをテーブル分析に追加します。

TypeScript オントロジー SDK(OSDK 2.x)では、@osdk/client パッケージのサポート対象の最小バージョンは 2.2.0-beta.x です。リンクされたオブジェクトからのプロパティの選択、および算術式や日付式の使用には、バージョン 2.4.0 以降が必要です。詳細については、Developer Console の API ドキュメントを確認してください。

派生プロパティのセキュリティ

派生プロパティは、その計算に使用されるすべてのオブジェクトからセキュリティを継承します。アクセスチェックは、複数ホップの走査における中間オブジェクトも含め、計算に使用される各オブジェクトに対して、値が組み合わされる前に適用されます。

そのため、2人のユーザーに、同じオブジェクトの同じ派生プロパティについて異なる値が表示される場合があります。ユーザーごとの計算値には、そのユーザーに閲覧が許可されているソースオブジェクトと中間オブジェクトだけが反映されます。

リンクされた Quest オブジェクトを数え、最高報酬を返す Game World オブジェクトタイプの派生プロパティ。1つの地域にアクセスできるプレイヤーには、クエストの合計数が2、最高報酬が150と表示されます。一方、すべての地域にアクセスできる管理者には、クエスト数が34、最高報酬が1,200と表示されます。

値をリストやセットに収集する集計では、収集された各値のセキュリティマーキングが保持されるため、リスト内の個々の値にそれぞれのマーキングが付与されます。詳細については、プロパティのセキュリティマーキングを確認してください。

パフォーマンスとスケール

派生プロパティの値は、保存やインデックス化されるのではなく、クエリ時に評価されます。ただし、プラットフォームは、基になるオブジェクトのインデックスにフィルターをプッシュダウンすることで多くのクエリを最適化し、派生値を計算する前に処理が必要なデータを削減できます。

パフォーマンスは、フィルター適用後に残るオブジェクトの数、リンクされたオブジェクトの数と中間結果のサイズ、集計の種類、およびリンクをたどる回数によって異なります。派生値による絞り込みや並べ替えでは、通常、残っている候補オブジェクトについてその値を計算する必要があります。クエリによっては、一部の結合や集計もプッシュダウンできます。

実行のしきい値、フォールバック動作、クエリ設計のガイダンスについては、オントロジークエリの制限を確認してください。派生プロパティのクエリのコンピュートコストについては、クエリのコンピュート使用量を確認してください。派生プロパティとパイプラインで事前計算した値のどちらを選択するかについては、オントロジー構造のガイダンスを確認してください。

コレクションの上限

リストを収集とセットを収集の集計では、返す値の数に上限を設定できます。この上限は返される内容を制御しますが、プラットフォームが評価する対象を制限するものではありません。

収集されたプロパティに対するフィルター、並べ替え、集計は、切り詰められたリストではなく、値の完全な集合を対象に実行されます。そのため、受け取ったリストに含まれていない値によって、オブジェクトがフィルターに一致する場合があります。

収集されたプロパティに対するフィルターは、コレクションの上限内の値だけでなく、基になるすべての値をチェックします。つまり、フィルターの条件を満たした値が返されたリストに含まれていなくても、一致する場合があります。返されるリストは上限に合わせて切り詰められますが、フィルターの対象は制限されません。リデューサーも同様に動作します。リデューサーはコレクションの上限を 1 に設定することと同等ですが、返す1個の縮約値だけでなく、構成要素となるすべての値に対してフィルターを適用します。

レシピタグを収集する「リストを収集」の派生プロパティと表示上限3を設定した Recipe オブジェクトに対する Healthy の検索。Turkey Burger レシピはタグの1つが Healthy であるため一致しますが、返されるのは最初の3個のタグ(Dinner、Weeknight、Grill)だけです。

制限事項

派生プロパティは活発に開発が進められており、オントロジー定義の派生プロパティはベータ版です。以下の制限事項は、現在の動作を反映しています。

すべての派生プロパティ

  • Object Storage v1: 派生プロパティを含むクエリには、OSv1 を使用してインデックス化されたオブジェクトタイプを含めることはできません。
  • 主キー: 主キープロパティを派生プロパティにすることはできません。
  • 必須プロパティ: 派生プロパティを必須に指定することはできません。
  • Value Type: 派生プロパティに Value Type を直接適用することはできません。ただし、派生プロパティはソースプロパティの Value Type を継承します。
  • 表示の書式設定: 派生プロパティに条件付き書式設定ルールや値の書式設定を構成することはできません。
  • インラインアクション: 派生プロパティにインラインアクションを構成することはできません。
  • Automate:Automate の条件で派生プロパティによる絞り込みができるのは、スケジュール監視を使用する場合のみです。ライブ監視は派生プロパティに対応していません。

オントロジー定義の派生プロパティ

  • リンクの走査: 派生プロパティごとにリンクの走査は最大3回です。
  • 算術式と日付式: 対応していません。オントロジー定義の派生プロパティは、リンクの走査と集計のみに対応しています。算術計算や日付計算が必要な場合は、代わりに実行時定義の派生プロパティを使用します。
  • TypeScript v1 関数: TypeScript v1 関数で読み込まれるオブジェクトには、オントロジー定義の派生プロパティは含まれません。代わりに TypeScript v2 関数または Python 関数を使用します。
  • デフォルトでは返されない: API およびオントロジー SDK のリクエストでは、オントロジー定義の派生プロパティは明示的に選択しない限り返されません。方法については、TypeScript OSDK および Python OSDK のドキュメントを参照し、オブジェクトパラメーターに対して読み込まれるプロパティを確認してください。

実行時定義の派生プロパティ

  • 式の連鎖: 算術式や日付式から、同じ withProperties 操作内で宣言された別の式を参照することはできません。代わりに、依存する式を後続の withProperties 操作で宣言します。