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

以下の各セクションで説明するステップに沿って、ウィジェットセットで OSDK を使用できます。

ウィジェットセット用の OSDK を設定する

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

SDK の設定オプション。

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

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

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

ウィジェットに OSDK をインストールする

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

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

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

作成時に Foundry 外部を選択し、OSDK パッケージを生成しなかった場合は、Foundry から OSDK パッケージを解決できるように 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 に対応する値に置き換えてください。

ウィジェット内の OSDK を設定する

クライアントの 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(),
);

OSDK を使用する

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

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

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

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

これに対処するには、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