GroundRunners 可讓連鎖指令與內部系統或無法透過網際網路存取的遠端資料來源互動。GroundRunner 通常由 IT 專業人員或熟悉貴機構網路設定的人員安裝在專用伺服器上,例如承載連接資料來源的伺服器。
在設定 GroundRunner 之前,建議先檢閱Chain Builder 安全架構 。
要求
需要相容的作業系統,如果您的 GroundRunner 要存取 Windows 通用命名規則 (UNC) 路徑等共用資源,則也需要具有足夠權限的使用者帳戶。
在初始化安裝 GroundRunner 時,GroundRunner 並未安裝 Java Runtime Environment (JRE)。
設定完成且 GroundRunner 開始執行後,會根據需要自動下載 JRE,以執行依賴於 Java 的命令。不需要安裝或管理員介入,且擷取的 JRE 不會影響主機上已有的 JRE 安裝。
另外,如果您有組織需求,需要使用特定的 JRE,也可將 SHARED_LIBRARY_OVERRIDES 環境變數設定為指向系統安裝。在這種情況下,GroundRunner 將不會自動下載 Workiva 標準 JRE,而會使用所提供者的系統 JRE 安裝。
Workiva 提供的 JRE 採用 GPL v2 授權,並受classpath exception 涵蓋。
附註: 若要在 Java 安裝中使用自訂憑證,請參閱使用 GroundRunners 的自訂憑證 。
角色要求
在 Workiva 平台上
在 Workiva 平台上,您需要的角色可以授予鏈結產生器設定的存取權和管理執行器的能力。有兩種:
- 鏈結擁有者: 這是所需的主要角色。具有此角色的使用者可以存取鏈結產生器中的「下載」區段,以擷取最新的 GroundRunner 安裝檔案並管理「Runners」索引標籤以啟動或監控服務。
- 組織鏈結安全性管理員: 此組織層級角色還有跨多個工作區管理連線和執行器的權限。
伺服器上
因為「手動更新」涉及停止服務並取代安裝 GroundRunner 的實體或虛擬機器上的可執行檔案,所以使用者必須具有主機伺服器的管理權限。
- Windows: 您必須能夠以管理員身分執行命令提示字元並存取 Windows 服務管理員(才能停止並重新啟動 GroundRunner 服務)。
- Linux/macOS: 您必須具有 sudo 或 root 存取權,才能將檔案移入安裝目錄並重新啟動後台進程。
下載 GroundRunner
若要下載 GroundRunner 以安裝或手動更新:
- 在 Workiva 首頁側邊欄上,點選Chains(自動化工作流程) 。
- 在 Chains(自動化工作流程)建立器側邊(這是一個新的標籤),點擊 Connections 。
或者,您可以按一下右上角的使用者設定檔圖示,選取 鏈結 admin,然後選取 Workplace Settings。 - 按一下上方功能表長條圖中的Downloads 。
- 尋找適用於您作業系統的 GroundRunner,並點選下載 。
- 一旦成功下載至您的電腦,請從下列設定中選取適當的指示,並依照指示安裝 GroundRunner。
安裝 GroundRunner
Microsoft 安裝程式 (MSI) 需要 .NET 3.5 或更高版本。
如果無法滿足此要求,則必須改用命令列介面安裝 GroundRunner。
安裝 GroundRunner:
- 解壓縮GroundRunner.zip 到新的資料夾,並開啟資料夾。
- 執行 GroundRunner.msi 以開啟 GroundRunner 設定精靈。
- 按一下「繼續」(Next)。
- 查看並接受授權協議中的條款,然後按 [下一步]。
- 對於「目的地資料夾」(Destination Folder),輸入將要安裝 GroundRunner 的路徑(例如:
C:\Program Files\GroundRunner\),然後按一下 Next。 - 在 Platform company token中,輸入您的 company token。
- 在 [平台授權主機] 中:
- 對於亞太地區,請輸入
h.apac.wdesk.com/s/chains-reaper。 - 對於加拿大,請輸入
h.ca.wdesk.com/s/chains-reaper。 - 對於 EMEA,請輸入
h.eu.wdesk.com/s/chains-reaper。 - 對於美國、中美洲和南美洲,請輸入
h.app.wdesk.com/s/chains-reaper。
- 對於亞太地區,請輸入
- 如果使用 Proxy 伺服器,請在 Proxy host中輸入其 URL 和連接埠。
(例如http://yourproxy:3000。)
若要略過 Proxy 伺服器,請在 No proxy host 下輸入以逗號分隔的主機清單。 - 依序按 [下一步]、[安裝] 及 [完成]。
- 安裝後,從 Windows Service Manager 中對 GroundRunner 按一下右鍵,然後選取 Start。
您的 GroundRunner 現在已經安裝完成,可以進行啟動。
若要透過命令列介面安裝,您必須將 GroundRunner 的安裝程式下載到程式檔案中自己的目錄中(例如 c:\Program Files (x86)\wdata)。然後,您可以解壓縮安裝檔案並將其解壓縮到該目錄的根目錄。
然後,您可以安裝 GroundRunner:
-
在 Windows 命令視窗中,輸入
c:\Program Files (x86)\wdata\installer.exe install並接受所有預設值。
-
為 init 系統選取「Windows」。
您需要指定 GroundRunner 作為 Windows 服務運作,才能支援自動更新。GroundRunners 應僅當成服務執行,測試用途除外。
- 對於路徑,請在新目錄
內建立 Files 資料夾(例如C:\Program Files (x86)\Wdata\Files)。 - 對於授權主機名稱 (AUTH_HOST):
- 對於亞太地區,請輸入
h.apac.wdesk.com/s/chains-reaper。 - 對於加拿大,請輸入
h.ca.wdesk.com/s/chains-reaper。 - 對於 EMEA,請輸入
h.eu.wdesk.com/s/chains-reaper。 - 對於美國、中美洲和南美洲,請輸入
h.app.wdesk.com/s/chains-reaper。
- 對於亞太地區,請輸入
- 輸入您的 公司代碼。
-
- 從目錄中刪除 GroundRunner 可執行檔目錄以外的所有檔案。
- 選取將 GroundRunner 當成服務或前景流程執行。
- 如果以服務方式執行,請執行下列其中一項:
- 在命令對話方塊中,輸入
sc start GroundRunner。 - 在 Windows Service Manager 中,啟動 GroundRunner服務。
- 在命令對話方塊中,輸入
-
如果當做前景流程執行,請在命令對話方塊中輸入:
cd c:\Program Files (x86)\wdata GroundRunner.exe
- 如果以服務方式執行,請執行下列其中一項:
您的 GroundRunner 現在已安裝完畢並可以啟動。
步驟 1. 安裝 GroundRunner
-
將 GroundRunner 的安裝檔案下載到自己的目錄,
例如:/home/user_name/wdata/。注意: 「/home/user_name/wdata」僅作為範例。請遵循組織的服務安裝位置政策。
-
在命令對話方塊中,使用以下命令解壓縮安裝檔案:
解壓縮 GroundRunner.zip - 輸入 GroundRunner 的詳細資料。
- 輸入
./installer install - 對於授權主機名稱 (AUTH_HOST):
- 對於亞太地區,請輸入
h.apac.wdesk.com/s/chains-reaper。 - 對於加拿大,請輸入
h.ca.wdesk.com/s/chains-reaper。 - 對於 EMEA,請輸入
h.eu.wdesk.com/s/chains-reaper。 - 對於美國、中美洲和南美洲,請輸入
h.app.wdesk.com/s/chains-reaper。
- 對於亞太地區,請輸入
- 輸入您的 公司代碼。
- 輸入
- 請從目錄中刪除所有檔案,但在安裝過程中建立的資料夾除外。
步驟 2. 將您的 GroundRunner 設定為 systemd 服務 (Linux)
為了確保 GroundRunner 自動更新正常運作,並為了讓 GroundRunner 保持良好狀態,需要將 GroundRunner 安裝為啟用、可重新啟動的 systemd 服務。請參閱作業系統的文件和組織政策,了解如何將 GroundRunner 作為 systemd 服務執行。
對於基本配置,為了使自動更新正常工作,我們有以下 systemd 單元檔案要求:
- 確保
ExecStart可執行檔指向GroundRunnerMonitor二進製文件,而不是GroundRunner二進製文件。 - 設定
Restart=always。 - 請勿設定
StartLimitBurst或StartLimitIntervalSec,否則可能會因為暫時性錯誤而導致 GroundRunner 無法重新啟動。如果您不希望 GroundRunner 進入快速重新啟動循環,您可以設定RestartSec。 - 輸入
systemctl enable以啟用 systemd GroundRunner 服務單位,以便 GroundRunner 在重新啟動後也能正常使用。
Workiva 不正式支援將 GroundRunner 當成前景流程執行。這對於測試設定可能很有用,但一旦設定 GroundRunner,就應將其設定為長期存在的後台流程。
在 macOS 上操作 GroundRunners(僅限測試)
Workiva 在 macOS 上支援 GroundRunners,僅用於測試目的。雖然 macOS GroundRunner 能夠執行與 Linux 和 Windows 版本相同的命令,但 Workiva 並未正式支援將 Launchd 作為有效的服務管理員。這是因為 Apple 在 2022 年中止了對其 macOS 伺服器軟體的支援。Apple 膝上型電腦和桌上型電腦不適合執行 GroundRunners。
啟動 GroundRunner
安裝 GroundRunner 後,您必須在 Chain Builder 中啟用它。
- 在 Chains(自動化工作流程)鏈結建立器側欄上,點擊 Connections 。
- 按一下頂端的Runners ,然後按一下Pending Registration 。
- 輸入 Runner 的簡短描述性名稱。
例如「<datasource> -GroundRunner」。 - 按一下 [啟動]。
GR 設定檢查清單
- 您是否執行
GroundRunnerMonitor可執行檔(而不是GroundRunner可執行檔)? - 您是否已將
GroundRunnerMonitor設定為系統層級可重新啟動的服務?- 對於 Linux:
Systemd。 - 對於 Windows:
Windows 服務。
- 對於 Linux:
- 您的服務會在系統重新開機時重新開機嗎?
- 在 Linux 上:
systemctl enable。 - 在 Windows 上:「啟動類型」設定為
自動。
- 在 Linux 上:
- 您是否在受支援的伺服器作業系統上執行?
- 您是否啟用 GroundRunner 通知?
手動更新 GroundRunner
雖然很少需要,但您可能需要手動升級 GroundRunner。
有關如何執行此操作的說明,請參閱 Workiva 支援頁面 GroundRunner 手動更新 。
解除安裝 GroundRunner
如果您不再需要 GroundRunner,可以將其解除安裝。
- 停止 GroundRunner 服務:
- 如果是當成服務執行,請使用 Windows Service Manager,或在命令視窗中輸入
sc stop GroundRunner。 - 如果它作為前景流程執行,請按 Ctrl+C。
- 如果是當成服務執行,請使用 Windows Service Manager,或在命令視窗中輸入
- 在命令對話方塊中,以管理員身分輸入
installer.exe uninstall。 - 刪除
GroundRunner可執行檔目錄。
在命令對話方塊中停止 GroundRunner 服務並刪除其可執行檔目錄 (例如 /home/<username> /wdata/Contents)。
安裝自訂的 JRE
如果需要,您可以安裝自己的 JRE 來支援 GroundRunner。此 JRE 的 Java 版本必須與 Groundrunner 所需的版本相符。除了Oracle Essbase 和Oracle Hyperion Financial Management (HFM) GroundRunners 之外,所有 GroundRunners 使用相同的 JRE 版本。
有關如何安裝自訂 JRE 的資訊,請參閱 停用 Workiva 共享程式庫。
GroundRunner 組態設定與外寄網域
若要能與其資料來源通訊,您可能必須在安裝 GroundRunner 的伺服器上開啟防火牆連接埠。若要變更部分 GroundRunner 的組態設定,您可以在安裝二進位檔案的目錄中編輯 GroundRunner.config 檔案。
| 組態 | 設定 |
|---|---|
| 連接埠 |
0 到 65535。 GroundRunner 預設使用連接埠 8821 彼此通訊。但只在不同伺服器上的 GroundRunner 在網路內共用命令輸出時,才需要連接埠。 |
| COMPANY_TOKEN | 保留預設,除非為不同租用戶配置 GroundRunner |
| LOG_LEVEL | info 或 debug |
| PROTOCOL | 保留預設 |
| HTTP_PROXY_URL |
如果使用代理伺服器,請輸入其 URL 和連接埠(如有必要)。 注意:GroundRunner 可以使用 Proxy 伺服器,但不能使用透過 New Technology LAN Manager (NTLM) 驗證的伺服器。請輸入伺服器的 IP 位址。 |
| LONG_POLL | 如果使用 Proxy 伺服器,請設定為 true,指示執行器使用長輪詢來擷取命令。為了確保效能,請只在 Proxy 伺服器或防火牆不支援 Web 通訊端時,使用長輪詢。 |
| NO_PROXY | 若要略過 Proxy 伺服器,請改為提供以逗號分隔的主機清單,直接連線。若要根據通用模式加入多個主機, 請使用 * 萬用字元。 |
| GROUNDRUNNER_CERT |
使用多個 GroundRunner,並希望將加密的資訊傳送給第二個 GroundRunner 時需要。這必須與PORT 一起使用。 啟動執行器時,也必須將 PROTOCOL 欄位指定為 HTTPS。 |
| GROUNDRUNNER_CERT_KEY | 使用多個 GroundRunner,並希望接收來自第二個 GroundRunner 的加密資訊時需要。此功能還必須與PORT 一起使用。 |
| DISABLE_WEBSOCKETS | 執行轉換需要使用 Websockets。如果停用,任何使用轉換的指令都會完全跳過。 |
註: 您的自簽憑證必須有一個主題替代名稱 (SAN)。如果沒有,GroundRunner 嘗試下載檔案時,會顯示一則錯誤訊息,指出遺漏 SAN。
如果您的網路必須允許外寄網域,下列網域適用於 GroundRunner:
| 網域 | 目的 |
|---|---|
|
|
常見 Wokiva 服務的主要子網域,包含 Wdata |
*.wdesk.com |
實際執行 Workiva 平台的主要網域 |
*.*.wdesk.com |
Workiva 平台中支援組件的子網域 |
安全性
注意:GroundRunner 絕不收集或彙總資料,僅在傳輸過程中保留資料。擴充功能驗證 (EV) 憑證一律透過 DigiCert®,加密和保護 GroundRunner 與其資料來源之間的流量。
注意: 要保護內部部署資料的安全,CloudRunners 可以與 GroundRunners 共用輸出,但 GroundRunners 無法與 CloudRunner 共用檔案輸出。
疑難排解 GroundRunner 錯誤
如果在鏈結執行時收到這些錯誤,請檢查命令的 GroundRunner:
提示:為了協助簡化疑難排解,您可以建立鏈結,自動下載 GroundRunner 的記錄檔案至表格中。
| 錯誤訊息 | 原因 | 解決方法 |
|---|---|---|
| 與代理程式通訊失敗,未執行此命令 |
此命令無法與其 GroundRunner 通訊。 如果發生這種情況,GroundRunner 不會啟動,或者 GroundRunner 和鏈結產生器之間網路會中斷。 |
請確認:
|
| 無法下載與命令相關聯的資源。如果仍發生錯誤,請聯絡支援人員。 |
與這些命令鏈相關的運行程序無法相互溝通。 當命令使用不同的執行器,而 CloudRunner 嘗試使用來自 GroundRunner 的命令的檔案輸出時,通常會發生這種情況。 |
連鎖中的所有指令使用相同的執行器。 如果鏈中的命令需要多個運行程序,請驗證沒有使用 GroundRunners 的命令將檔案輸出傳給使用 CloudRunner 的命令。 |
啟動命令時出現錯誤:exec: \"\\[connector].exe\": file does not exist" commandExecutorId=[ID] |
惡意軟體或防毒應用程式錯誤辨識連接器,並攔截其與 GroundRunner 的通訊。 | 從應用程式的掃描中排除 GroundRunner 安裝目錄。 |
| 憑證錯誤 | 使用自我簽署憑證 |
在許多情況下,使用自我簽署憑證加密 GroundRunner 通訊很方便。如果使用自我簽署憑證,請確保憑證的通用名稱與可存取伺服器的 URL 相符。 舉例來說,如果您的 GroundRunner 正在偵聽連接埠 8821,且您可以從網路 localhost |
| 間歇性鏈結失敗並顯示錯誤: 「同儕重設連線」 |
在相同電腦上安裝多個執行器時,每個執行器都需有不重複的 GUID。 如果使用相同 GUID,執行器可能會重複並進入更新循環,導致偶爾鏈結失敗。 |
建議完全重新安裝 GroundRunner。 |
| 在 GroundRunner 上跳過指令,但在 CloudRunner 上成功 | 執行轉換需要使用 Websockets。停用 websockets 後,任何轉換都會完全跳過。 | 開啟您的設定檔,並設定DISABLE_WEBSOCKETS=false 。 |
從套接字讀取錯誤。重試連線: read tcp<IP>:<Port>-><IP>:<Port>: wsarecv:連線嘗試失敗,原因是連線方在一段時間/週期後沒有正確回應,或建立的連線失敗,原因是連線主機沒有回應。 |
內部防火牆或網路問題 | 請您的內部 IT 或網路團隊審閱記錄/審核組態,以解決錯誤。 |
讀取<IP>:<Port>-><IP>:<Port>:wsarecv:現有連線被遠端主機強制關閉 |
內部防火牆或網路問題 | 請您的內部 IT 或網路團隊審閱記錄/審核組態,以解決錯誤。 |