使用 Workiva 連接器,您可以在鏈中使用命令 與 Workiva 平台互動,包括其他 Wdata 功能、Spreadsheets 和 GraphDB。例如,使用此連接器,您可以
- 建立和管理資料表、查詢和檢視
- 列出表的資料集或匯入錯誤
- 建立和管理試算表或其工作表
- 管理記錄和報告
要求
要與 Workiva 平台互動,連接器使用the Workiva REST APIs 。要設定連接器,您需要::
-
具備 OAuth2 授權的專用 Workiva 整合使用者。
注意: 此整合使用者需具備連接器所執行命令所需的適當權限,例如其互動之試算表或工作區的擁有者權限。
- 整合使用者的 OAuth2 授權 ID 和密碼。
- 若要在測試環境中執行鏈,可使用 URL 來覆寫 API 的主機和基本路徑。
注意: 雖然工作區的擁有者可以存取使用連接器的鏈,但連接器本身需要專用的整合使用者才能執行其指令。使用專用的整合使用者,而非合作者的使用者帳戶,可讓您追蹤連接器的活動,並限制其存取權限,僅限於執行指令所需的權限。
設定 Workiva 連接器
- 於 Chain Builder 中,按一下左側邊欄的 連線,再按一下右上方的 建立。
- 在Create Connection 下 ,選擇Workiva 和預設 CloudRunner。
- 在Basic Info 下,輸入唯一的名稱和描述以協助識別連線器。
-
於 資源 下方,選取欲與此連線建立關聯的資源。
此區段提供安全的存放位置,供連接器運作所需的任何檔案(指令碼、安全性權杖、憑證等)使用,例如驗證或環境需求相關檔案。當您儲存連線時,這些檔案會自動以 AES-256 加密。詳細資訊請參閱 Workiva Chain Builder 安全架構支援頁面。優點:
- 安全儲存:由於這些檔案於儲存時即經加密且儲存於連線層級,非常適合存放不應直接寫入鏈結本身的敏感或靜態設定資料。
- 可攜性:若您將鏈結從「測試」工作區移至「生產」工作區,這些資源仍會與連線設定綁定,代表您無需重新撰寫鏈結節點中的檔案路徑。
- 存取便利性:將檔案儲存於此處,可讓執行器(執行任務的代理程式)直接使用這些檔案,無需手動將檔案放置於執行器的實體主機上。
缺點:
- 由於檔案已加密,因此無法直接編輯;您必須刪除檔案並上傳修改後的版本。
-
在「屬性」(Properties) 下,輸入連結的詳細資料:
摘要資訊 詳細資料 ID 輸入整合使用者 OAuth 授權的 ID。 密碼 輸入ID 屬性的秘密。 Cerebral Host Override 若要覆寫的 Wdata 端點 的 URL 主機和基本路徑,例如用於測試環境,請輸入要替代使用的 URL。 試算表主機覆寫 要覆寫Spreadsheets 端點 的 URL 主機和基本路徑,例如測試環境,請輸入要使用的 URL。 IAM 主機覆寫 要覆寫識別和存取管理 (IAM) 端點 的 URL 主機和基本路徑,例如用於測試環境,請輸入要替代使用的 URL。 管理主機覆寫 若要覆寫管理端點 的 URL 主機和基本路徑,例如測試環境,請輸入要取代使用的 URL。 覆寫 GraphDB 主機 要覆寫 GraphDB 端點的 URL 主機和基本路徑,例如用於測試環境,請輸入要使用的 URL。 平台 API 主機覆寫 要覆寫的 URL 主機和基本路徑,Workiva 平台端點 ,如用於測試環境,請輸入要替代使用的 URL。 注意:所有敏感憑證都會自動以 AES-256 加密方式加密及儲存。
- 請選取要使用連結的環境,然後按一下「儲存」(Save)。
- 若要測試連線,使用連接器的List Files 指令 建立並執行連線 ,並驗證它是否傳回有效的輸出。
URL 覆寫
根據您生產環境的區域,可能需要覆寫 URL。您可以比對用於登入 Wdesk 的 URL 來驗證。若 URL 包含 .apac、.ca 或 .eu,則需要進行覆寫設定。
註: 美國地區資訊列出供參考。
| 欄位 | 價值 |
|---|---|
| Cerebral Host Override | 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 |
| Graph DB 主機覆寫 | https://api.app.wdesk.com/graphdb/v1/ |
| 平台 API 主機覆寫 | https://api.app.wdesk.com/platform/v1 |
| 欄位 | 價值 |
|---|---|
| Cerebral Host Override | 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 |
| Graph DB 主機覆寫 | https://api.apac.wdesk.com/graphdb/v1/ |
| 平台 API 主機覆寫 | https://api.apac.wdesk.com/platform/v1 |
| 欄位 | 價值 |
|---|---|
| Cerebral Host Override | https://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 |
| Graph DB 主機覆寫 | https://api.ca.wdesk.com/graphdb/v1/ |
| 平台 API 主機覆寫 | https://api.ca.wdesk.com/platform/v1 |
| 欄位 | 價值 |
|---|---|
| Cerebral Host Override | 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 |
| Graph 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/之後。