Workiva Support Center

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 dedizierter Workiva-Integrationsbenutzer mit einer OAuth2-Gewährung.

  Hinweis: Dieser Integrationsbenutzer benötigt geeignete Berechtigungen für die vom Konnektor ausgeführten Befehle, etwa als Eigentümer der Tabellenkalkulationen oder des Arbeitsbereichs, mit denen er interagiert.

• Die OAuth2-Berechtigungs-ID und das Secret des Integrationsbenutzers.
• Um die Kette in einer Testumgebung auszuführen, müssen die URLs die Hosts und Basispfade der API überschreiben

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

1. Klicken Sie im Chain Builder in der linken Seitenleiste auf compare_arrows Verbindungen und dann oben rechts auf compare_arrows Erstellen.
2. Unter Verbindung erstellen, wählen Sie Workiva und den Standard CloudRunner.
   
3. Geben Sie unter Basisinformationen einen eindeutigen Namen und eine Beschreibung ein, um den Konnektor zu identifizieren.

4. Wählen Sie unter Ressourcen die mit dieser Verbindung zu verknüpfenden Ressourcen aus.
   Dieser Abschnitt bietet einen sicheren Ort für alle Dateien (Skripte, Sicherheitstoken, Zertifikate usw.), die der Konnektor zur Funktion benötigt, etwa für die Authentifizierung oder Umgebungsanforderungen. Beim Speichern der Verbindung werden diese Dateien automatisch AES-256-verschlüsselt. Weitere Informationen finden Sie auf der Supportseite Sicherheitsarchitektur des Workiva Chain Builders.

   Vorteile:

   • Sichere Speicherung: Da diese Dateien beim Speichern verschlüsselt und auf Verbindungsebene gespeichert werden, eignen sie sich ideal für sensible oder statische Konfigurationsdaten, die nicht fest in der Chain selbst codiert werden sollten.
   • Übertragbarkeit: Wenn Sie Ihre Chain vom Arbeitsbereich „Test“ zum Arbeitsbereich „Produktion“ verschieben, bleiben die Ressourcen an die Verbindungseinstellungen gebunden, sodass Sie die Dateipfade in Ihren Kettenknoten nicht neu schreiben müssen.
   • Zugänglichkeit: Das Speichern der Dateien hier stellt sie dem Runner (dem die Aufgabe ausführenden Agenten) zur Verfügung, ohne dass die Datei manuell auf dem physischen Host-Rechner des Runners abgelegt werden muss.

   Nachteile:

   • 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.

5. 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 Zugangsdaten werden automatisch mit AES-256-Verschlüsselung verschlüsselt und gespeichert.

6. Wählen Sie die Umgebungen aus, die die Verbindung verwenden sollen, und klicken Sie auf Speichern.
7. 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. Enthält die URL .apac, .ca oder .eu, ist eine Überschreibung erforderlich.

Hinweis: Informationen zur US-Region sind als Referenz aufgeführt.

Fehlersuche

Wenn die Verbindung zur Workiva-Plattform fehlschlägt:

• Prüfen Sie, ob die OAuth-Zugangsdaten der Connector-Anwendung 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 eine Host-Überschreibung verwenden, prüfen Sie, ob die für den Konnektor eingegebene URL korrekt ist.

• Stellen Sie sicher, dass die ID der betroffenen Workiva-Datei – etwa der Tabelle, Abfrage oder Tabellenkalkulation – 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 nach tables/.