GroundRunner 使链式命令能够与本地系统或无法通过互联网访问的远程数据源进行交互。它们通常由 IT 专业人员或熟悉贵组织网络设置的人员安装在专用服务器上,例如托管连接数据源的服务器。
在设置 GroundRunner 之前,我们建议查看 Chain Builder 安全架构。
要求
需要兼容的操作系统,如果您的 GroundRunner 将访问共享资源(例如 Windows 通用命名约定 (UNC) 路径),则还需要具有足够权限的用户帐户。
在 GroundRunner 的初始安装过程中,不会安装 Java 运行时环境 (JRE)。
安装完成后,GroundRunner 开始运行,它会根据需要自动下载 JRE 来运行依赖于 Java 的命令。无需安装或管理员干预,检索到的 JRE 不会影响主机上已存在的 JRE 安装。
或者,如果您有组织要求需要使用特定的 JRE,则可以设置 SHARED_LIBRARY_OVERRIDES 环境变量以指向系统安装。在这种情况下,GroundRunner 不会自动下载 Workiva 标准 JRE,而是使用提供的系统 JRE 安装。
Workiva 提供的 JRE 遵循 GPL v2 许可,并受类路径例外的约束。
注: 要在 Java 安装中使用自定义证书,请参阅在 GroundRunners 中使用自定义证书。
职位要求
在 Workiva 平台上
在 Workiva 平台上,您需要一个角色,该角色可以访问 Chain Builder 设置并管理 Runners。有两种:
- 链所有者: 这是主要角色要求。拥有此角色的用户可以访问 Chain Builder 中的“下载”部分,以检索最新的 GroundRunner 安装文件,并管理“Runners”选项卡以激活或监控服务。
- 组织链安全管理员: 此组织级角色还拥有管理跨多个工作区的连接和运行程序的权限。
在服务器上
由于“手动更新”涉及停止服务并替换安装了 GroundRunner 的物理机或虚拟机上的可执行文件,因此用户必须拥有主机服务器的管理权限。
- Windows: 您必须能够以管理员身份运行命令提示符并访问 Windows 服务管理器(以停止和重新启动 GroundRunner 服务)。
- Linux/macOS: 您必须拥有 sudo 或 root 权限才能将文件移动到安装目录并重新启动后台进程。
下载 GroundRunner
下载 GroundRunner 进行安装或手动更新:
- 在 Workiva 主页侧边栏上,点击 链。
- 在链构建器侧边栏(这是一个新标签页)上,单击 连接。
或者,您可以点击右上角的用户个人资料图标,选择 “链式管理” ,然后选择 “工作场所设置” 。 - 点击顶部菜单栏中的 下载 。
- 找到适用于您操作系统的 GroundRunner,然后单击 下载 。
- 一旦成功下载到您的计算机,请从下面的一系列说明中选择相应的说明,并按照说明安装 GroundRunner。
安装 GroundRunner
Microsoft Installer (MSI) 需要 .NET 3.5 或更高版本。
如果无法满足此要求,则必须改用命令行界面安装 GroundRunner。
安装 GroundRunner:
- 将 GroundRunner.zip 解压缩到新文件夹,然后打开该文件夹。
- 运行 GroundRunner.msi 打开 GroundRunner 设置向导。
- 点击 下一步。
- 请审阅并接受许可协议中的条款,然后单击 下一步。
- 对于目标文件夹,输入 GroundRunner 的安装路径(例如:
C:\Program Files\GroundRunner\),然后单击 下一步。
- 在 平台公司令牌中,输入您的 公司令牌。
- 在 平台认证主机中:
- 对于亚太地区,请输入
h.apac.wdesk.com/s/chains-reaper。 - 对于 EMEA 地区,请输入
h.eu.wdesk.com/s/chains-reaper。 - 对于美国、中美洲和南美洲,请输入
h.app.wdesk.com/s/chains-reaper。
- 对于亚太地区,请输入
- 如果使用代理服务器,请在 代理主机中输入其 URL 和端口。
(例如,http ://yourproxy:3000。
)要绕过代理服务器,请在 “无代理主机”下方输入以逗号分隔的主机列表。 - 单击 下一步、 安装和 完成。
- 安装完成后,在 Windows 服务管理器中右键单击 GroundRunner,然后选择 启动。
您的 GroundRunner 已安装完毕,可以激活了。
要通过命令行界面进行安装,您必须将 GroundRunner 的安装程序下载到程序文件中的一个单独目录中(例如 c:\Program Files (x86)\wdata)。然后您可以解压缩安装文件并将其提取到该目录的根目录。
然后您就可以安装 GroundRunner 了:
- 在 Windows 命令窗口中,输入
并接受所有默认设置。c:\Program Files (x86)\wdata\installer.exe install- 选择“windows”作为初始化系统。
您需要指定 GroundRunner 作为 Windows 服务运行,才能支持自动更新。GroundRunners 只能作为服务运行,测试目的除外。
- 对于路径,在新目录
内创建一个名为 Files 的文件夹 [](例如,C:\Program Files (x86)\Wdata\Files)。 - 授权主机名(AUTH_HOST):
- 对于亚太地区,请输入
h.apac.wdesk.com/s/chains-reaper。 - 对于 EMEA 地区,请输入
h.eu.wdesk.com/s/chains-reaper。 - 对于美国、中美洲和南美洲,请输入
h.app.wdesk.com/s/chains-reaper。
- 对于亚太地区,请输入
- 输入您的 公司令牌。
- 选择“windows”作为初始化系统。
- 删除目录中除 GroundRunner 可执行文件目录之外的所有文件。
- 选择 GroundRunner 是以服务形式运行还是以前台进程形式运行。
- 如果以服务形式运行,请执行以下操作之一:
- 在命令对话框中,输入
sc start GroundRunner。 - 在 Windows 服务管理器中,启动 GroundRunner服务。
- 在命令对话框中,输入
- 如果以前台进程运行,请在命令对话框中输入:
cd c:\Program Files (x86)\wdata GroundRunner.exe
- 如果以服务形式运行,请执行以下操作之一:
您的 GroundRunner 已安装完毕,可以激活了。
步骤 1. 安装 GroundRunner
-
将 GroundRunner 的安装文件下载到其
自己的目录中,例如:/ home/user_name/wdata/ 。注: “/home/user_name/wdata”仅作为示例提供。请遵循贵公司关于服务安装地点的政策。
- 在命令对话框中,使用以下命令解压缩安装文件:
unzip GroundRunner.zip - 输入 GroundRunner 的详细信息。
- 输入
./installer install - 授权主机名(AUTH_HOST):
- 对于亚太地区,请输入
h.apac.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二进制文件。 - 设置
重启=始终。 - 不要设置
StartLimitBurst或StartLimitIntervalSec,因为这些设置可能会阻止 GroundRunner 由于瞬态错误而重新启动。如果您希望 GroundRunner 不进入快速重启循环,您可以配置RestartSec。 - 输入
systemctl enable以启用 systemd GroundRunner 服务单元,以便 GroundRunner 在重启后仍然有效。
Workiva 官方并不支持将 GroundRunner 作为前台进程运行。这对于测试配置可能很有用,但是一旦配置好 GroundRunner,就应该将其设置为长时间运行的后台进程。
在 macOS 上运行 GroundRunners(仅供测试)
Workiva 支持 macOS 上的 GroundRunners 仅用于测试目的。虽然 macOS GroundRunner 能够运行与 Linux 和 Windows 版本相同的命令,但 Workiva 官方并不支持 launchd 作为有效的服务管理器。这是因为苹果公司在 2022 年停止了对其 macOS 服务器软件的支持。苹果笔记本电脑和台式电脑不适合运行 GroundRunners。
启动地面奔跑者
安装 GroundRunner 后,必须在 Chain Builder 中激活它。
- 在链构建器侧边栏上,单击 连接。
- 点击顶部的 跑者 ,然后点击 待注册。
- 请输入跑步者的简短描述性名称。
例如 ”<datasource> -地面跑者”。
- 点击 激活。
手动更新 GroundRunner
虽然这种情况很少发生,但您可能需要手动升级 GroundRunner。
请参阅 Workiva 支持页面 GroundRunner 手册更新 ,了解如何执行此操作。
卸载 GroundRunner
如果您不再需要 GroundRunner,可以将其卸载。
- 停止 GroundRunner 服务。
- 如果它作为服务运行,请使用 Windows 服务管理器,或在命令窗口中输入
sc stop GroundRunner。 - 如果它作为前台进程运行,请按 Ctrl+C。
- 如果它作为服务运行,请使用 Windows 服务管理器,或在命令窗口中输入
- 在命令对话框中,以管理员身份输入
installer.exe uninstall。 - 删除
GroundRunner可执行文件目录。
在命令对话框中,停止 GroundRunner 服务并删除其可执行文件目录(例如, /home/)。<username> /wdata/Contents)。
安装自定义 JRE
如有需要,您可以安装自己的 JRE 来支持 GroundRunner。此 JRE 的 Java 版本必须与 Groundrunner 所需的版本匹配。除了 Oracle Essbase和Oracle Hyperion Financial Management ( HFM ) GroundRunner 之外,所有 GroundRunner 都使用相同的 JRE 版本。有关如何安装自定义 JRE 的信息,请参阅 禁用 Workiva 共享库。
GroundRunner 配置设置和出站域
要使其能够与数据源通信,您可能需要在安装 GroundRunner 的服务器上打开防火墙端口。要更改某些 GroundRunner 的配置设置,您可以编辑二进制文件安装目录中的 GroundRunner.config文件。
| 配置 | 设置 |
|---|---|
| 港口 |
0 到 65535。 默认情况下,地面跑者使用端口 8821 相互通信。但是,只有当不同服务器上的 GroundRunner 在网络内部共享命令输出时才需要端口。 |
| 公司令牌 | 除非 GroundRunner 是为其他租户配置的,否则请保持默认设置。 |
| 日志级别 | 信息 或 调试 |
| 协议 | 保持默认设置。 |
| HTTP_PROXY_URL |
如果使用代理服务器,请输入其 URL 和端口(如有必要)。 注意: GroundRunner 可以使用代理服务器,但不能使用通过 New Technology LAN Manager (NTLM) 进行身份验证的代理服务器。请改为允许服务器的 IP 地址。 |
| 长轮询 | 如果使用代理服务器,请设置为 true 以指示运行程序使用长轮询来检索命令。为确保性能,仅当您的代理服务器或防火墙不支持 Web 套接字时才使用长轮询。 |
| 无代理 | 要绕过代理服务器,请提供以逗号分隔的主机列表,以便直接访问。要根据共同模式包含多个主机,请使用 * 通配符。 |
| 地面行者证书 |
如果使用多个 GroundRunner 并希望向第二个 GroundRunner 发送加密信息,则需要此功能。这必须与 PORT一起使用。 激活运行器时,还必须将PROTOCOL 字段指定为 HTTPS。 |
| 地面行者证书密钥 | 如果使用多个 GroundRunner 并希望从第二个 GroundRunner 接收加密信息,则需要此功能。这还必须与 PORT一起使用。 |
| 禁用 WebSocket | 运行转换需要使用 WebSocket。禁用后,所有使用转换的命令都将被完全跳过。 |
注意:您的自签名证书必须具有主题备用名称 (SAN)。如果未成功,当您的 GroundRunner 尝试下载文件时,将显示一条错误消息,指出缺少 SAN。
如果您的网络 必须允许出站域,则以下规则适用于 GroundRunner:
| 领域 | 目的 |
|---|---|
|
|
Workiva 常用服务的主要子域名,包括 Wdata。 |
*.wdesk.com |
Workiva 生产平台的主域名。 |
*.*.wdesk.com |
Workiva平台支持组件的子域名。 |
安全
GroundRunner 从不收集或汇总数据;它们只在传输过程中保留数据。扩展验证 (EV) 证书始终通过 DigiCert® 对 GroundRunner 与其数据源之间的流量进行加密和保护。
注: 为确保本地数据安全,CloudRunner 可以与 GroundRunner 共享输出,但 GroundRunner 无法与 CloudRunner 共享文件输出。
排除 GroundRunner 故障
如果在链式运行过程中收到这些错误,请检查命令的 GroundRunners。
提示:为了方便故障排除,您可以创建一个链 ,将 GroundRunner的 日志文件自动下载到表中
。| 错误信息 | 原因 | 解决 |
|---|---|---|
| 与代理通信失败——此命令未执行 |
该指挥部无法与其地面机器人进行通信。 如果发生这种情况,则表示 GroundRunner 没有启动,或者 GroundRunner 和 Chain Builder 之间发生了网络中断。 |
核实:
|
| 无法下载与该命令关联的资源。如果错误仍然存在,请联系技术支持。 |
与这些链条指令相关的跑者之间无法相互沟通。 当命令使用不同的运行器时,这种情况经常发生,而 CloudRunner 正在尝试使用来自基于 GroundRunner 的命令的文件输出。 |
链中的所有命令都使用同一个运行器。 如果链的命令需要多个运行器,请验证 GroundRunner 是否将文件输出传递给使用 CloudRunner 的命令。 |
启动命令时出错: exec:"\\[connector].exe\": 文件不存在" commandExecutorId=[ID] |
恶意软件或防病毒应用程序错误地识别了连接器,并拦截了其与 GroundRunner 的通信。 | 将 GroundRunner 安装目录从应用程序的扫描范围中排除。 |
| 证书错误 | 使用自签名证书 |
在许多情况下,使用自签名证书对 GroundRunner 通信进行加密会很方便。如果您使用的是自签名证书,请确保证书的通用名称 与可访问服务器的 URL 匹配。 例如,如果您的 GroundRunner 正在监听端口 8821,并且您可以从您的网络 |
| 间歇性链路故障,错误信息: “连接被对端重置” |
当多个运行程序安装在同一台机器上时,每个运行程序都必须具有唯一的 GUID。 如果使用相同的 GUID,运行程序可能会重叠并进入更新循环,从而导致偶尔的链式故障。 |
我们建议完全重新安装 GroundRunner。 |
| 在 GroundRunner 上命令会被跳过,但在 CloudRunner 上命令会成功执行。 | 运行转换需要使用 WebSocket。禁用 WebSocket 后,所有转换操作都将完全跳过。 | 打开你的配置文件并设置DISABLE_WEBSOCKETS=false。 |
从套接字读取数据时出错。正在重试连接:读取 TCP<IP> :<Port> -> : : wsarecv: 连接尝试失败,因为连接方在一段时间后没有正确响应,或者已建立的连接失败,因为连接的主机没有响应。 |
内部防火墙或网络问题 | 请贵公司内部的 IT 或网络团队检查日志和配置,以便解决该错误。 |
读<IP>:<Port> -> : : wsarecv: 远程主机强制关闭了现有连接 |
内部防火墙或网络问题 | 请贵公司内部的 IT 或网络团队检查日志和配置,以便解决该错误。 |