GroundRunners ermöglichen die Interaktion von Kettenbefehlen mit Systemen vor Ort oder mit entfernten Datenquellen, die sonst nicht über das Internet zugänglich sind. Sie werden in der Regel von einem IT-Fachmann oder einer anderen Person, die mit den Netzwerkeinstellungen Ihres Unternehmens vertraut ist, auf einem dedizierten Server installiert, z. B. dem Server, auf dem Ihre verbundene Datenquelle gehostet wird.
Bevor Sie einen GroundRunner einrichten, empfehlen wir Ihnen, die Sicherheitsarchitektur des Chain Builders zu lesen.
Anforderungen
Ein kompatibles Betriebssystem ist erforderlich, und wenn der GroundRunner auf gemeinsam genutzte Ressourcen zugreift, wie z.B. einen Windows Universal Naming Convention (UNC) Pfad, dann ist auch ein Benutzerkonto mit ausreichenden Rechten erforderlich.
Eine Java-Laufzeitumgebung (JRE) wird bei der Erstinstallation des GroundRunners nicht mit installiert.
Nachdem das Setup abgeschlossen ist und der GroundRunner läuft, lädt er automatisch eine JRE herunter, um Befehle auszuführen, die von Java abhängig sind. Eine Installation oder ein Eingriff des Administrators ist nicht erforderlich und die abgerufene JRE hat keine Auswirkungen auf bestehende JRE-Installationen, sofern diese auf dem Host vorhanden sind.
Wenn Sie organisatorische Anforderungen haben, die die Verwendung einer bestimmten JRE erfordern, können Sie die Umgebungsvariable SHARED_LIBRARY_OVERRIDES so setzen, dass sie auf die Systeminstallation verweist. In diesem Fall lädt der GroundRunner die Workiva Standard-JRE nicht automatisch herunter und verwendet die mitgelieferte System-JRE-Installation.
Die von Workiva bereitgestellten JREs sind unter der GPL v2 lizenziert und fallen unter die classpath exception.
Hinweis: Um benutzerdefinierte Zertifikate mit Ihrer Java-Installation zu verwenden, siehe Verwendung von benutzerdefinierten Zertifikaten mit GroundRunners.
Anforderungen an die Rolle
Auf der Workiva-Plattform
Auf der Workiva-Plattform benötigen Sie eine Rolle, die Ihnen den Zugriff auf die Einstellungen des Chain Builders und die Verwaltung der Läufer ermöglicht. Es gibt zwei:
- Eigentümer der Kette: Dies ist die primäre Rolle, die erforderlich ist. Benutzer mit dieser Rolle können auf den Abschnitt "Downloads" im Chain Builder zugreifen, um die neuesten GroundRunner Installationsdateien abzurufen und die Registerkarte "Runners" zu verwalten, um den Dienst zu aktivieren oder zu überwachen.
- Org Chain Security Admin: Diese Rolle auf Organisationsebene hat auch die Berechtigung, Verbindungen und Läufer über mehrere Arbeitsbereiche hinweg zu verwalten.
Auf dem Server
Da ein "manuelles Update" das Stoppen von Diensten und das Ersetzen von ausführbaren Dateien auf der physischen oder virtuellen Maschine, auf der der GroundRunner installiert ist, beinhaltet, muss der Benutzer über administrative Rechte auf dem Host-Server verfügen.
- Windows: Sie müssen die Möglichkeit haben, die Eingabeaufforderung als Administrator auszuführen und auf den Windows Service Manager zuzugreifen (um den GroundRunner Dienst zu stoppen und neu zu starten).
- Linux/macOS: Sie müssen sudo oder root Zugriff haben, um Dateien in das Installationsverzeichnis zu verschieben und den Hintergrundprozess neu zu starten.
Den GroundRunner herunterladen
So laden Sie einen GroundRunner zur Installation oder manuellen Aktualisierung herunter:
- Klicken Sie in der Seitenleiste von Workiva Home auf Ketten.
- Klicken Sie in der Seitenleiste des Chain Builders (dies ist eine neue Registerkarte) auf Connections.
Alternativ können Sie auf das Benutzerprofil-Symbol oben rechts klicken, Chains admin wählen und dann Workplace Settings. - Klicken Sie in der oberen Menüleiste auf Downloads.
- Suchen Sie den GroundRunner für Ihr Betriebssystem, und klicken Sie auf Download.
- Wählen Sie nach dem erfolgreichen Download auf Ihren Computer die entsprechenden Anweisungen aus dem unten stehenden Satz aus und folgen Sie ihnen, um den GroundRunner zu installieren.
Installieren Sie den GroundRunner
Der Microsoft Installer (MSI) erfordert .NET 3.5 oder höher.
Wenn Sie diese Anforderung nicht erfüllen können, müssen Sie den GroundRunner stattdessen über die Befehlszeilenschnittstelle installieren.
So installieren Sie den GroundRunner:
- Entpacken Sie GroundRunner.zip in einen neuen Ordner, und öffnen Sie den Ordner.
- Führen Sie GroundRunner.msi aus, um den GroundRunner Setup-Assistenten zu öffnen.
- Klicken Sie auf Weiter.
- Lesen und akzeptieren Sie die Bedingungen der Lizenzvereinbarung und klicken Sie auf Weiter.
- Geben Sie für den Zielordner den Pfad ein, in dem der GroundRunner installiert werden soll (zum Beispiel:
C:\Programme\GroundRunner\) und klicken Sie auf Weiter.
- Geben Sie in Platform company token, Ihren company token ein.
- Unter Platform auth host:
- Für APAC geben Sie
h.apac.wdesk.com/s/chains-reaperein. - Für Kanada geben Sie
h.ca.wdesk.com/s/chains-reaperein. - Für EMEA geben Sie
h.eu.wdesk.com/s/chains-reaperein. - Für die Vereinigten Staaten, Mittelamerika und Südamerika geben Sie
h.app.wdesk.com/s/chains-reaperein.
- Für APAC geben Sie
- Wenn Sie einen Proxy-Server verwenden, geben Sie dessen URL und Port unter Proxy-Host ein.
(Beispiel:http://yourproxy:3000.)
Um den Proxyserver zu umgehen, geben Sie unter No proxy host eine durch Komma getrennte Liste von Hosts ein. - Klicken Sie auf Weiter, Installieren, und Fertigstellen.
- Nach der Installation klicken Sie im Windows Service Manager mit der rechten Maustaste auf den GroundRunner und wählen Start.
Ihr GroundRunner wurde nun installiert und ist bereit für die Aktivierung.
Für die Installation über die Befehlszeilenschnittstelle müssen Sie die GroundRunner-Installation in ein eigenes Verzeichnis innerhalb Ihrer Programmdateien herunterladen (zum Beispiel c:\Programme (x86)\wdata). Sie können dann die Installationsdatei entpacken und in das Stammverzeichnis dieses Verzeichnisses extrahieren.
Sie können dann den GroundRunner installieren:
- Geben Sie in das Windows-Befehlsfenster
ein und akzeptieren Sie alle Standardeinstellungen.c:\Programme (x86)\wdata\installer.exe install- Wählen Sie "Windows" als Startsystem.
Sie müssen angeben, dass der GroundRunner als Windows-Dienst betrieben werden soll, damit er mit automatischen Updates unterstützt wird. GroundRunner sollte, außer zu Testzwecken, nur als Dienst betrieben werden.
- Für den Pfad erstellen Sie einen Ordner Files innerhalb des neuen Verzeichnisses
(z. B.C:\Program Files (x86)\Wdata\Files). - Für den Autorisierungs-Hostnamen (AUTH_HOST):
- Für APAC geben Sie
h.apac.wdesk.com/s/chains-reaperein. - Für Kanada geben Sie
h.ca.wdesk.com/s/chains-reaperein. - Für EMEA geben Sie
h.eu.wdesk.com/s/chains-reaperein. - Für die Vereinigten Staaten, Mittelamerika und Südamerika geben Sie
h.app.wdesk.com/s/chains-reaperein.
- Für APAC geben Sie
- Geben Sie Ihren Firmen-Token ein.
- Wählen Sie "Windows" als Startsystem.
- Löschen Sie alle Dateien aus dem Verzeichnis außer dem GroundRunner-Verzeichnis.
- Wählen Sie aus, ob der GroundRunner als Dienst oder als Vordergrundprozess laufen soll.
- Wenn Sie als Dienst ausgeführt werden, führen Sie einen der folgenden Schritte aus:
- Geben Sie im Befehlsdialog
sc start GroundRunnerein. - Starten Sie im Windows Service Manager den Dienst GroundRunner.
- Geben Sie im Befehlsdialog
- Wenn Sie als Vordergrundprozess laufen, geben Sie im Befehlsdialog ein:
cd c:\Program Files (x86)\wdata GroundRunner.exe
- Wenn Sie als Dienst ausgeführt werden, führen Sie einen der folgenden Schritte aus:
Ihr GroundRunner ist nun installiert und bereit zur Aktivierung.
Schritt 1. Installieren Sie den GroundRunner
-
Laden Sie die Installationsdatei des GroundRunners in ein eigenes Verzeichnis herunter, z. B.
:/home/benutzername/wdata/.Hinweis: "/home/benutzername/wdata" ist als Beispiel angegeben. Befolgen Sie die Richtlinien Ihres Unternehmens für die Standorte der Service-Installation.
- In einem Befehlsdialog entpacken Sie die Installationsdatei mit:
unzip GroundRunner.zip - Geben Sie die Daten des GroundRunners ein.
- Geben Sie
./installer install ein - Für den Autorisierungs-Hostnamen (AUTH_HOST):
- Für APAC geben Sie
h.apac.wdesk.com/s/chains-reaperein. - Für Kanada geben Sie
h.ca.wdesk.com/s/chains-reaperein. - Für EMEA geben Sie
h.eu.wdesk.com/s/chains-reaperein. - Für die Vereinigten Staaten, Mittelamerika und Südamerika geben Sie
h.app.wdesk.com/s/chains-reaperein.
- Für APAC geben Sie
- Geben Sie Ihren Firmen-Token ein.
- Geben Sie
- Löschen Sie alle Dateien aus dem Verzeichnis mit Ausnahme des Ordners, der während des Installationsvorgangs erstellt wurde.
Schritt 2. Den GroundRunner als systemd-Dienst einrichten (Linux)
Um sicherzustellen, dass die automatischen GroundRunner-Updates funktionieren, und um eine gute GroundRunner-Hygiene zu gewährleisten, muss der GroundRunner als aktivierter, neu startbarer systemd-Dienst installiert werden. Bitte lesen Sie in der Dokumentation Ihres Betriebssystems nach, wie Sie den GroundRunner als systemd-Dienst betreiben können.
Für Basiskonfigurationen gelten die folgenden Anforderungen an die systemd-Unit-Datei, damit die automatischen Aktualisierungen ordnungsgemäß funktionieren:
- Stellen Sie sicher, dass die ausführbare Datei
ExecStartauf die BinärdateiGroundRunnerMonitorund NICHT auf die Binärdatei
GroundRunnerverweist. - Stellen Sie
Restart=alwaysein. - Setzen Sie nicht
StartLimitBurstoderStartLimitIntervalSec, da diese den Neustart des GroundRunners aufgrund von vorübergehenden Fehlern verhindern können. Wenn Sie möchten, dass der GroundRunner nicht in eine schnelle Neustartschleife gerät, können SieRestartSeckonfigurieren. - Geben Sie
systemctl enableein, um die systemd GroundRunner Service Unit zu aktivieren, damit der GroundRunner einen Neustart übersteht.
Workiva unterstützt offiziell nicht die Ausführung eines GroundRunners als Vordergrundprozess. Dies kann zum Testen einer Konfiguration nützlich sein, aber sobald ein GroundRunner konfiguriert ist, sollte er als langlebiger Hintergrundprozess eingerichtet werden.
Betrieb von GroundRunners unter macOS (nur zu Testzwecken)
Workiva unterstützt GroundRunners auf macOS nur zu Testzwecken. Während macOS GroundRunner in der Lage sind, die gleichen Befehle wie die Linux- und Windows-Versionen auszuführen, unterstützt Workiva offiziell launchd nicht als gültigen Dienstmanager. Das liegt daran, dass Apple den Support für seine macOS-Server-Software im Jahr 2022 eingestellt hat. Apple Laptops und Desktop-Computer sind für den Betrieb von GroundRunner nicht geeignet.
Aktivieren Sie den GroundRunner
Nachdem Sie Ihren GroundRunner installiert haben, müssen Sie ihn im Chain Builder aktivieren.
- Klicken Sie in der Seitenleiste des Chain Builders auf Verbindungen.
- Klicken Sie oben auf Läufer und dann auf Ausstehende Registrierung.
- Geben Sie einen kurzen, beschreibenden Namen für den Läufer ein.
Zum Beispiel "<Datenquelle>-GroundRunner".
- Klicken Sie auf Aktivieren Sie.
Manuelle Aktualisierung eines GroundRunners
Auch wenn dies nur selten erforderlich ist, kann es sein, dass Sie einen GroundRunner manuell aktualisieren müssen.
Auf der Workiva-Supportseite GroundRunner Manual update finden Sie eine Anleitung, wie Sie dies tun können.
GroundRunner deinstallieren
Wenn Sie einen GroundRunner nicht mehr benötigen, können Sie ihn deinstallieren.
- Beenden Sie den GroundRunner Dienst.
- Wenn er als Dienst ausgeführt wird, verwenden Sie den Windows Service Manager oder geben Sie
sc stop GroundRunnerin einem Befehlsfenster ein. - Wenn er als Vordergrundprozess läuft, drücken Sie Strg+C.
- Wenn er als Dienst ausgeführt wird, verwenden Sie den Windows Service Manager oder geben Sie
- Geben Sie im Befehlsdialog als Administrator
installer.exe uninstallein. - Löschen Sie das ausführbare Verzeichnis
GroundRunner.
Stoppen Sie im Befehlsdialog den GroundRunner Dienst und löschen Sie sein ausführbares Verzeichnis (z.B. /home/<Benutzername>/wdata/Contents).
Installieren einer benutzerdefinierten JRE
Bei Bedarf können Sie Ihre eigene JRE installieren, um einen GroundRunner zu unterstützen. Die Java-Version dieser JRE muss mit der für den Groundrunner erforderlichen Version übereinstimmen. Mit Ausnahme der Oracle Essbase und Oracle Hyperion Financial Management (HFM) GroundRunners verwenden alle GroundRunners die gleiche JRE-Version. Informationen zur Installation einer benutzerdefinierten JRE finden Sie unter Deaktivieren Sie Workiva Shared Libraries.
GroundRunner Konfigurationseinstellungen und Outbound-Domains
Um die Kommunikation mit der Datenquelle zu ermöglichen, müssen Sie möglicherweise Firewall-Ports auf dem Server öffnen, auf dem der GroundRunner installiert ist. Um die Konfigurationseinstellungen einiger GroundRunner zu ändern, können Sie die Datei GroundRunner.config in dem Verzeichnis bearbeiten, in dem die Binärdateien installiert sind.
| Konfiguration | Einstellungen |
|---|---|
| PORT |
0 bis 65535. Standardmäßig verwenden die GroundRunner den Port 8821, um miteinander zu kommunizieren. Ein Port ist jedoch nur dann erforderlich, wenn GroundRunner auf verschiedenen Servern innerhalb Ihres Netzwerks Befehlsausgaben gemeinsam nutzen. |
| FIRMEN_TOKEN | Belassen Sie es bei der Standardeinstellung, es sei denn, der GroundRunner ist für einen anderen Mieter konfiguriert. |
| LOG_LEVEL | Info oder debug |
| PROTOKOLL | Als Standard belassen. |
| HTTP_PROXY_URL |
Wenn Sie einen Proxyserver verwenden, geben Sie dessen URL und Port ein (falls erforderlich). Hinweis: GroundRunners kann Proxy-Server verwenden, jedoch nicht solche, die über New Technology LAN Manager (NTLM) authentifiziert sind. Lassen Sie stattdessen die IP-Adresse des Servers zu. |
| LONG_POLL | Wenn Sie einen Proxy-Server verwenden, setzen Sie diesen auf true, um den Runner anzuweisen, Long-Polling zum Abrufen von Befehlen zu verwenden. Um die Leistung zu gewährleisten, sollten Sie Long-Polling nur verwenden, wenn Web-Sockets von Ihrem Proxy-Server oder Ihrer Firewall nicht unterstützt werden. |
| NO_PROXY | Um den Proxyserver zu umgehen, geben Sie eine durch Kommata getrennte Liste von Hosts an, die Sie stattdessen direkt erreichen möchten. Um mehrere Hosts nach einem gemeinsamen Muster einzuschließen, verwenden Sie den Platzhalter *. |
| GROUNDRUNNER_CERT |
Wird benötigt, wenn mehr als ein GroundRunner verwendet wird und verschlüsselte Informationen an den zweiten GroundRunner gesendet werden sollen. Dies muss in Verbindung mit PORT verwendet werden. Sie müssen auch das Feld PROTOCOL als HTTPS angeben, wenn Sie den Runner aktivieren. |
| GROUNDRUNNER_CERT_KEY | Wird benötigt, wenn mehr als ein GroundRunner verwendet wird und verschlüsselte Informationen von einem zweiten GroundRunner empfangen werden sollen. Dies muss auch in Verbindung mit PORT verwendet werden. |
| DEAKTIVIEREN_WEBSOCKETS | Websockets sind für die Ausführung von Transformationen erforderlich. Wenn deaktiviert, werden alle Befehle, die Transformationen verwenden, vollständig übersprungen. |
Hinweis: Ihr selbstsigniertes Zertifikat muss einen Subject Alternative Name (SAN) haben. Wenn dies nicht der Fall ist, zeigt der GroundRunner beim Herunterladen von Dateien eine Fehlermeldung an, die auf das fehlende SAN hinweist.
Wenn Ihr Netzwerk ausgehende Domänen zulassen muss, gelten diese für GroundRunners:
| Bereich | Zweck |
|---|---|
|
|
Die wichtigsten Subdomains für die gängigen Workiva-Dienste, einschließlich Wdata. |
*.wdesk.com |
Die Hauptdomäne für die Produktionsplattform Workiva. |
*.*.wdesk.com |
Die Subdomänen für unterstützende Komponenten in der Workiva-Plattform. |
Sicherheit
GroundRunners sammelt oder aggregiert niemals Daten; sie speichern die Daten nur während der Übertragung. Ein Extended Validation (EV)-Zertifikat verschlüsselt und schützt immer den Datenverkehr zwischen einem GroundRunner und seiner Datenquelle über DigiCert®.
Hinweis: Um Daten vor Ort zu sichern, können CloudRunner Ausgaben mit GroundRunnern teilen, aber GroundRunner können keine Dateiausgaben mit CloudRunner teilen.
Behebung von GroundRunner Fehlern
Wenn Sie diese Fehler bei der Ausführung einer Kette erhalten, überprüfen Sie die GroundRunners des Befehls.
Tipp: Um die Fehlersuche zu erleichtern, können Sie eine Kette erstellen, um automatisch die Protokolldatei eines GroundRunners in eine Tabelle herunterzuladen.
| Fehlermeldung | Ursache | Lösung |
|---|---|---|
| Kommunikation mit Agent fehlgeschlagen - dieser Befehl wurde nicht ausgeführt |
Der Befehl konnte nicht mit seinem GroundRunner kommunizieren. In diesem Fall ist der GroundRunner nicht gestartet oder es ist eine Netzwerkunterbrechung zwischen dem GroundRunner und dem Chain Builder aufgetreten. |
Überprüfen:
|
| Die mit dem Befehl verbundenen Ressourcen können nicht heruntergeladen werden. Bitte kontaktieren Sie den Support, wenn der Fehler weiterhin besteht. |
Die mit diesen Kettenbefehlen verbundenen Läufer können nicht miteinander kommunizieren. Dies tritt häufig auf, wenn Befehle verschiedene Runner verwenden und der CloudRunner versucht, eine Datei zu verwenden, die von einem GroundRunner-basierten Befehl ausgegeben wurde. |
Verwenden Sie für alle Befehle in der Kette denselben Vermittler. Wenn die Befehle der Kette mehrere Runner erfordern, vergewissern Sie sich, dass keine Befehle mit GroundRunner Dateiausgaben an Befehle weitergeben, die den CloudRunner verwenden. |
Fehler beim Starten des Befehls: exec: \"\\[connector].exe\": Datei existiert nicht" commandExecutorId=[ID] |
Eine Malware- oder Antiviren-Anwendung hat den Connector fälschlicherweise identifiziert und seine Kommunikation mit dem GroundRunner abgefangen. | Schließen Sie das GroundRunner Installationsverzeichnis von den Scans der Anwendung aus. |
| Zertifikat-Fehler | Verwendung von selbstsignierten Zertifikaten |
In vielen Fällen wird es sinnvoll sein, selbstsignierte Zertifikate zur Verschlüsselung der GroundRunner Kommunikation zu verwenden. Wenn Sie ein selbstsigniertes Zertifikat verwenden, stellen Sie sicher, dass der Common Name des Zertifikats mit der URL übereinstimmt, unter der Sie den Server erreichen können. Wenn Ihr GroundRunner beispielsweise auf Port 8821 lauscht und Sie von Ihrem Netzwerk |
| Intermittierender Kettenausfall mit Fehler: "Connection reset by peer" |
Wenn mehrere Runner auf demselben Rechner installiert sind, muss jeder von ihnen eine eindeutige GUID haben. Wenn dieselbe GUID verwendet wird, können sich die Runner überschneiden und in eine Aktualisierungsschleife geraten, was zu gelegentlichen Kettenfehlern führt. |
Wir empfehlen eine komplette Neuinstallation des GroundRunner. |
| Befehle werden auf dem GroundRunner übersprungen, sind aber auf dem CloudRunner erfolgreich | Websockets sind für die Ausführung von Transformationen erforderlich. Wenn Websockets deaktiviert sind, werden alle Transformationen vollständig übersprungen. | Öffnen Sie Ihre Konfigurationsdatei und setzen SieDISABLE_WEBSOCKETS=false. |
Fehler beim Lesen vom Socket. Wiederholung der Verbindung: read tcp <IP>:<Port>-><IP>:<Port>: wsarecv: Ein Verbindungsversuch ist fehlgeschlagen, weil die verbundene Partei nach einer gewissen Zeit nicht ordnungsgemäß geantwortet hat, oder die Verbindung ist fehlgeschlagen, weil der verbundene Host nicht geantwortet hat. |
Interne Firewall oder Netzwerkproblem | Bitten Sie Ihr internes IT- oder Netzwerkteam, die Protokolle und die Konfiguration zu überprüfen, um den Fehler zu beheben. |
read <IP>:<Port>-><IP>:<Port>: wsarecv: Eine bestehende Verbindung wurde vom entfernten Host zwangsweise geschlossen |
Interne Firewall oder Netzwerkproblem | Bitten Sie Ihr internes IT- oder Netzwerkteam, die Protokolle und die Konfiguration zu überprüfen, um den Fehler zu beheben. |