Workiva チェーン・コネクターは、ワークスペース、環境、チェーンの共通コマンドを提供します。これには、プロパティ、チェーン実行の詳細、ログインアクティビティイベントなどを取得するために使用されるlistコマンドとgetコマンドが含まれます。
互換性のあるコマンドの全リストは、Workiva チェーンコマンドの記事を参照してください。
要件
コネクターを使用する前に
- 組織のセキュリティ管理者は、構成画面を通じて Workiva チェーンコネクター を有効にする必要があります。
- テスト環境でチェーンを実行するには、APIのhostsとベースパスをオーバーライドするURLが必要だ。
- 統合専用ユーザーを作成し、OAuth2 グラントをソフトウェア内に付与する必要があります。
- チェーンIDを検索するには、WorkivaでIDを検索上でこの記事をご覧になれます。
統合ユーザーの追加要件
すべてのワークスペース所有者がコネクターを使用するチェーンにアクセスできますが、コネクター自体のコマンドを実行するには専用の統合ユーザーが必要です。共同作業者のユーザーアカウントではなく、統合専用のユーザーを使用することで、コネクターのアクティビティを追跡し、コマンドの実行に必要なアクセスのみに制限することができます。
統合ユーザーを設定する際には、以下の項目が必要です:
- 統合ユーザーのOAuth2付与IDとシークレットを知っている必要があります。
- 統合ユーザーには、コネクターが実行する各コマンドに適切な権限を与える必要があります。たとえば、コネクターが相互作用するスプレッドシートやワークスペースの所有者などになります。
- 統合ユーザーは、コマンドを実行する前にチェーンビルダーにログインする必要があります。これはユーザーのアカウントを確立するために必要である。
接続セットアップ
Workiva チェーンのコネクターを設定する:
- チェーンビルダー から接続 をクリックし、右上の作成 をクリックします。
- コネクター 接続 で、Workiva チェーン とデフォルト CloudRunner を選択します。
-
基本情報の下に、コマンドの識別をヘルプするユニークな名称と説明を入力します。
- [プロパティ]で、接続の詳細を入力します。
プロパティ 詳細 ベースURL ベースURL。デフォルトはhttps://h.app.wdesk.com/s/wdata/oc/api/。 ID 統合ユーザーのOAuth付与IDを入力します。 シークレット ID プロパティのシークレットを入力する。 IAMホストのオーバーライド テスト環境など、Identify and Access Management (IAM) endpointsの URL ホストとベースパスをオーバーライドするには、代わりに使用する URL を入力します。 - 接続を使用する環境を選択して、保存をクリックします。
URLオーバーライド
本番環境の地域によっては、オーバーライドURLが適用される場合があります。 Wdeskにログインするために使用されるURLと比較することで確認できます。 URL にEU またはAPAC を含む場合は、オーバーライドが必要です。
メモ: USリージョン情報は参照のため記載。
| フィールド | 値 |
|---|---|
| セレブレイン・ホスト・オーバーライド | https://h.app.wdesk.com/s/cerebral |
| スプレッドシートホストのオーバーライド | https://api.app.wdesk.com/spreadsheets/v1/ |
| IAMホストのオーバーライド | https://api.app.wdesk.com/iam/v1/oauth2/token |
| 管理者ホストのオーバーライド | https://api.app.wdesk.com/admin/v1 |
| グラフDBホストのオーバーライド | https://api.app.wdesk.com/graphdb/v1/ |
| プラットフォームAPIホストのオーバーライド | https://api.app.wdesk.com/platform/v1 |
| フィールド | 値 |
|---|---|
| セレブレイン・ホスト・オーバーライド | https://h.eu.wdesk.com/s/cerebral |
| スプレッドシートホストのオーバーライド | https://api.eu.wdesk.com/spreadsheets/v1/ |
| IAMホストのオーバーライド | https://api.eu.wdesk.com/iam/v1/oauth2/token |
| 管理者ホストのオーバーライド | https://api.eu.wdesk.com/admin/v1 |
| グラフDBホストのオーバーライド | https://api.eu.wdesk.com/graphdb/v1/ |
| プラットフォームAPIホストのオーバーライド | https://api.eu.wdesk.com/platform/v1 |
| フィールド | 値 |
|---|---|
| セレブレイン・ホスト・オーバーライド | https://h.apac.wdesk.com/s/cerebral |
| スプレッドシートホストのオーバーライド | https://api.apac.wdesk.com/spreadsheets/v1/ |
| IAMホストのオーバーライド | https://api.apac.wdesk.com/iam/v1/oauth2/token |
| 管理者ホストのオーバーライド | https://api.apac.wdesk.com/admin/v1 |
| グラフDBホストのオーバーライド | https://api.apac.wdesk.com/graphdb/v1/ |
| プラットフォームAPIホストのオーバーライド | https://api.apac.wdesk.com/platform/v1 |