ドキュメントの検索
karat

+

K

APIリファレンス ↗

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

アプリとファイル

アプリとファイルウィジェット は、現在の Object View 内で他の Foundry アプリを埋め込み、表示し、リンクすることができます。これらの組み込みウィジェットは、QuiverSlate などの他のアプリで作成されたアセットをサポートすることができます。さらに、メディアを表示したり、ファイルをアップロードしたり、ハイパーリンクを追加したり、そのオブジェクトに関するコメントや会話を許可したりするための Object View を有効にします。

より洗練された Object View を作成することに興味がある場合は、Workshop-backed tab を作成することを検討してみてください。

以下のウィジェットの一部はオブジェクトに意識的ではありません。これは、Object View 内の他のウィジェットとの相互作用が制限されていることを意味します。 * 例 1: コメントウィジェットの使用は特定の Object View 内でのみ保存され、実際のオブジェクトには書き戻されません。これらのコメントが特定のオブジェクトの文脈を超えて有用である可能性がある場合は、それらをキャプチャするためにアクションを使用することを検討してください。 * 例 2: 「リンクされたファイル」を使用してファイルを追加すると、Foundry に保存されますが、オブジェクトにはリンクされません。これらのファイルを再利用可能にしたい場合は、Actions attachments を使用することを検討してください。 * 例 3: Slate や Contour を埋め込むことはパラメーターを渡すことを許可しますが、フィルターを公開または消費せず、チャートウィジェットなどの他のウィジェットとのクロスフィルター処理を許可しません。

Quiver Object Canvas

Object View に Quiver テンプレートを埋め込む方法の詳細な手順については、Quiver templates documentation を参照してください。

Slate アプリケーション

このウィジェットは、オブジェクトビュー内に Slate application を表示し、2つのアプリケーション間で状態の共有と相互作用をサポートします。オブジェクトビューから Slate アプリケーションへ、現在のオブジェクトコンテキストとアクティブなフィルター状態が利用可能になります。Slate アプリケーションからオブジェクトビューへは、Slate 内で提供される一連のイベントが Object Explorer 内の振る舞いにマッピングされます。これには、新しい Object タブや Exploration タブを開く、オブジェクトビューフィルターを更新するなどが含まれます。

設定

Slate Resource 表示する Slate リソースを選択します。オブジェクトを閲覧する権限を持つすべてのユーザーがアプリケーションも閲覧できるようにします。

Slate リソースに対する「レスポンシブ」なデザインを選択すると、アプリケーションはオブジェクトビューレイアウトと利用可能な画面サイズに基づいてリサイズされるため、最良の結果が得られます。

Default Parameters デフォルトでは、現在のオブジェクトとそのオブジェクトタイプの ID が Slate ダッシュボードに渡され、変数にマッピングすることができます。これらはオフにするか、そのターゲット変数を変更することができます。デフォルトの変数名は objectIdobjectTypeId です。Slate アプリケーションでは、対応する変数が Variable タブで手動で作成されていることを確認してください。

Custom Parameters 追加のカスタムパラメーターを使用して、プロパティ値または静的な事前定義された値を Slate アプリケーションに渡します。これらのパラメーターをキャプチャし、アプリケーションで使用するために、Slate アプリケーションで対応する変数を作成します。

Slate でのパラメーターの使用

設定されたパラメーターは、Slate アプリケーションがロードされるときに渡されます。Slate アプリケーションを設定するときには、各パラメーターに対応する変数が Variable パネルで作成されている必要があります。変数の使用方法について詳しく学ぶ Object Explorer から Slate へ渡されるパラメーターのキーと値を確認するために、オブジェクトビューエディタ内のデバッグツールバーから「パラメーターを表示」を選択することができます。

オブジェクトビューフィルターへのアクセス

オブジェクトビューフィルターは IObjectSetFilter 形式で共有され、Slate 内で利用可能な Object Set API と簡単に使用することができます。これらはフィルターが変更されるときに cross-frame postMessage を使用して自動的に Slate に送信され、Slate から Object Explorer へ送信されるイベントを使用して手動で要求することもできます。このリクエストイベントは、Slate ダッシュボードが最初にフィルターを受け取る準備ができたときにフィルターの送信をトリガーするために使用することができます。

フィルターを Slate 内でキャプチャするには、post メッセージペイロードを取る slate.getMessage イベントハンドラを設定し、それを JSON として解析し、その結果を変数に設定する必要があります。イベントについて詳しく学ぶ 以下は、フィルターを変数にキャプチャするために十分なものであるべきです:

Copied!
1 2 3 4 5 // "payload"という名前の定数を作成します。{{slEventValue}}の"payload"属性を参照します。 const payload = {{slEventValue}}["payload"] // JSON形式のデータをJavaScriptオブジェクトに変換して返します。 return JSON.parse(payload);

フィルターは2つの形式で利用可能です。1つの形式には、元となるオブジェクトタイプに基づかないすべてのフィルターが含まれ、もう1つの形式には、オブジェクトタイプごとにグループ化されたフィルターと、特定のオブジェクトタイプに基づかないフィルターの別リストが含まれています。

すべてのフィルターのペイロードは以下の形状を持っています:

Copied!
1 2 3 4 5 6 { // "type"は、発生するイベントの種類を示す。ここでは"HUBBLE_SLATE_WIDGET // ACTIVE_FILTERS_UPDATED"が指定されています。 "type": "HUBBLE_SLATE_WIDGET // ACTIVE_FILTERS_UPDATED", // "payload"は、イベントに関連する追加データを保持します。ここでは、IObjectSetFilter[]の配列(オブジェクトセットフィルタの配列)が指定されています。 "payload": <IObjectSetFilter[]> }

オブジェクトタイプでグループ化されたフィルターのペイロードは次のような形状を持ちます:

Copied!
1 2 3 4 5 6 7 8 9 { "type": "HUBBLE_SLATE_WIDGET // ACTIVE_FILTERS_BY_OBJECT_TYPE_ID_UPDATED", "payload": { "filtersByObjectType": { [objectTypeId]: <IObjectSetFilter[]> // オブジェクトタイプIDごとのフィルター }, "globalFilters": <IObjectSetFilter[]> // グローバルフィルター } }

Slateからのイベントトリガー

SlateがObject Explorer内でイベントをトリガーするための利用可能なイベントタイプは以下の通りです:

  • Object Explorerで新しいオブジェクトタブを開く(オブジェクトRIDを使用)
  • Object Explorerで新しいオブジェクトタブを開く(オブジェクトの主キーを使用)
  • 指定されたオブジェクトセットのためのObject Explorerで新しい探索タブを開く
  • オブジェクトビューにオブジェクトセットフィルターを公開する
  • オブジェクトビュー上のオブジェクトセットフィルターをクリアする
  • 現在のオブジェクトビューのデータを更新する
  • Slateにオブジェクトビューフィルターの再送を要求する

これらのイベントは slate.sendMessage アクションを使用してトリガーします。 このアクションから、カスタムロジックからのイベントメッセージオブジェクトを返します。 イベントについて詳しく学ぶ。 各イベントの想定されるフォーマットは以下にリストされています。 イベント統合のデバッグには、オブジェクトビューエディターのデバッグツールバーを使用します。 これは、ポストメッセージがキャプチャされたが、イベントペイロードが何らかの形で間違っているときに警告を表示します。

Object Explorerで新しいオブジェクトタブを開く(オブジェクトRIDを使用) このイベントは主に objectRid パラメーターに依存しますが、特定のタブでオブジェクトビューを開く必要がある場合はオプションで tabId を取ることができます。

Copied!
1 2 3 4 5 6 { "type": "HUBBLE_SLATE_WIDGET // OPEN_OBJECT_BY_RID", // タイプは "HUBBLE_SLATE_WIDGET // OPEN_OBJECT_BY_RID" "payload": { "objectRid": "...", // オブジェクトのRidは "..." }, }

オブジェクトエクスプローラで新しいオブジェクトタブを開く(オブジェクトの主キーを使用して) オブジェクトRIDが不明な場合は、オブジェクトタイプIDと一緒に、オブジェクトの主キープロパティを使用してオブジェクトビューを読み込むこともできます。

Copied!
1 2 3 4 5 6 7 8 9 { "type": "HUBBLE_SLATE_WIDGET // OPEN_OBJECT_BY_PRIMARY_KEY", // "type"は操作の種類を表します。ここでは、主キーによるオブジェクトの開放を表しています。 "payload": { "objectTypeId": "...", // "objectTypeId"はオブジェクトの種類IDを表します。 "primaryKey": { // "primaryKey"はオブジェクトを一意に識別するための主キーを表します。 ... }, }, }

特定のオブジェクトセットに対してObject Explorerで新しい探索タブを開く オブジェクトセットを提供することで、新しい検索/探索タブを開くことができます。これらのオブジェクトセットは、探索UI内での表現に問題が生じないように、複雑さが制限されているべきです。

Copied!
1 2 3 4 5 6 7 8 { "type": "HUBBLE_SLATE_WIDGET // OPEN_NEW_SEARCH_FOR_OBJECT_SET", // 「HUBBLE_SLATE_WIDGET // OPEN_NEW_SEARCH_FOR_OBJECT_SET」というタイプ "payload": { // ペイロード(データ)部分 "objectSet": { // オブジェクトセット ... } }, }

オブジェクトビューにオブジェクトセットフィルターを公開する 多くのオブジェクトビューウィジェットは、ビュー内の他のウィジェットに影響を与えるフィルターを公開することができます。Slateウィジェットは、このイベントを使用して公開するフィルターを送信することでこれを実現できます。最新の公開フィルターは、同じSlateウィジェットによって以前に公開されたフィルターを置き換えるため、これらのフィルターの状態はSlate内で管理する必要があります。フィルターはオブジェクトセットフィルターとしてフィルター処理されるべきで、これはオブジェクトセットサービスAPIへのリクエストで使用されるのと同じ形式です。特定のオブジェクトタイプ(filtersByObjectType)やグローバルプロパティ(globalFilters)に対してフィルターを提供することができます。

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 { "type": "HUBBLE_SLATE_WIDGET // PUBLISH_OBJECT_SET_FILTER", // オブジェクトタイプごとのフィルター "payload": { "filtersByObjectType": { ... }, // グローバルフィルター "globalFilters": { ... } }, }

オブジェクトビュー上のオブジェクトセットフィルターをクリアする オブジェクトビューに存在する公開フィルターは、このイベントを使用することで素早くクリアすることができます。ペイロードは必要ありません。

Copied!
1 2 3 4 { "type": "HUBBLE_SLATE_WIDGET // CLEAR_PUBLISHED_FILTERS" // HUBBLE_SLATE_WIDGET // CLEAR_PUBLISHED_FILTERS のタイプ }

現在のオブジェクトビューのデータを更新する オブジェクトビュー内のデータに更新が適用されている場合、データの再読み込みをトリガーする必要があるかもしれません。このイベントはそのために使用できます。ペイロードは必要ありません。

Copied!
1 2 3 4 { // "type"はウィジェットの種類を指定します。この場合、"HUBBLE_SLATE_WIDGET // REFRESH_OBJECT_VIEW"は、オブジェクトビューを更新するためのHubble Slateウィジェットを指します。 "type": "HUBBLE_SLATE_WIDGET // REFRESH_OBJECT_VIEW" }

Object View フィルターを Slate に再送信するリクエスト 上記の「Object View フィルターへのアクセス」セクションで説明されているように、他のウィジェットで公開されたオブジェクトビューのフィルターは、ポストメッセージを使用して Slate に送信されます。Slate ダッシュボードが初期化され、フィルターを処理する準備ができたら、このイベントを発火してフィルターをリクエストします。Hubble からフィルターを含む別のイベントが送信されます。リクエストできるフィルターには 2 種類あります。1 つの形式では、オリジンオブジェクトタイプに関係なくすべてのフィルターが含まれます。もう 1 つの形式では、オリジンオブジェクトタイプごとにグループ化されたフィルターが含まれます。これらのリクエストにはペイロードは必要ありません。

すべてのフィルターを送信するには:

Copied!
1 2 3 { "type": "HUBBLE_SLATE_WIDGET // REQUEST_ACTIVE_FILTERS" // "type": "HUBBLE_SLATE_WIDGET // REQUEST_ACTIVE_FILTERS" // フィルターのアクティブなリクエストを要求する }

オブジェクトタイプでグループ化されたフィルターを送信するには:

Copied!
1 2 3 { "type": "HUBBLE_SLATE_WIDGET // REQUEST_ACTIVE_FILTERS_BY_OBJECT_TYPE" // "type": "HUBBLE_SLATE_WIDGET // OBJECT_TYPE別に有効なフィルターをリクエスト" }

メディアプレビュー

このウィジェットは、添付プロパティまたはメディアの種類(画像、PDFなど)のURLであるプロパティが指定された場合、メディアファイルの単一の大きなインラインプレビューを表示します。

media preview

設定

メディアプレビューウィジェットを使用するには、表示中のオブジェクトを添付プロパティを含むように設定する必要があります。添付プロパティは、Foundry 内で関連メディアを保存し、それらが追加されたオブジェクトからのアクセス許可を継承することでメディアが正しくアクセス許可されるようにします。添付プロパティにメディアを追加する方法については、このページを参照してください。

また、メディアプレビューウィジェットは、プロパティに格納された URL を使用して、Foundry 上の既存のメディアを表示するためにも使用できます。オブジェクトビューを表示するユーザーは、オブジェクトとメディアが格納されている場所の両方へのアクセスが必要です。オブジェクトビューにメディアを追加するには、次の手順に従ってください。

  1. Foundry にメディアをアップロードする: データセットは、任意のファイルのコレクションを保存する方法として使用できます。このようなデータセットを作成するには、ファイルをフォルダーにアップロードし、表示されるポップアップですべてのファイルを単一のデータセットとしてバンドルするを選択します。単一のファイルのみをアップロードする場合、このオプションはスキーマなしのデータセットにアップロードすると表示されます。

upload files as dataset

このデータセットが作成されたら、必要に応じて追加のファイルを追加できます。これを行うには、データセットプレビューの右上にあるインポートをクリックします。

import additional files

表示されるダイアログで、アップロードする追加のファイルを選択します。

upload additional files

  1. URL 行を追加する: 表示中のオブジェクトの元データセットに、各対応する行のメディアファイルの URL を含む新しい行を追加します。URL は、次の形式にする必要があります。「https://{my-foundry-url}/foundry-data-proxy/api/web/dataproxy/datasets/{dataset rid}/transactions/{transaction rid}/{filename}」または「https://{my-foundry-url}/foundry-data-proxy/api/web/dataproxy/datasets/{dataset rid}/views/{branch name}/{filename}」
    • 例:「https://{my-foundry-url}/foundry-data-proxy/api/web/dataproxy/datasets/ri.foundry.main.dataset.39ce332b-1d74-40ca-be35-5a5b48459a9a/transactions/ri.foundry.main.transaction.00000000-0000-30d2-8067-4b5d9c819f4c/sample-doc.pdf」
    • 注: PDF を使用する場合、URL は「/foundry-data-proxy/api/dataproxy」で始まる必要があり、「/foundry-data-proxy/api/web/dataproxy」ではありません。
  2. オントロジーで列を「hubble」としてマークする: オントロジーで列のプロパティを作成し、そのプロパティに種類 =「hubble」および名前 =「media_url」の Typeclass を付与します。
    • 他のメディア Typeclass: 他の可能性としては、「hubble」および「hubble」があります。それぞれ、この URL をオブジェクトのアイコンまたは検索結果カードのサムネイルとして使用します。
  3. Object Explorer のオブジェクトビューにメディアウィジェットを追加する: 現在、組み込みのメディアウィジェットには、Media PreviewMedia Thumbnails の 2 種類があります。オブジェクトビューを編集してセクションを追加をクリックすると、各タイプのセクションの説明が表示されます。ウィジェットは、プレビューするメディアの URL を含むプロパティであるメディアプロパティの設定が必要です。

他に設定すべきパラメーター:

  • タイトル(必須): ウィジェットのヘッダーに表示されるタイトル。
  • アイコン(必須): ウィジェットのヘッダーに表示されるヘッダー。
  • ヘルプ情報: ツールチップで追加のヘルプ情報を表示する。
  • 高さ: メディアウィジェットを表示する高さ(ピクセル単位)。

ハイパーリンク

ハイパーリンクウィジェットは、単純な Web ページへのリンクとして機能するボタンを作成します。オブジェクトビューに任意の数のリンクを追加でき、それぞれが静的(つまり、すべてのオブジェクトインスタンスに対して同じリンク)または動的なオブジェクトごとのリンクになります。

Hyperlink.png

設定

  1. Open Link In - 同じタブでブラウザを開くか(デフォルト)、別のタブで開くか、ポップアップウィンドウで開くかを選択します。ポップアップは信頼性が低く、ブラウザ/インストールされている拡張機能によって問題が発生する可能性があります。これはすべてのオブジェクトに適用されます。
  2. Link Intent - リンクボタンの色を決定する 5 つのリンク「意図」。Blueprint Intent CSS クラスがボタンに適用されます(デフォルトはありません):
    1. 「なし」- グレー
    2. 「プライマリ」- 青
    3. 「成功」- 緑
    4. 「警告」- オレンジ
    5. 「危険」- 赤
  3. URL Type - 3 種類の URL 設定があります。
    1. プロパティ - ハイパーリンク先として使用する URL を含む動的プロパティ。
      1. 設定方法:(1)オブジェクトタイプを選択します(通常は表示中のオブジェクト);(2)リンクが取得されるべきプロパティ列を選択します。値が null の場合、ハイパーリンクボタンを非表示にするオプションがあります。
      2. 例えば、2つの「ウェブサイト」オブジェクトがあり、オントロジーで定義された site_URL フィールドがあり、オブジェクト1の site_URLhttps://palantir.com に設定され、オブジェクト2の site_URLhttps://palantir.com/uk に設定されている場合があります。
    2. ハードコーディング - すべてのオブジェクトに表示される静的な URL。URL をコピーして貼り付け、https:// を必ず含めてください。
    3. テンプレート化 - テンプレート化された URL を使用して、オブジェクトのプロパティに基づいてリンクをカスタマイズできます。単一の波括弧 { } で囲むことで、URL 内の任意のプロパティを取り込むことができます。
      1. 例えば、レポートの RID が report_rid プロパティとして保存されている場合、URL テンプレート /workspace/report/{report_rid} を使用して、各オブジェクトに関連付けられたレポートを開くボタンを作成できます。
  4. Link Title - ハイパーリンクボタンに表示されるテキストラベル。これはすべてのオブジェクトで同じになります。

一般的な問題と注意点:

  • ハイパーリンクが壊れている場合、ユーザーは Object Explorer のランディングページにリダイレクトされます。

リンクされたファイル

リンクされたファイルウィジェットを使用すると、ユーザーは、リソースセレクターを使用して Foundry 内の既存のファイルを選択するか、ローカルマシンから新しいファイルを Foundry にアップロードすることで、表示中のオブジェクトをファイルにリンクできます。

Linked files

設定

このセクションにはカスタマイズオプションはありません。フォーマットタブでタイトルやその他の一般的な書式設定を変更することはできます。

一般的な問題と注意点:

  • このウィジェットを介してアップロードされたファイルは、オントロジーの一部として書き戻されず、現在のオブジェクトのプロパティとして保存されません。これを実現するには、書き戻しを伴う Foundry フォームを使用してください。
  • 現在、2 つのオプションのうち 1 つを非表示にする方法はありません。そのため、「ファイルをアップロード」と「新しいファイルをリンク」の両方が常に表示されます。
  • 現在、ファイルアップロードのデフォルトの保存先を設定する方法はありません。そのため、ユーザーはアップロードするたびに Foundry 内の保存先を検索する必要があります。

Iframe

Slate ダッシュボードや他の Foundry アプリケーションのインラインフレームを、オブジェクトビューに「Web ページ内の Web ページ」として埋め込むことができます。iframe を使用すると、Slate でのフィルター変数や Contour のパラメータに現在のオブジェクトから値を渡すことができます。

設定

iframe を埋め込むには、下記の説明に従って、正しい Foundry アドレスへのリンクを Handlebar 構文を使って設定する必要があります。

  1. 必須: 埋め込むページへの完全なリンクをコピーし、「/workspace/」の前のすべてのテキストを削除します。
  2. 必須: 「embedded=true」を追加して、完全な表示を示します。embedded=true が唯一のステートメントである場合は、プレフィックスに /? を追加し、embedded=true が他のステートメントにアタッチされている場合は & を追加します。
    • レポート例: /workspace/report/ri.report.main.report.ABCDEF-1234-5678/?embedded=true
    • Slate 例: /workspace/slate/documents/SLATE_DOCUMENT_NAME/latest?&embedded=true
  3. オプション: 特定の変数/パラメータに対してフィルターをかけるために、Slate に値を渡します。Object Explorer のオブジェクトタイプ ID、特定のオブジェクト ID、または特定のプロパティ ID を使用します。& を使用し、波括弧 {{propertyID}} の中にどの値を Slate に注入するかを記述します。これは、Handlebar 構文に基づいています。
    • レポート例: /workspace/report/ri.report.main.report.ABCDEF-1234-5678/?PARAMETER_NAME={{propertyID}}&embedded=true
    • Slate 例: /workspace/slate/documents/SLATE_DOCUMENT_NAME/latest?VARIABLE_NAME={{propertyID}}&embedded=true

他の設定

  • 標準の iframe とヘッダーレスの iframe の違いは、ヘッダーレスの iframe はウィジェットのヘッダーを非表示にすることで、ウィジェットのヘッダーには通常、アイコン、タイトル、設定のフォーマットタブでウィジェットにタイトルを追加するオプションが含まれています。
  • iframe ウィジェットでは、ウィジェットの高さを設定できます。デフォルトは 500 で、手動で調整されます。
  • iframe を設定すると、オブジェクトビュー内のウィジェットの下にヘルパーウィンドウが表示されます(編集モードの場合のみ表示されます)。ヘルパーウィンドウには、オブジェクト固有のヒントが表示され、Slate や他の Foundry アプリケーションに渡すことができるプロパティと ID が表示されます。
  • レポートのヘッダーを非表示にするには、URL に次のものを追加します。「&__rp_headerBar=hidden」。
  • Foundry の外部のウェブサイトを埋め込むことが可能ですが、セキュリティおよびポリシー要件に従っています。ユーザーのユースケースにこれが必要だと思われる場合は、Palantir の担当者にお問い合わせください。

コメント

このウィジェットは、オブジェクトの共同作業を行うユーザー向けのローカルダイアログボックスを提供し、他のユーザーにメンションするオプション(@user_name のタグ付け)があります。

これらのコメントは、オブジェクト自体に記録されず、Foundry 全体でのこの会話の検索や再利用を可能にしません。

設定

このセクションにはカスタマイズオプションはありません。フォーマットタブでタイトルやその他の一般的な書式設定を変更することはできます。

ソースデータセットが変更された場合のコメントの動作

オブジェクトタイプのソースデータセットが変更されると、対応するコメントフィードが消えます。

コメントの書き戻し

このウィジェットを通じて追加されたコメントは、オントロジーの一部として書き戻されず、これらのコメントは現在のオブジェクトのプロパティとして保存されません。コメントに関するユースケースが検索、分析、またはコメントからの学習を含む場合は、アクションを使用してください。