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

ウィジェットセットでオントロジー SDK を使用する

以下の各セクションの手順に従って、ウィジェットセットでオントロジー SDK を使用できます。

ウィジェットセット用のオントロジー SDK を設定する

ウィジェットセット用のオントロジー SDK を設定するには、ウィジェットセットの概要ページに移動し、ページ上部のバーで SDK を設定を選択します。

SDK の設定オプション。

次に、オントロジーと、ウィジェットからアクセスするリソースを選択します。

オントロジー API を有効にする

オントロジー SDK からの API 呼び出しを成功させるには、ウィジェットセットのオントロジー API も有効にする必要があります。この操作は、エンロールメントのデフォルトロールである情報セキュリティ責任者を持つユーザーが実行できます。また、ウィジェットセットの制限なし API アクセスを有効にするワークフローを許可するカスタムエンロールメントロールを持つユーザーも、この操作を実行できます。

ウィジェットにオントロジー SDK をインストールする

上記の手順が完了すると、ウィジェットセットでオントロジー SDK を使用し始めることができます。そのためには、次の JSON を使用して、@custom-widget/sdk が package.json に記載され、適切にインストールされていることを確認してください。

Copied!1
2
3
4
5
6
7
{
    // ...
    "dependencies": {
        // ...
        "@custom-widget/sdk": "latest"
    }
}

作成時に Foundry 内部を選択した場合は、Foundry のコードリポジトリを使用しています。プロジェクトの .npmrc ファイルは、オントロジー SDK パッケージを含む NPM の依存関係を Foundry から解決するようにすでに設定されているはずです。このファイルは変更しないでください。

作成時に Foundry 外部を選択し、オントロジー SDK パッケージを生成しなかった場合は、Foundry からオントロジー SDK パッケージを解決できるように、NPM を手動で設定する必要があります。プロジェクトのルートに次の内容の .npmrc ファイルを設定すると、この設定を行えます。

//<EXAMPLE>.palantirfoundry.com/artifacts/api/:_authToken=${FOUNDRY_TOKEN}
@custom-widget:registry=https://<EXAMPLE>.palantirfoundry.com/artifacts/api/repositories/<ri.widgetregistry..widget-set.LOCATOR>/contents/release/npm/

上記のスニペットは、@custom-widget スコープを Foundry から解決し、FOUNDRY_TOKEN 環境変数で認証するように NPM に指示します。<EXAMPLE> と <ri.widgetregistry..widget-set.LOCATOR> のプレースホルダーを、Foundry インスタンスとウィジェットセットの RID に対応する特定の値に置き換えてください。

ウィジェットでオントロジー SDK を設定する

クライアントの baseUrl が window.location.origin に設定されていることを確認してください。オントロジーへのアクセスには実行時にユーザーのトークンが使用され、ユーザーの権限が適用されるため、createFoundryWidgetTokenProvider() ヘルパーを使用して認証トークンのプレースホルダー値を指定できます。次のコードスニペットを確認してください。

Copied!1
2
3
4
5
6
7
8
9
import { createClient } from "@osdk/client";
import { $ontologyRid } from "@custom-widget/sdk";
import { createFoundryWidgetTokenProvider } from "@osdk/widget.client";

const client = createClient(
    window.location.origin,
    $ontologyRid,
    createFoundryWidgetTokenProvider(),
);

オントロジー SDK を使用する

使用方法の詳細については、ウィジェットセットの上部のバーで SDK ドキュメントを選択し、オントロジー SDK のドキュメントを参照してください。

SDK ドキュメントの選択肢。

アクション実行時にホストのデータを更新する

ウィジェットがオントロジー SDK を使用してオントロジーアクションを適用し、オブジェクトセットパラメーターの元となるデータを変更すると、ホストアプリケーションのデータが最新ではなくなる場合があります。

これに対処するには、refreshHostDataOnAction オプションを有効にできます。このオプションを有効にすると、ウィジェットがオントロジーアクションを適用した後、ホストアプリケーション（Workshop など）が、ウィジェットに渡されたオブジェクトセットパラメーターを自動的に更新します。Workshop のアプリケーション作成者が追加の設定を行う必要はありません。

新しく作成されたウィジェットセットでは、このオプションがプラグインレベルでデフォルトで有効になっています。既存のウィジェットセットでは、以下の手順で手動で有効にできます。

ウィジェットセット内のすべてのウィジェットでこれをデフォルトにするには、Vite プラグインの defaults オプションを設定します。

Copied!1
2
3
4
5
6
7
8
9
10
11
12
import FoundryWidgetPlugin from "@osdk/widget.vite-plugin";
import { defineConfig } from "vite";

export default defineConfig({
    plugins: [
        FoundryWidgetPlugin({
            defaults: {
                refreshHostDataOnAction: true,
            },
        }),
    ],
});

個々のウィジェットでプラグインレベルのデフォルトをオーバーライドするには、ウィジェット設定ファイルで refreshHostDataOnAction を設定します。

Copied!1
2
3
4
5
6
7
8
9
10
11
import { defineConfig } from "@osdk/widget.client";

export default defineConfig({
    id: "myWidget",
    name: "My Widget",
    description: "An example widget",
    type: "workshop",
    refreshHostDataOnAction: false, // プラグインレベルのデフォルトをオーバーライドします
    parameters: {},
    events: {},
});

サポートされているエンドポイント

カスタムウィジェット内では、Admin 名前空間のいくつかのエンドポイントを使用できます。

オントロジー API が有効になっている場合は、追加のエンドポイントも使用できます。これには、次の名前空間のすべてのエンドポイントが含まれます。

また、次の個別のエンドポイントも含まれます。

メディアをアップロード

制限事項

現在、ウィジェットは次の Foundry API 機能をサポートしていません。

オブジェクトセットの購読
サポートされているエンドポイントに記載されていない API

←

PREVIOUSReact アプリケーションのためのOSDK / トラブルシューティング

NEXTダークテーマのサポート

→