簡介
Data Dictionary Chain 範本可讓使用者擷取工作區中特定資料表的高階詳細資料，並將其匯出至電子表格。用戶可以指定關鍵字來查找表，定義匯出電子表格的名稱，並在工作區中創建一個表來存儲每個表的模式。
如需更多詳細資訊，請參閱Load Data to Wdata Process 上的說明文件，以獲得全面的概覽。建議在使用資料詞典範本前先檢閱此文件 。
必要條件
此模板假定以下对象已在您的 Workiva 应用程序中设置：
- API 授與
- 為了充分利用 Workiva API，用戶必須在其工作區中建立OAuth API Grant 。有關管理 OAuth Grant 的主要實務，請參閱本文 。
- 您的工作區必須啟用和設定下列Connectors ：
注意：某些變量值可能包含敏感資訊，如用戶名和密碼。我們建議對資訊敏感的變數使用「加密」選項 ，並為您的試算表設定適當的權限 。
- 設定變數
- 為了讓Load Data to Wdata 子鏈 在範本中發揮預期功能，必須建立工作區 變數，名為wsv-WdataLoadWarningThreshold 。
註記: 最佳做法是將此變數的預設值設定為 50 (代表 50MB)，不過必要時也可以調整。
-
- 此外，在使用資料詞典鏈之前，還必須建立其他四個工作區變數。
以下是需要設定和填入的每個變數的明細表：
| 變數 | 價值 | 描述 |
|---|---|---|
| wsv-WdataLoadWarningThreshold | 建議：50 MB | 設定連鎖會標記超過此檔案大小的資料集的臨界值。 |
| wsv_Client ID | 源自使用者的 API 授權 | 在建立 API 授權後填入。 |
| wsv_Client Secret | 源自使用者的 API 授權 | 在建立 API 授權後填入。 |
| wsv-IAMBaseURL | https://api.app.wdesk.com/iam/v1 |
Workiva IAM API 的基本 URL。 註： 基本 URL 取決於整合使用者的位置。 |
| wsv-PlatformBaseURL | https://api.app.wdesk.com/platform/v1 |
Workiva 平台 API 的基本 URL。 註： 基本 URL 取決於整合使用者的位置。 |
建立您的鏈
Data Dictionary | ALL | PrimaryChain 模板位於 Templates 畫面的 Workiva Chain 區段。
以下是如何找到它：
- 在Chain Builder 中，转到Templates 选项卡。
- 從上方功能表選擇Workiva Chains
- 在右上方搜尋Data Dictionary | ALL | Primary Chain Template 並開啟該範本
當Data Dictionary | ALL | Primary chain 部署到工作區時，它會自動部署另外六個子鏈。
使用者必須確保所有七個鏈都已部署並發佈到相同的工作區：
- 資料辭典 | 全部 | 主要
- 資料辭典 | 建立文件和子節段 | 建立試算表
- 資料辭典 | 建立文件和子節段 | 建立工作表
- 資料辭典 | 建立表
- 載入資料至 Wdata | 主鏈路
- 載入資料至 Wdata | 取代資料集
- 載入資料到 Wdata | 新增資料集
找到模板後，，使用上述章節中建立的變數為您的工作區配置 ， 。
備註： 有關從範本建立鏈的詳細說明，請參閱Create and manage chains 文章。
運行時間輸入
執行此主鏈 (Data Dictionary | ALL | Primary) 時，需要填入下列運行時間輸入，或透過呼叫鏈傳送下列運行時間輸入：
| 運行時間輸入 | 描述 | 欄位類型 | 必要 |
|---|---|---|---|
| SpreadsheetName | 指定要寫入表模式的電子表格名稱。 | 文字 | 是 |
| 搜尋值 | 此輸入用於找出包含指定關鍵字的資料表。 | 文字 | 是 |
| Wdata 資料表名稱 | 指定初始模板執行時建立的資料辭典表的名稱。 | 文字 | 是 |
Wdata 資料表
要使用此鏈，工作區中必須存在資料辭典 Wdata 表。除非用戶指定不同的表名稱，否則連鎖會使用命名慣例 「資料辭典表 」自動建立此表。
以下表模式將用於建立資料辭典表：
| 資料欄名稱 | 欄位說明 | 資料欄 ID | 資料欄類型 |
|---|---|---|---|
| Table_Name | 不適用 | table_name | 文字 |
| 別名 | 不適用 | 別名 | 文字 |
| 模式 | 不適用 | 模式 | 文字 |
| 名稱 | 不適用 | 名稱 | 文字 |
| 類型 | 不適用 | 類型 | 文字 |
自訂調整免責聲明： 如果使用者在將資料匯入 Wdata 表格時，遇到欄頭不匹配的問題，可以利用資料預覽或其他指令來修正。但是，如果用戶在此模板上添加任何自定義的調整，建議他們在這樣做之前先複製一份。對模板的任何變更都會妨礙其重用性。如果對模板套用標籤配置 ，這也適用。
疑難排解
以下步驟可用於排解鏈模板的問題：
鏈執行錯誤
- 確認已發佈所有連鎖。
- 確保 OAuth2 認證 (
wsv-Client IDandwsv-Client Secret) 是有效且最新的。 - 檢查執行連鎖的使用者的工作區權限。
資料匯入錯誤
- 確認來源檔案中的列標頭與 Wdata 資料表的模式相符。
- 對於 Replace Dataset 作業，請確保檔案名稱與資料表中的現有資料集相符。
- 對於新增資料集作業，請確定檔案名稱在資料表中是唯一的。
建立重複的資料表或試算表
-
Wdata Table Name和SpreadsheetName在各次運行中使用一致的名稱。
監視螢幕
- 使用者可透過瀏覽監視螢幕來診斷錯誤的原因。
- DCV_Chain 結果變數會根據最終結果來擷取鏈的狀態。如果發生錯誤，它會將失敗原因套用到監視螢幕中鏈的輸出文字。
用戶還可以使用監視螢幕來確定其檔案是否已成功匯入。
最佳做法
-
避免自訂原始範本:
如果需要調整，請建立複本。變更模板可能會妨礙重用性。 -
為增強上下文新增標籤:
必要時，新增運行時輸入 (Tag-Key和Tag-Value) 至標籤資料集。更新鏈結點以傳遞這些輸入。 -
檔案大小管理:
使用wsv-WdataLoadWarningThreshold變數監控資料集大小。如果觸發警告，請考慮分割大型資料集。