Mit dem Workiva-Konnektor können Sie Befehle in Ketten verwenden, um mit der Workiva-Plattform zu interagieren, einschließlich anderer Wdata-Funktionen, Arbeitsblättern und GraphDB. Mit diesem Konnektor können Sie beispielsweise Folgendes tun:
- Tabellen, Abfragen und Ansichten erstellen und verwalten
- Datensätze oder Importfehler einer Tabelle auflisten
- Arbeitsblätter oder deren Blätter erstellen und verwalten
- Aufzeichnungen und Berichte verwalten
Anforderungen
Zur Interaktion mit der Workiva-Plattform nutzt der Konnektor die Workiva-REST-APIs. Zur Einrichtung des Konnektors benötigen Sie Folgendes:
-
Ein spezieller Workiva-Integrationsbenutzer mit und einem OAuth2 Grant.
Hinweis: Dieser Integrationsbenutzer benötigt die entsprechenden Berechtigungen für die Befehle, die der Connector ausführt, z. B. Eigentümer der Kalkulationstabellen oder des Arbeitsbereichs, mit denen er interagiert.
- Die OAuth2-Grant-ID und das Geheimnis des Integrationsbenutzers.
- Um die Kette in einer Testumgebung auszuführen, müssen die URLs die Hosts und Basispfade der API außer Kraft setzen.
Hinweis: Während die Besitzer des Arbeitsbereichs auf Ketten zugreifen können, die den Konnektor verwenden, benötigt der Konnektor selbst einen dedizierten Integrationsbenutzer, um seine Befehle auszuführen. Durch die Verwendung eines dedizierten Integrationsbenutzers (anstelle des Benutzerkontos eines Mitarbeiters) können Sie die Aktivitäten des Konnektors nachverfolgen und seinen Zugriff auf die Funktionen beschränken, die er zur Ausführung seiner Befehle benötigt.
Workiva-Konnektor einrichten
- Von Chain Builder, klicken Sie auf Connections , und dann Create oben rechts.
- Unter Verbindung erstellen, wählen Sie Workiva und den Standard CloudRunner.
- Geben Sie unter Basisinformationen einen eindeutigen Namen und eine Beschreibung ein, um den Konnektor zu identifizieren.
-
Wählen Sie unter Ressourcen die Ressourcen aus, die mit dieser Verbindung verknüpft werden sollen.
Dieser Abschnitt bietet einen sicheren Speicherort für alle Dateien (Skripte, Sicherheits-Token, Zertifikate usw.), die der Konnektor zum Funktionieren benötigt, z. B. für die Authentifizierung oder Umgebungsanforderungen. Wenn Sie die Verbindung speichern, werden diese Dateien automatisch mit AES-256 verschlüsselt. Weitere Informationen finden Sie auf der Seite Workiva Chain Builder Sicherheitsarchitektur Support.Vorteile:
- Sichere Speicherung: Da diese Dateien beim Speichern verschlüsselt und auf der Verbindungsebene gespeichert werden, sind sie ideal für sensible oder statische Konfigurationsdaten, die nicht in der Kette selbst fest codiert sein sollten.
- Übertragbarkeit: Wenn Sie Ihre Kette von einem "Test"-Arbeitsbereich in einen "Produktions"-Arbeitsbereich verschieben, bleiben die Ressourcen an die Verbindungseinstellungen gebunden, d. h. Sie müssen die Dateipfade in Ihren Kettenknoten nicht neu schreiben.
- Zugänglichkeit: Wenn die Dateien hier gespeichert werden, stehen sie dem Runner (dem Agenten, der die Aufgabe ausführt) zur Verfügung, ohne dass die Datei manuell auf dem physischen Host-Rechner des Runners abgelegt werden muss.
Benachteiligungen:
- Da sie verschlüsselt sind, können sie nicht direkt bearbeitet werden; Sie müssen die Datei löschen und die geänderte Version hochladen.
-
Geben Sie unter Eigenschaften die Details der Verbindung ein:
Eigenschaft Details ID Geben Sie die ID für die OAuth-Erlaubnis der Integrationsbenutzer ein. Secret Geben Sie das Secret für die Eigenschaft ID ein. Überschreibung des zentralen Hosts Um den URL-Host und den Basispfad für die Wdata-Endpunkte zu überschreiben (z. B. für eine Testumgebung), geben Sie stattdessen die zu verwendende URL ein. Überschreibung des Arbeitsblätter-Hosts Um den URL-Host und den Basispfad für die Arbeitsblätter-Endpunkte zu überschreiben (z. B. für eine Testumgebung), geben Sie stattdessen die zu verwendende URL ein. Überschreibung des IAM-Hosts Um den URL-Host und den Basispfad für die Identity Access Management (IAM)-Endpunkte zu überschreiben (z. B. für eine Testumgebung), geben Sie stattdessen die zu verwendende URL ein. Überschreibung des Administrator-Hosts Um den URL-Host und den Basispfad für die Administrator-Endpunkte zu überschreiben (z. B. für eine Testumgebung), geben Sie stattdessen die zu verwendende URL ein. Überschreibung des GraphDB-Hosts Um den URL-Host und den Basispfad für die GraphDB-Endpunkte zu überschreiben (z. B. für eine Testumgebung), geben Sie stattdessen die zu verwendende URL ein. Überschreibung des Plattform-API-Hosts Um den URL-Host und den Basispfad für die Endpunkte der Workiva-Plattform zu überschreiben (z. B. für eine Testumgebung), geben Sie stattdessen die zu verwendende URL ein. Hinweis: Alle sensiblen Anmeldedaten werden automatisch verschlüsselt und mit AES-256-Verschlüsselung gespeichert.
- Wählen Sie die Umgebungen aus, die die Verbindung verwenden sollen, und klicken Sie auf Speichern.
- Um die Verbindung zu testen, erstellen Sie eine Kette und führen Sie diese mit dem Befehl Dateien auflisten des Konnektors aus und prüfen Sie, ob eine gültige Ausgabe zurückgegeben wird.
URL-Überschreibungen
Abhängig von der Region Ihrer Produktionsumgebung kann eine Überschreibungs-URL gelten. Sie können dies überprüfen, indem Sie die URL vergleichen, die Sie für die Anmeldung bei Wdesk verwenden. Wenn die URL EU oder APAC enthält, ist eine Überschreibung erforderlich.
Hinweis: Informationen zur US-Region sind als Referenz aufgeführt.
| Feld | Wert |
|---|---|
| Überschreibung des zentralen Hosts | https://h.app.wdesk.com/s/cerebral |
| Überschreibung des Arbeitsblätter-Hosts | https://api.app.wdesk.com/spreadsheets/v1/ |
| Überschreibung des IAM-Hosts | https://api.app.wdesk.com/iam/v1/oauth2/token |
| Überschreibung des Administrator-Hosts | https://api.app.wdesk.com/admin/v1 |
| Überschreibung des GraphDB-Hosts | https://api.app.wdesk.com/graphdb/v1/ |
| Überschreibung des Plattform-API-Hosts | https://api.app.wdesk.com/platform/v1 |
| Feld | Wert |
|---|---|
| Überschreibung des zentralen Hosts | https://h.eu.wdesk.com/s/cerebral |
| Überschreibung des Arbeitsblätter-Hosts | https://api.eu.wdesk.com/spreadsheets/v1/ |
| Überschreibung des IAM-Hosts | https://api.eu.wdesk.com/iam/v1/oauth2/token |
| Überschreibung des Administrator-Hosts | https://api.eu.wdesk.com/admin/v1 |
| Überschreibung des GraphDB-Hosts | https://api.eu.wdesk.com/graphdb/v1/ |
| Überschreibung des Plattform-API-Hosts | https://api.eu.wdesk.com/platform/v1 |
| Feld | Wert |
|---|---|
| Überschreibung des zentralen Hosts | https://h.apac.wdesk.com/s/cerebral |
| Überschreibung des Arbeitsblätter-Hosts | https://api.apac.wdesk.com/spreadsheets/v1/ |
| Überschreibung des IAM-Hosts | https://api.apac.wdesk.com/iam/v1/oauth2/token |
| Überschreibung des Administrator-Hosts | https://api.apac.wdesk.com/admin/v1 |
| Überschreibung des GraphDB-Hosts | https://api.apac.wdesk.com/graphdb/v1/ |
| Überschreibung des Plattform-API-Hosts | https://api.apac.wdesk.com/platform/v1 |
Fehlersuche
Wenn die Verbindung zur Workiva-Plattform fehlschlägt:
- Überprüfen Sie, ob die OAuth-Anmeldeinformationen des Connectors vorhanden, korrekt und gültig sind. OAuth-Anmeldeinformationen haben ein bestimmtes Ablaufdatum, und das Zertifikat kann abgelaufen sein. Wenn dies der Fall ist, müssen Sie ein neues Zertifikat erstellen und das neue Client-Geheimnis in den Connector eingeben.
- Vergewissern Sie sich, dass der Integrationsbenutzer über die entsprechenden Berechtigungen für den auszuführenden Befehl verfügt.
- Wenn Sie einen Host-Override verwenden, überprüfen Sie, ob die für den Connector eingegebene URL korrekt ist.
-
Vergewissern Sie sich, dass die ID der Workiva-Datei (z. B. Tabelle, Abfrage oder Tabellenkalkulation), mit der interagiert wird, korrekt ist.
Hinweis: Die ID einer Datei erscheint in der URL der Datei, wenn sie in Workiva geöffnet wird. Beispielsweise erscheint die ID eines Arbeitsblatts nach
spreadsheet/in der URL und die ID einer Tabelle nachtables/.