為了使鏈結中的命令能夠與本機遠端資料來源互動,IT 管理員或熟悉您組織的網路和防火牆設定的人員可以在專屬伺服器 (例如託管連結資料來源的位置) 上安裝和設定 GroundRunner。將命令新增到鏈結時,您可以將其連結指派給 GroundRunner 以便在資料源中執行任務。
提示:為協助疑難排解,您可以建立一鏈結以自動將 GroundRunner 的記錄檔案下載到表格中。
先決條件
GroundRunners 支援指定的作業系統,且需要:
- Java® 第 8 版或更高版本
- 有限的伺服器資源
若要存取諸如 Windows 通用命名約定 (UNC) 路徑之類的共享資源,GroundRunner 還需要具有足夠資源特權的使用者帳戶。
Java
如有必要,請從 Oracle® 或 OpenJDK 下載 Java,並安裝在路徑變數中,進而透過命令提示中的 java
啟用全域存取。完成安裝 Java 或編輯其配置後,請重新啟動服務器。
注意:安裝 Java 時,可能會詢問您是否要安裝 Java 的開發工具包 (JDK) 或 Java 執行時間環境 (JRE)。GroundRunners 僅需要 JRE。
如果使用自簽署憑證或非憑證頒發機構頒發的憑證,請匯入 Java Keystore 以啟用 Java/SSL 安全性:
- 向 IT 管理員取得用於保護站點的憑證副本,或從瀏覽器匯出。
- 將憑證複製到您的 GroundRunner 安裝中。
- 在您的 CLI 中,將憑證匯入您的 Java Keystore。例如:
keytool -import -trustcacerts -keystore "C:\Program Files\Java\jre1.8.0_251\lib\security\cacerts" -storepass changeit -noprompt -alias [alias name] -file [path_to_exported_file]
系統需求
GroundRunners 支援以下作業系統,無需外部函式庫相依性:
- Microsoft Windows® Desktop 10、32 和 64 位元
- Microsoft Windows® Server 2012、2012 R2、2016 和 2019
- Linux® Redhat 和 Ubuntu
- macOS® Mojave 或更高版本
雖然 GroundRunners 需要有限的伺服器資源,但我們建議至少使用:
- 512MB 可用隨機存取記憶體 (RAM)
- 100GB 可用磁碟空間
注意:以下資訊可供您協助您計算必要的磁碟空間:一個包含五個命令,且每個皆產生 10MB 暫時輸出內容的鏈結需要使用 50MB 的空間才能完成。
建議的託管主機配置包含採用以下配置的虛擬主機:
- 二到四個處理器
- 8GB 系統記憶體
- 固態硬碟(SSD)儲存裝置
注意: GroundRunners絕不收集或匯總數據。它們僅在傳輸期間保留數據。擴展驗證(EV)證書始終通過DigiCert®加密和保護GroundRunner及其數據源之間的流量。
使用者帳戶
預設情況下,GroundRunners 使用本地管理帳戶,對共享驅動器等遠端資源的存取權限不足。要存取諸如 Windows UNC 路徑之類的共享資源,請在具有足夠資源特權的使用者帳戶下啟動 GroundRunner。如果使用預設本地系統管理員以外的使用者帳戶,授予其管理 GroundRunner 安裝目錄的權限,以啟用自動更新。
下載 GroundRunners
若要下載 GroundRunner 以便安裝或手動更新:
- 從 Chains 按一下 Chain Builder。
- 在 Chain Builder 中,從 Admin
- 找到適用您作業系統的 GroundRunner,然後按一下「下載」(Download)。
安裝 GroundRunners
注意:Microsoft Installer (MSI) 需要.NET 3.5或更新版本。如果您不能滿足此要求,請透過命令列介面 (CLI) 安裝 GroundRunner。
步驟1.安裝 GroundRunner
要使用 MSI 為 Microsoft Windows 桌面或具有.NET 3.5 以上版本的 Windows Server 安裝 GroundRunner,請執行以下操作:
- 下載 GroundRunner,並解壓縮
windows_amd64_ground_runner.zip
。 - 若要開啟 GroundRunner 設定精靈,請執行
GroundRunner.msi
,然後按一下「下一步」(Next)。 - 在授權協議中查看並接受條款,然後按一下「下一步」(Next)。
- 在「目的地資料夾」(Destination Folder) 中輸入 GroundRunner 的安裝路徑,例如:
C:\Program Files\GroundRunner\
,然後按一下「下一步」(Next)。 - 在「平台公司代碼」(Platform company token) 中輸入您的公司代碼。
注意:若要在 Chain Builder 中尋找您的公司代碼,請從 Admin
選取 Runners 、Downloads。 - 在「平台授權主機」(Platform auth host) 中:
- 北美地區請輸入
h.app.wdesk.com/s/wdata/oc/app
。 - 歐洲地區請輸入
h.eu.wdesk.com/s/wdata/oc/app
。
- 北美地區請輸入
- 如果使用代理服務器,請執行以下任一操作:
- 若要連接代理伺服器,請在「代理主機」(Proxy host) 中輸入有效的 URL,如有需要也請包含連接埠資訊。範例如下:
http://yourproxy:3000
。 - 若要略過代理伺服器,請在「無代理主機」(No proxy host) 中輸入以逗號分隔的主機清單,以直接連接這些主機。
- 若要連接代理伺服器,請在「代理主機」(Proxy host) 中輸入有效的 URL,如有需要也請包含連接埠資訊。範例如下:
- 按一下「下一步」(Next),「安裝」(Install),然後「完成」(Finish)。如果出現「使用者帳戶控制」(User Account Control) 提示,請按一下「是」(Yes)以 以啟用安裝工具,為您的裝置進行變更。
- 在 Windows 服務管理員中,在 GroundRunner 上按一下右鍵,然後選取「開始」(Start)。
步驟2.啟動 GroundRunner
- 在 Chain Builder 中,從 Admin 選取 Runners。
- 在「待處理註冊」(Pending Registration) 下輸入簡短的 Runner 描述性名稱,例如:
-GroundRunner
- 按一下「啟動」(Activate)。
注意:為確保 GroundRunner 可執行檔的完整性,在軟件開發生命週期中,Windows® 安裝程式可供下載並由 Workiva 版本管理團隊進行加密簽署。
要使用命令列介面 (CLI) 為 Microsoft Desktop 或 Windows Server 安裝GroundRunner,請執行以下操作:
步驟1.下載 GroundRunner
- 將 GroundRunner 的安裝程式下載到「Program Files」中的目錄中,例如:
c:\Program Files (x86)\wdata
。 - 解壓縮安裝檔案,並將其檔案解壓縮到目錄的根目錄:
GroundRunner.exe
GroundRunnerMonitor.exe
installer.exe
步驟2.安裝 GroundRunner
- 以管理員身分從 Windows 命令列介面 (cmed.exe) (CLI) 執行命令:
c:\Program Files (x86)\wdata\installer.exe install
,並接受所有預設設定。- 路徑部分,請在新目錄內建立
「檔案」(Files)
資料夾,例如:C:\Program Files (x86)\Wdata\Files
。如果不存在,請選取建立。 - 授權主機名稱部分(AUTH_HOST):
- 北美地區請輸入
h.app.wdesk.com/s/wdata/oc/app
。 - 歐洲地區請輸入
h.eu.wdesk.com/s/wdata/oc/app
。
- 北美地區請輸入
- 針對公司代碼,請輸入您組織產生的值。
注意:若要在 Chain Builder 中尋找您的公司 ID,請從 Admin
選取 Runners 、Downloads。
- 路徑部分,請在新目錄內建立
- 請從目錄中刪除
GroundRunner
可執行檔目錄之外的所有檔案。 - 選取將 GroundRunner 當成服務或前景流程執行。
- 如果要當成服務,請執行以下任一操作:
- 在 CLI 中,輸入命令
sc start GroundRunner
。 - 在 Windows 服務管理員中,啟動
HostRunner
服務。
- 在 CLI 中,輸入命令
- 如果要當成前台流程,請在 CLI 中輸入以下命令:
cd c:\Program Files (x86)\wdata GroundRunner.exe
- 如果要當成服務,請執行以下任一操作:
步驟3. 啟動 GroundRunner
- 在 Chain Builder 中,從 Admin 選取 Runners。
- 在「待處理註冊」(Pending Registration) 下輸入簡短的 Runner 描述性名稱,例如:
-GroundRunner
- 按一下「啟動」(Activate)。
要在 Linux 或 macOS 上安裝 GroundRunner,請執行以下操作:
步驟1.安裝 GroundRunner
- 將 GroundRunner 的安裝檔案下載到自己的目錄,例如:
/home/<username>/wdata/
。 - 在命令列介面 (CLI) 中解壓縮安裝檔案:
- 若為 Linux,使用命令
unzip linux_amd64_ground_runner.zip
。 - 若為 macOS,使用命令
unzip darwin_amd64_ground_runner.zip
。
- 若為 Linux,使用命令
- 輸入命令
./installer install
,並輸入 GroundRunner 的詳細資料:
- 授權主機名稱部分(AUTH_HOST):
- 北美地區請輸入
h.app.wdesk.com/s/wdata/oc/app
。 - 歐洲地區請輸入
h.eu.wdesk.com/s/wdata/oc/app
。
- 北美地區請輸入
- 針對公司代碼,請輸入您組織產生的值。
注意:若要在 Chain Builder 中尋找您的公司 ID,請從 Admin
選取 Runners 、Downloads。
- 授權主機名稱部分(AUTH_HOST):
- 請從目錄中刪除
GroundRunner
可執行檔目錄之外的所有檔案。
步驟 2. 選擇要當成服務或前台流程執行
在 CLI 中輸入命令,將 GroundRunner 作為後台服務或前台流程執行:
- 如果從預設的 OS init 程式執行,您可以將其作為後台服務執行。請輸入:
/home/[username]/wdata/Contents/GroundRunnerMonitor
- 若要將其作為前台流程執行,並將記錄寫入控制台,請輸入:
cd home/[username]/wdata/Contents sudo ./GroundRunner
- 若要將其作為前台流程執行,並將記錄寫入記錄檔,請輸入:
cd home/[username]/wdata/Contents sudo ./GroundRunnerMonitor
提示:若要停止將 GroundRunner 作為前台流程執行,請按 CTRL + C。
步驟3. 啟動 GroundRunner
- 在 Chain Builder 中,從 Admin 選取 Runners 。
- 在「待處理註冊」(Pending Registration) 下輸入簡短的 GroundRunner 描述性名稱,例如:
-GroundRunner
- 按一下「啟動」(Activate)。
檢查GroundRunner的狀態
GroundRunner 需要持續不斷與指令交換訊息,以瞭解如何執行工作並獲得任何相關資訊。若 GroundRunner 離線,就無法再回應命令,管理員也會收到警告電子郵件。
若要查看 GroundRunner 的上線/離線狀態,請在 Chain Builder 中按一下 Admin
、Runners ,並查看哪些 Runner 在待處理註冊、已啟用或停用狀態。注意:在網絡中斷的情況下,GroundRunners會自動嘗試重新建立通訊。
要查看主機作業系統的資源狀態,請選取其 顯示狀態。
注意:若要查看 Linux 伺服器上所有有效的 GroundRunner,請在 CLI 中輸入以下命令:ps -a |grep GroundRunner
。
手動更新 GroundRunner
儘管很少見,但您可能需要手動升級 GroundRunner。
下載並安裝最新的 MSI,然後解除安裝任何以前下載的版本。
- 下載適用於您作業系統的最新 GroundRunner。
- 在 Windows 服務管理員中,停止 GroundRunner 服務。
- 將 GroundRunner 的安裝檔案下載到其本身的目錄,例如:
c:\groundrunner_upgrade
,然後解壓縮檔案。 - 請複製並貼上這些未解壓縮的檔案至目錄,也就是 GroundRunner 二進位檔的安裝位置:
GroundRunner.exe
GroundRunnerMonitor.exe
- 在 Windows 服務管理員中,重新啟動 GroundRunner 服務。
- 下載適用於您作業系統的最新 GroundRunner。
- 在託管 GroundRunner 的伺服器上,導覽至執行服務的目錄。
- 在CLI中,停止GroundRunner服務。
- 將 GroundRunner 的安裝檔案下載到其本身的目錄,例如:
/home//groundrunner_upgrade/
,然後解壓縮檔案。 - 請複製並貼上這些未解壓縮的檔案至目錄,也就是 GroundRunner 二進位檔的安裝位置:
GroundRunner
GroundRunnerMonitor
- 要重新啟動GroundRunner服務,請在CLI中輸入以下命令:
cd /home/<使用者名稱>/wdata/Contents
./GroundRunner
設定 GroundRunner 的環境
預設上,您可在所有工作空間與環境中使用 GroundRunners。若要限制只在特定環境內使用 GroundRunner:
- 在 Chain Builder 中,從 Admin
- 在「Runner 限制」(Runner Restrictions) 下取消勾選「全域」(Global),然後選擇要使用 GroundRunner 的工作空間和環境。
- 按一下「儲存」(Save)。
解除安裝 GroundRunner
如果您不再需要 GroundRunner,可以將其解除安裝。
- 停止 GroundRunner 服務:
- 若要當做服務執行,請使用Windows 服務管理員,或在 CLI 中輸入命令:
sc stop GroundRunner
。 - 如果當做前景流程執行,請按下按鍵序列
<ctrl> <c>
。
- 若要當做服務執行,請使用Windows 服務管理員,或在 CLI 中輸入命令:
- 在 CLI 中,以管理員身份輸入命令:
installer.exe uninstall
。 - 刪除
GroundRunner
可執行檔目錄。
在 CLI 中停止 GroundRunner 服務,然後刪除其可執行檔目錄,例如 /home/<username>/wdata/Contents
。
GroundRunner 配置設定與外寄網域
若要啟用與資料源間的通訊,您可能需要開啟安裝 GroundRunner 之伺服器上的防火牆連接埠。若要變更部分 GroundRunner 的配置設定,您可以在安裝二進位檔的目錄內編輯 GroundRunner.config
。
注意:GroundRunners可以使用代理伺服器,但不是透過新技術 LAN 管理員 (NTLM) 進行身份驗證的代理伺服器,反而是將伺服器的 IP 位址加入白名單。
配置 | 設定 |
---|---|
連接埠 |
0 至 65535 。預設上,GroundRunners 會使用 8821 連接埠相互通訊。然而,只有在 Groundrunner 在網路內不同伺服器間分享命令輸出成果時,才需要使用連接埠。 |
COMPANY_TOKEN |
保留預設設定,除非將 GroundRunner 配置為不同租用戶 |
LOG_LEVEL |
info 或 debug
|
PROTOCOL |
保留預設值 |
HTTP_PROXY_URL |
如果使用代理服務器,則使用其有效的 URL,必要時請包含連接埠。例如:http://yourproxy:3000
|
LONG_POLL |
如果使用代理服務器,設定為 true ,以指示 Runner 使用長輪詢來擷取命令。為了確保效能,請僅在代理伺服器或防火牆不支援網路通訊端時使用長輪詢。 |
NO_PROXY |
若要略過代理服務器,請提供以逗號分隔的主機清單,以直接連接這些主機。若要使用採相同模式的多個主機,請使用 * 萬用符號。 |
若您的網路必須允許外寄網域,以下規則適用於 GroundRunner:
網域 | 目的 |
---|---|
|
共用 Wokiva 服務的主要子網域,包含 Wdata |
*.wdesk.com |
製作 Workiva 平台的主要網域 |
*.*.wdesk.com |
在 Workiva 平台中用於支援組件的子網域 |
疑難排解 GroundRunner 的錯誤
如果在鏈執行時收到這些錯誤訊息,請檢查命令的 GroundRunners:
錯誤訊息 | 原因 | 解決方法 |
---|---|---|
與代理通訊失敗——此命令未執行 | 該命令無法與其 GroundRunner 通訊。如果發生這種情況,表示 GroundRunner 未啟動,或者 GroundRunner 和 Chain Builder 之間發生網路中斷的情形。 | 驗證:
|
無法下載與命令相關的資源。如果錯誤持續發生,請聯絡支援人員。 | 鏈的命令執行者無法相互通訊。當命令使用不同的執行程序,且 CloudRunner 嘗試使用 GroundRunner 的命令所輸出的檔案時,常常會發生這種情況。
注意:為了保護本機資料,CloudRunner 可以與 GroundRunner 共享任何輸出成果,但 GroundRunner 無法與 CloudRunner 共享檔案輸出成果。 |
對鏈中的所有命令使用相同的執行程序,或者—因為鏈的命令需要多個執行程序—驗證不使用 GroundRunner 驗證命令,將檔案輸出成果傳遞給使用 CloudRunner 的命令。 |
啟動命令時出現錯誤:exec: \"\\[connector].exe\": file does not exist" commandExecutorId=[ID] | 惡意軟體或防毒應用程式對連接器辨識有誤,並攔截了它與 GroundRunner 的通訊。 | 從應用程式的掃描中排除 GroundRunner 安裝目錄。 |