本指南提供了實作 使用控製表執行查詢並下載結果範本的逐步說明。此範本可替代 執行查詢 命令，以前該命令需要使用者在部署和執行之前在鏈結中手動輸入參數。
透過使用 控制工作表，使用者可以新增多個查詢 ID 並動態定義參數，例如 Pick-list 或 Multi-Select。此範本通常整合到現有鏈結中，但也可用於需要 CSV 格式查詢結果的任何工作流程。
必要條件
必須在您的工作區中啟用並設定以下連接器。
- 配置Workiva 連接器
- 配置JSON 連接器
- 配置Handlebars 連接器
- 設定 HTTP 要求連接器
- 設定 表格轉換連接器
必須在您的工作區中建立以下工作區變數:
- wsv_API 基本 URL - IAM
- wsv_Client ID
- wsv_Client Secret
- wsv_API 基本 URL - Wdata
尋找範本
使用控制工作表 [] 執行查詢並下載結果 範本位於 範本 畫面的 [] Workiva 鏈結 (Workiva Chains) 區段中。
以下是如何找到它：
- 在 Chain Builder 中，移至Templates 索引標籤。
- 從上方功能表選擇Workiva Chains 。
- 搜尋 0.0 執行查詢 | 搜尋 []在右上角的 Top-Level Orchestration 並開啟範本。
-
找到範本後，按一下New Chain 將其部署到您的工作區。
注意： 一旦配置完成，此模板中的每個鏈都必須發佈到工作區。
變數
| 變數類型 | 變數名稱 | 說明 |
|---|---|---|
| 工作區變數 | wsv_API 基本 URL - IAM |
根據您所在的地區輸入 API 的基本 URL：
|
| 工作區變數 | wsv_Client ID |
輸入您在設定 API 授與時收到的用戶端 ID。 有關 Workiva API 的更多說明，請參閱 此處 。 |
| 工作區變數 | wsv_Client Secret |
您可以前往使用者設定檔中的「安全性」索引標籤，然後按一下授予旁邊的「動作」下拉式清單中的「重新產生」選項，以檢視您的 API 授與密碼。 有關 Workiva API 的更多說明，請參閱 此處 |
| 工作區變數 | wsv_API 基本 URL - Wdata |
根據您所在的地區輸入 API 的基本 URL： |
執行階段輸入項
配置模板
此範本由兩個鏈結組成，即 0.0 Execute a Query | [] 0.0 Execute a Query |頂層 Orchestration和 0.1 執行查詢| []下載結果。在工作區中部署主要鏈結時，鏈結鏈會自動隨其部署。
- 頂層協調流程：根據控制工作表中的資訊，此鏈結決定查詢是使用單一參數類型（ 挑選清單 或 多選）還是使用多個參數類型（ 挑選清單 和 多選清單皆為）。
- 執行查詢| [] 執行查詢下載結果： 此鏈結使用指定參數執行查詢並擷取相應的資料。查詢執行後，將以 CSV 格式下載結果，以供進一步分析或使用。
設定 控制工作表 並在工作區中部署 鏈結範本 後，您只需控制工作表的 試算表 ID 和 工作表 ID 即可。
必須將這些值新增為 頂層業務流程鏈的 [] 執行階段輸入 。
依參數類型列出的控製表組態
配置控制工作表的方式取決於 Wdata 查詢中定義的參數類型。如果查詢包含 多個參數類型 （例如， 挑選清單 和 多選） ，則必須使用查詢 ID。如果查詢僅使用 一種參數類型，則控制工作表需要該查詢 有單一資料列 。
以下範例說明了這兩種情形。
範例：具有多種參數類型的查詢
對於需要 挑選清單 和 多選 參數的查詢，控制工作表應為每個參數包含 單獨的資料列，且全部使用 相同的查詢 ID。
注意： 索引鍵 資料欄是指在 Wdata 查詢中定義的 參數名稱 。
配置範例：
| 查詢 ID | 類型 | 索引鍵 | 值 |
|---|---|---|---|
| Wdata 查詢 ID | 挑選清單參數 | 年 | 指定單一預設值 (例如 2023)。 |
| Wdata 查詢 ID | 多選參數 | 帳戶類型 | 輸入多個可接受的值，並以逗號分隔（例如， Asset, Expense, Equity, Revenue）。 |
範例：具有單一參數類型的查詢
對於僅使用 一個參數類型的查詢，控制工作表應包含該查詢 ID 的單一資料列 。
例如，如果查詢僅使用 挑選清單 參數：
| 查詢 ID | 類型 | 索引鍵 | 值 |
|---|---|---|---|
| Wdata 查詢 ID | 挑選清單參數 | 年 | 指定單一預設值 (例如 一月)。 |
確保控制工作表設定正確，因為不正確的設定可能會導致下游問題。
正在將資料載入表格
您可以自動將輸出成果直接載入表格的流程。若要將輸出資料載入表格，請考慮使用 "Load Data to Wdata" 範本。這可以透過在下載結果的 HTTP 連接器新增 執行鏈結事件 作為流程的一部分來觸發。
疑難排解
查看您的鏈運行歷史，包括錯誤：
- 移至 Chain Builder 中的Monitor 標籤。
-
將滑鼠移至問號上，檢視鏈執行的狀態。
如果您的鏈結觸發錯誤或下載查詢結果失敗，請執行以下檢查：
- 驗證是否已將兩個鏈結髮佈到您的工作區。每個連鎖必須單獨發佈。
- 確保 Wdata 中的查詢已更新至最新版本。
- 在輸入 查詢 ID、控制工作表 中的 類型、索引鍵和值時，請確保已輸入整個 ID，並且開頭或結尾沒有空格。此外，請確認索引鍵和值是否與 Wdata 中使用的參數正確相符。
- 確保與 Workiva 連結關聯的 OAuth2 授予 具有適當的存取權。
- 請確保查詢中使用的所有參數都包含在控制工作表中。
其他資源
- 工作區連接器
- 檔案公用程式連接器
- JSON 連接器
- 表格轉換連接器
- 在另一個連鎖中執行連鎖 ("Run Chain events")
- OAuth2 授與
- Wdata 功能和 API 限制