Workiva コネクターを使用すると、チェーンでコマンド を使用して、他の Wdata 機能、スプレッドシート、GraphDB を含む Workiva プラットフォームと対話することができます。例えば、このコネクターを使えば、次のことができる:
- テーブル、クエリ、ビューの作成と管理
- テーブルのデータセットやインポートエラーをリストアップする。
- スプレッドシートまたはそのシートの作成と管理
- 記録とレポートの管理
要件
Workiva プラットフォームと対話するために、コネクターはWorkiva REST API を使用します。コネクターの設定には、以下のものが必要だ:
-
Workivaとの統合を専門とするユーザー は、とのOAuth2グラント を利用しています。
注: この統合ユーザーには、コネクタが実行するコマンドに対して適切な権限(たとえば、連携対象のスプレッドシートやワークスペースの所有者権限など)が必要です。
- 統合ユーザーのOAuth2グラントIDとシークレット。
- テスト環境でチェーンを実行するには、APIのホストとベースパスを上書きするためのURLを指定します。
注: ワークスペースの所有者は、コネクターを使用するチェーンにアクセスすることができますが、コネクター自体のコマンドを実行するには、専用の統合ユーザーが必要です。共同作業者のユーザーアカウントではなく、統合専用のユーザーを使用することで、コネクターのアクティビティを追跡し、コマンドの実行に必要なアクセスのみに制限することができます。
Workivaコネクターの設定
- の「Chain Builder」 から、左側のサイドバーにある「 Connections」 をクリックし、次に右上の「 Create」 をクリックします。
-
Create Connection で、Workiva とデフォルト CloudRunner を選択します。
- 基本情報の下に、コマンドの識別をヘルプするユニークな名称と説明を入力します。
-
のリソース( )で、この接続に関連付けるリソースを選択します。
このセクションでは、認証や環境要件など、コネクタの動作に必要なあらゆるファイル(スクリプト、セキュリティトークン、証明書など)を安全に保管できる場所を提供します。接続を保存すると、これらのファイルは自動的にAES-256で暗号化されます。詳細については、の「Workiva Chain Builderのセキュリティアーキテクチャ」 のサポートページをご参照ください。メリット:
- 安全な保存: これらのファイルは保存時に暗号化され、接続レベルで保存されるため、チェーン自体にハードコーディングすべきではない機密性の高いデータや静的な設定データに最適です。
- 移植性: チェーンを「Test」ワークスペースから「Production」ワークスペースに移動しても、リソースは接続設定に紐づいたままとなるため、チェーンノード内のファイルパスを書き換える必要はありません。
- アクセシビリティ: ここにファイルを保存することで、ランナー (タスクを実行するエージェント)が、ランナーの物理ホストマシンに手動でファイルを配置することなく、そのファイルを利用できるようになります。
デメリット:
- これらは暗号化されているため、直接編集することはできません。ファイルを削除してから、変更したバージョンをアップロードする必要があります。
-
[プロパティ]で、接続の詳細を入力します。
プロパティ 詳細 ID 統合ユーザーのOAuth付与IDを入力します。 シークレット ID プロパティのシークレットを入力する。 脳内ホスト・オーバーライド Wdataエンドポイント のURLホストとベースパスをオーバーライドするには、テスト環境のように、代わりに使用するURLを入力してください。 スプレッドシートホストのオーバーライド テスト環境など、the Spreadsheets endpointsのURLホストとベースパスを上書きする場合は、代わりに使用するURLを入力してください。 IAMホストのオーバーライド テスト環境など、Identify and Access Management (IAM) endpointsの URL ホストとベースパスをオーバーライドするには、代わりに使用する URL を入力します。 管理者ホストのオーバーライド 管理者エンドポイント の URL ホストとベースパスをオーバーライドするには、テスト環境などで、代わりに使用する URL を入力します。 GraphDBホストのオーバーライド テスト環境など、GraphDBエンドポイントのURLホストとベースパスを上書きするには、代わりに使用するURLを入力します。 プラットフォームAPIホストのオーバーライド Workiva プラットフォーム・エンドポイント の URL ホストとベースパスを上書きするには、テスト環境の場合など、代わりに使用する URL を入力します。 注: 機密性の高い認証情報はすべて、AES-256暗号化を用いて自動的に暗号化され、保存されます。
- 接続を使用する環境を選択して、保存をクリックします。
- 接続をテストするには、 コネクターのList Filesコマンドでチェーンを作成して実行し、有効な出力を返すことを確認します。
URLオーバーライド
本番環境の地域によっては、オーバーライドURLが適用される場合があります。Wdeskにログインするために使用されるURLと比較することで確認できます。URLに「.apac」「 」「.ca」「 」、または「.eu」「 」が含まれている場合は、オーバーライドが必要です。
メモ: USリージョン情報は参照のため記載。
| フィールド | 値 |
|---|---|
| セレブレイン・ホスト・オーバーライド | 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 |
| フィールド | 値 |
|---|---|
| セレブレイン・ホスト・オーバーライド | 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 |
| フィールド | 値 |
|---|---|
| セレブレイン・ホスト・オーバーライド | h.ca.wdesk.com/s/cerebral |
| スプレッドシートホストのオーバーライド | https://api.ca.wdesk.com/spreadsheets/v1/ |
| IAMホストのオーバーライド | https://api.ca.wdesk.com/iam/v1/oauth2/token |
| 管理者ホストのオーバーライド | https://api.ca.wdesk.com/admin/v1 |
| グラフDBホストのオーバーライド | https://api.ca.wdesk.com/graphdb/v1/ |
| プラットフォームAPIホストのオーバーライド | https://api.ca.wdesk.com/platform/v1 |
| フィールド | 値 |
|---|---|
| セレブレイン・ホスト・オーバーライド | 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 |
トラブルシューティング
Workiva プラットフォームへの接続に失敗した場合:
- コネクタのアプリケーションのOAuth認証情報が存在し、正しく、かつ有効であることを確認してください。OAuth証明書には有効期限が定められており、証明書の有効期限が切れている可能性があります。この場合、新規証明書を作成し、Connector に新規クライアントシークレットを入力する必要がある。
- 統合ユーザーが、実行するコマンドに対して適切な権限を持っていることを確認する。
- ホストのオーバーライドを使用する場合は、コネクタに入力したURLが正しいか確認してください。
-
操作対象となっている Workiva ファイル(テーブル、クエリ、スプレッドシートなど)の ID が正しいことを確認してください。
メモ: Workivaで開くと、ファイルのIDがURLに表示される。例えば、スプレッドシートのIDは、URLの
spreadsheet/の後に表示される。テーブルのIDは、tables/の後に表示される。