Dieser Leitfaden enthält eine Schritt-für-Schritt-Anleitung zur Implementierung der Vorlage „ : Abfrage ausführen und Ergebnisse mit Kontrollblatt herunterladen“ ( ). Diese Vorlage dient als Alternative zum Befehl „ Run Query“ , bei dem Benutzer bisher vor der Bereitstellung und Ausführung Parameter manuell in Ketten eingeben mussten.
Mithilfe eines „ “-Steuerungsblatts ( ) können Benutzer mehrere Abfrage-IDs hinzufügen und Parameter wie „ “-Auswahlliste ( ) oder „ “-Mehrfachauswahl ( ) dynamisch definieren. Diese Vorlage wird häufig in bestehende Ketten integriert, kann aber auch in jedem Workflow verwendet werden, der Abfrageergebnisse im CSV-Format „ “ erfordert .
Voraussetzungen
Die folgenden Konnektoren müssen in Ihrem Arbeitsbereich aktiviert und konfiguriert werden.
- Konfigurieren Sie den Workiva Connector
- Konfigurieren Sie den JSON-Anschluss
- Konfigurieren Sie den Handlebars-Konnektor
- Konfigurieren des HTTP-Anforderungskonnektors „ “
- Konfigurieren des „ “-Konnektors für tabellarische Transformationen
Die folgenden Arbeitsbereichsvariablen müssen in Ihrem Arbeitsbereich angelegt werden:
- wsv_API Basis-URL - IAM
- wsv_Client ID
- wsv_Client Secret
- wsv_API Basis-URL - Wdata
Finden Sie die Vorlage
Die Vorlage „ : Abfrage ausführen und Ergebnisse mit Kontrollblatt herunterladen“ ( ) befindet sich im Abschnitt „Workiva Chains“ des Bildschirms „ -Vorlagen“ ( ).
So finden Sie es:
- Gehen Sie in Chain Builder auf die Registerkarte Templates .
- Wählen Sie Workiva Chains aus dem Menü am oberen Rand.
- Suchen Sie nach „ “ 0.0 Abfrage ausführen | Orchestrierung auf oberster Ebene Klicken Sie oben rechts auf „ “ und öffnen Sie die Vorlage.
-
Nachdem Sie die Vorlage gefunden haben, klicken Sie auf New Chain, um sie in Ihrem Arbeitsbereich einzusetzen.
Hinweis: Nach der Konfiguration muss jede Kette in dieser Vorlage im Arbeitsbereich veröffentlicht werden.
Variablen
| Variabel-Typ | Name der Variablen | Beschreibung |
|---|---|---|
| Arbeitsbereich-Variable | wsv_API Basis-URL - IAM |
Geben Sie die Basis-URL für die API entsprechend Ihrer Region ein:
|
| Arbeitsbereich-Variable | wsv_Client ID |
Geben Sie die Client-ID ein, die Sie bei der Einrichtung einer API-Berechtigung erhalten haben. Weitere Anleitungen zur Workiva-API finden Sie unter hier . |
| Arbeitsbereich-Variable | wsv_Client Secret |
Sie können Ihr API-Berechtigungsgeheimnis einsehen, indem Sie in Ihrem Benutzerprofil auf die Registerkarte „Sicherheit“ wechseln und dann in der Dropdown-Liste „Aktionen“ neben der Berechtigung auf die Option „Neu generieren“ klicken. Weitere Anleitungen zur Workiva-API finden Sie unter hier . |
| Arbeitsbereich-Variable | wsv_API Basis-URL - Wdata |
Geben Sie die Basis-URL für die API entsprechend Ihrer Region ein: |
Laufzeit-Eingaben
| Laufzeit-Eingabe | Zweck | Feldtyp | Erforderlich |
|---|---|---|---|
| Arbeitsblatt-ID | Hier befindet sich die Kontrolltabelle. | Text | Ja |
| Blatt-ID | Hier befindet sich das Kontrollblatt. | Text | Ja |
Konfigurieren Sie die Vorlage
Diese Vorlage besteht aus zwei Ketten: „ “ 0.0 „Abfrage ausführen“ | Orchestrierung auf oberster Ebene und „ “ 0.1 „Abfrage ausführen“ | Ergebnisse herunterladen . Wenn die primäre Kette in Ihrem Arbeitsbereich bereitgestellt wird, wird die Kette „chain“ automatisch mit bereitgestellt.
- der obersten Ebene: Anhand der Informationen aus dem Steuerungsblatt bestimmt diese Kette, ob eine Abfrage einen einzelnen Parametertyp (entweder Auswahlliste oder Mehrfachauswahl ) oder mehrere Parametertypen (sowohl Auswahlliste als auch Mehrfachauswahl ) verwendet.
- Abfrage ausführen | Ergebnisse herunterladen: Diese Kette führt eine Abfrage mit den angegebenen Parametern aus und ruft die entsprechenden Daten ab. Sobald die Abfrage ausgeführt wurde, werden die Ergebnisse im CSV-Format heruntergeladen, damit sie weiter analysiert oder genutzt werden können.
Sobald das Steuerungsblatt „ “ ( ) konfiguriert und die Kettenvorlage „ “ ( ) in Ihrem Arbeitsbereich bereitgestellt wurde, benötigen Sie lediglich die Tabellenkalkulations-ID „ “ ( ) und die Blatt-ID „ “ ( ) des Steuerungsblatts.
Diese Werte müssen als Laufzeitparameter für „ “ hinzugefügt werden: für die Top-Level-Orchestrationskette „ “ .
Konfiguration des Steuerungsblatts nach Parametertyp
Wie Sie das Steuerungsblatt konfigurieren, hängt von den in Ihrer Wdata-Abfrage definierten Parametertypen ab. Wenn eine Abfrage mehrere Parametertypen enthält (beispielsweise sowohl Auswahlliste als auch Mehrfachauswahl ), muss jeder Parameter in einer separaten Zeile unter Verwendung derselben Abfrage-ID definiert werden. Wenn eine Abfrage „ “ nur einen Parametertyp „ “ verwendet, erfordert das Steuerungsblatt „ “ eine einzige Zeile „ “ für diese Abfrage.
Die folgenden Beispiele veranschaulichen beide Szenarien.
Beispiel: Abfrage mit mehreren Parametertypen
Bei einer Abfrage, die sowohl die Parameter „ “ (Auswahlliste) als auch „ “ (Mehrfachauswahl) erfordert, sollte das Steuerungsblatt für jeden Parameter eine separate Zeile enthalten, wobei alle dieselbe Abfrage-ID verwenden.
Hinweis: Der Schlüssel „ “ bezieht sich auf den Parameternamen „ “ , der in der Wdata-Abfrage definiert ist.
Beispielkonfiguration:
| Abfrage-ID | Typ | Schlüssel | Werte |
|---|---|---|---|
| Wdata-Abfrage-ID | Auswahllisten-Parameter | Jahr | Geben Sie einen einzelnen Standardwert an (z. B. 2023 ). |
| Wdata-Abfrage-ID | Parameter mit Mehrfachauswahl | Kontoart | Geben Sie mehrere zulässige Werte ein, getrennt durch Kommas (z. B. „ Asset,Expense,Equity,Revenue “). |
Beispiel: Abfrage mit einem einzigen Parametertyp
Bei einer Abfrage, die nur den Parametertyp „ “ verwendet, sollte das Steuerungsblatt für diese Abfrage-ID eine einzige Zeile enthalten . .
Wenn die Abfrage beispielsweise ausschließlich den Parameter „ “ aus der Auswahlliste „ “ verwendet:
| Abfrage-ID | Typ | Schlüssel | Werte |
|---|---|---|---|
| Wdata-Abfrage-ID | Auswahllisten-Parameter | Jahr | Geben Sie einen einzelnen Standardwert an (z. B. Januar ). |
Stellen Sie sicher, dass das Steuerblatt korrekt konfiguriert ist, da eine fehlerhafte Konfiguration zu Problemen in nachgelagerten Prozessen führen kann.
Daten in eine Tabelle laden
Sie können den Vorgang des direkten Einlesens Ihrer Ausgabe in eine Tabelle automatisieren. Um die Ausgabedaten in eine Tabelle zu laden, können Sie die Vorlage „ “ („ “ „Load Data to Wdata“ „ ) verwenden. Dies kann im Rahmen Ihres Prozesses ausgelöst werden, indem Sie am HTTP-Konnektor, der die Ergebnisse herunterlädt, ein Ereignis „ -Ausführungskette“ ( ) hinzufügen.
Fehlersuche
Um die Historie Ihres Kettenlaufs einschließlich der Fehler anzuzeigen:
- Rufen Sie im Chain Builder die Registerkarte Monitor auf.
-
Bewegen Sie den Mauszeiger über das Fragezeichen, um den Status des Kettenlaufs anzuzeigen.
Wenn Ihre Kette einen Fehler ausgelöst hat oder das Herunterladen eines Abfrageergebnisses fehlgeschlagen ist, führen Sie bitte die folgenden Überprüfungen durch:
- Stellen Sie sicher, dass beide Ketten in Ihrem Arbeitsbereich veröffentlicht wurden. Jede Kette muss separat veröffentlicht werden.
- Stellen Sie sicher, dass die Abfrage in Wdata auf die neueste Version aktualisiert wird.
- Achten Sie bei der Eingabe der „ “-Abfrage-ID sowie des „ “-Typs, der Schlüssel und des Werts im Kontrollblatt darauf, dass die gesamte ID eingegeben wurde und weder am Anfang noch am Ende Leerzeichen stehen. Vergewissern Sie sich außerdem, dass die Schlüssel und Werte korrekt mit den in Wdata verwendeten Parametern übereinstimmen.
- Stellen Sie sicher, dass die mit der Workiva-Verbindung verknüpfte OAuth2-Grant- „ “ über die entsprechenden Zugriffsrechte verfügt.
- Stellen Sie sicher, dass alle in einer Abfrage verwendeten Parameter im Kontrollblatt aufgeführt sind.
Zusätzliche Ressourcen
- Workiva Konnektor
- Dateidienstprogramm Konnektor
- JSON Konnektor
- Tabellen-Transformation Konnektor
- Eine Kette innerhalb einer anderen Kette ausführen ("Run Chain events")
- OAuth2-Gewährungen
- Wdata-Funktion und API-Beschränkungen