概觀

領先的實踐系列概述了 Workiva 平台中數據管理套件中各種工件的推薦通用實踐。請記住，這些是一般準則，可能需要根據特定的獨特用例進行調整。這些建議旨在幫助用戶改進其工作區中的組織。讓我們從探索這些命名約定開始。

連接、鏈和環境的命名約定

 

鏈中的連接

在鏈中創建連接時，必須建立最佳命名約定，以確保環境之間的清晰度和區別：

• 連接器名稱： 為連接器提供一個描述性名稱，以清楚地指示其用途和功能。
• * 工作區類型 * ： 指定使用 Connector 的工作區或專案。
• 連接器的環境： 清楚地標識連接器對應的環境（例如，開發、生產）。

例：

• SFTP 連接 |美國證券交易委員會報告 |非農產品
  • 描述： 在非生產環境（如開發、QA、沙盒等）中為 SEC 報告工作區解決方案建立與 SFTP 伺服器的連接。
• SFTP 連接 |美國證券交易委員會報告 |刺
  • 描述： 在生產環境中建立與 SFTP 伺服器的連接，以實現 SEC 報告工作區解決方案。

此命名約定有助於輕鬆識別和管理不同環境中的連接。它確保特定環境中的鏈僅與適當的源交互，從而增強安全性和可靠性。非 Prod 連接將能夠在非 Prod、Dev 和 UAT 環境中利用。

此命名約定做法應一致地應用於所有連接，無論它們是核心連接器還是高級連接器。通過在不同環境中保持連接命名的一致性，您可以簡化鏈升級過程，並實現跨工作區無縫執行鏈。

鏈結產生器

在Workiva平臺中構建鏈時，保持組織良好的命名規則至關重要。清晰一致的命名策略有助於更有效地導航鏈，尤其是在工作流數量增長的情況下。本節概述了根據鏈的用途、源系統、頻率和工作流層次結構命名鏈的領先實踐。

目的和源系統

確定鏈的目的

考慮以下問題來定義鏈的目的：

• 鏈內正在使用哪些類型的數據？
• 該鏈是否可以在多個進程中使用（即，它是否是實用程序鏈）？
• 使用哪個源系統從中提取數據？

頻率

指定鏈的頻率

在命名鏈時，必須指出其頻率，特別是如果它被安排為自動運行。請遵循以下準則：

• 指示鏈是否要臨時運行。
• 指定鏈是每天、每周、每季度還是每年運行。

階層圖

組織複雜的鏈構建

在由多個工作流組成的鏈構建中，通常有一個頂級鏈，其中多個子鏈按順序執行。通過在它們前面加上編號的命名約定來組織這些鏈。

編號命名約定的範例：

1.0 頂層鏈
1.1 執行數據集
1.2 載入數據到Wdata表
1.3 刷新傳入連接

這種方法可幫助使用者快速識別工作流中的操作順序，並根據數位順序自動組織工作區內的鏈。

鏈命名約定的實際示例

公用事業鏈

實用程式鏈是由多個其他工作流執行的常見工作流，例如 將數據載入到 Wdata 表中。為確保實用程式鏈突出顯示在工作區的頂部，請考慮以下命名約定：

0.0 - [公用事業鏈名稱] |[流程] |實用程序鏈

0.1 - [實用程序鏈名稱] |[流程] |工具鏈

0.2 - [工具鏈名稱] |[流程] |公用事業鏈

源系統

術語「源系統」是指數據的來源，可以包括各種系統，如ERP（企業資源規劃）、EPM（企業績效管理）、HR（人力資源）和會計系統，也可以是基於檔，如來自SFTP/FTP的數據。

以下示例以示例演示了三個源系統的組織：

1. 工作日

   • 1.0 - [鏈名稱/進程] |工作日 |[頻率]
   • 1.1 - [鏈名稱/進程] |工作日 |[頻率]
   • 1.2 - [鏈名稱/進程] |工作日 |[頻率]

2. 樹液

   • 2.0 - [鏈名稱/進程] |蘋果公司 |[頻率]
   • 2.1 - [鏈名稱/進程] |蘋果公司 |[頻率]
   • 2.2 - [鏈名稱/進程] |蘋果公司 |[頻率]

3. Netsuite的

   • 3.0 - [鏈名稱/進程] |Netsuite（網路套件） |[頻率]
   • 3.1 - [鏈名稱/進程] |Netsuite（網路套件） |[頻率]
   • 3.2 - [鏈名稱/進程] |Netsuite（網路套件） |[頻率]

對於具有大量鏈的工作區，為了清晰和組織起見，請使用以下命名約定範例：

這種結構確保了清晰、一致的命名約定和組織，從而更容易根據其過程和執行頻率識別和管理實用程式鏈和源系統鏈。

環境命名約定

環境使團隊能夠毫不費力地規劃、測試和部署工作流。此功能簡化了軟體開發生命週期 （SDLC） 最佳實踐在自動化流程中的應用。創建環境時，請使用以下簡化的命名約定來清楚地標識每個 環境的用途。這有助於使用者快速瞭解每個環境的預期用途。

環境類型和命名約定

1. DEV（開發）

   • 用途：用於開發新的鏈條和流程。構建者可以安全地在開發 （DEV） 環境中創建和試驗。

   • 示例： DEV

2. UAT（使用者驗收測試）或沙箱

   • 目的：致力於測試和QA過程。QA 團隊可以在使用者驗收測試 （UAT） 環境中進行審查和測試。
   • 示例： NON-PROD

3. PROD（生產）

   • 用途：適用於已經過測試、優化並準備好在生產 （PROD） 環境中部署的流程。 
   • 示例： PROD

注意：多個鏈可以具有相同的名稱，但每個鏈都通過稱為 GUID 的唯一標識符 進行區分

總結

使用這些簡化的命名約定有助於維護結構化且易於導航的環境設置。它確保每個環境的目的都很明確，從而在開發、測試和部署階段減少混淆並提高效率。