Diese Anleitung enthält schrittweise Anweisungen zur Implementierung der Vorlage Abfrage ausführen und Ergebnisse mit Steuerungsblatt herunterladen. Diese Vorlage dient als Alternative zum Befehl Abfrage ausführen, für den Benutzer zuvor Parameter vor der Bereitstellung und Ausführung manuell in Chains 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 Chains integriert, kann aber auch in jedem Workflow verwendet werden, der Abfrageergebnisse im CSV-Format benötigt.
Voraussetzungen
Die folgenden Connectors müssen in Ihrem Arbeitsbereich aktiviert und konfiguriert sein.
- Konfigurieren Sie den Workiva Connector
- Konfigurieren Sie den JSON-Anschluss
- Konfigurieren Sie den Handlebars-Konnektor
- Konfigurieren Sie den HTTP Request Connector
- Konfigurieren Sie den Tabular Transformation Connector
Die folgenden Arbeitsbereich-Variablen müssen in Ihrem Arbeitsbereich erstellt 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 Steuerungsblatt herunterladen befindet sich im Bereich Workiva Chains auf der Seite 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 oben rechts nach 0.0 Execute a Query | Top-Level Orchestration 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 eines API-Grants erhalten. Weitere Anweisungen zur Workiva-API finden Sie hier. |
| Arbeitsbereich-Variable | wsv_Client Secret |
Sie können das Geheimnis Ihres API-Grants im Reiter „Sicherheit“ Ihres Benutzerprofils einsehen, indem Sie im Dropdown-Menü „Aktionen“ neben dem Grant die Option „Neu generieren“ auswählen. Weitere Anweisungen zur Workiva-API finden Sie 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 Steuerungs-Tabellenkalkulation. | Text | Ja |
| Blatt-ID | Hier befindet sich das Steuerungsblatt. | Text | Ja |
Konfigurieren Sie die Vorlage
Diese Vorlage besteht aus zwei Chains: 0.0 Execute a Query | Top-Level Orchestration und 0.1 Execute a Query | Download Results. Wird die Haupt-Chain in Ihrem Arbeitsbereich bereitgestellt, wird die zugehörige Chain automatisch mit bereitgestellt.
- Top-Level Orchestration: Anhand der Informationen aus dem Steuerungsblatt bestimmt diese Chain, ob eine Abfrage einen einzelnen Parametertyp (entweder Auswahlliste oder Mehrfachauswahl) oder mehrere Parametertypen (sowohl Auswahlliste als auch Mehrfachauswahl) verwendet.
- Execute a Query | Download Results: Diese Chain führt eine Abfrage mit den angegebenen Parametern aus und ruft die entsprechenden Daten ab. Nach Ausführung der Abfrage werden die Ergebnisse im CSV-Format zur weiteren Analyse oder Verwendung heruntergeladen.
Sobald das Steuerungsblatt konfiguriert und die Chain-Vorlage in Ihrem Arbeitsbereich bereitgestellt ist, benötigen Sie nur noch die Tabellenkalkulations-ID und Blatt-ID des Steuerungsblatts.
Diese Werte müssen als Laufzeiteingaben für die Top-Level Orchestration Chain hinzugefügt werden.
Konfiguration des Steuerungsblatts nach Parametertyp
Die Konfiguration des Steuerungsblatts richtet sich nach den in Ihrer Wdata-Abfrage definierten Parametertypen. Enthält eine Abfrage mehrere Parametertypen (zum Beispiel sowohl Auswahlliste als auch Mehrfachauswahl), muss jeder Parameter in einer separaten Zeile mit derselben Abfrage-ID definiert werden. Verwendet eine Abfrage nur einen Parametertyp, benötigt das Steuerungsblatt eine einzelne Zeile für diese Abfrage.
Die folgenden Beispiele veranschaulichen beide Szenarien.
Beispiel: Abfrage mit mehreren Parametertypen
Für eine Abfrage, die sowohl Auswahlliste- als auch Mehrfachauswahl-Parameter benötigt, sollte das Steuerungsblatt separate Zeilen für jeden Parameter mit derselben Abfrage-ID enthalten.
Hinweis: Die Spalte Schlüssel bezieht sich auf den in der Wdata-Abfrage definierten Parameternamen.
Beispielkonfiguration:
| Abfrage-ID | Typ | Schlüssel | Werte |
|---|---|---|---|
| Wdata-Abfrage-ID | Auswahlliste-Parameter | Jahr | Geben Sie einen einzelnen Standardwert an (z. B. 2023). |
| Wdata-Abfrage-ID | Mehrfachauswahl-Parameter | Kontoart | Geben Sie mehrere zulässige Werte, durch Kommas getrennt, ein (z. B. Vermögenswert, Aufwand, Eigenkapital, Umsatz). |
Beispiel: Abfrage mit einem einzelnen Parametertyp
Für eine Abfrage, die nur einen Parametertyp verwendet, sollte das Steuerungsblatt eine einzelne Zeile für diese Abfrage-ID enthalten.
Verwendet die Abfrage beispielsweise nur einen Auswahlliste-Parameter:
| Abfrage-ID | Typ | Schlüssel | Werte |
|---|---|---|---|
| Wdata-Abfrage-ID | Auswahlliste-Parameter | Jahr | Geben Sie einen einzelnen Standardwert an (z. B. Januar). |
Achten Sie darauf, dass das Steuerungsblatt korrekt konfiguriert ist, da eine fehlerhafte Einrichtung zu nachgelagerten Problemen führen kann.
Daten in eine Tabelle laden
Sie können den Vorgang automatisieren, um Ihre Ausgabedaten direkt in eine Tabelle zu laden. Um die Ausgabedaten in eine Tabelle zu laden, verwenden Sie am besten die Vorlage „Load Data to Wdata“. Dies kann als Teil Ihres Prozesses ausgelöst werden, indem Sie am HTTP-Connector, der die Ergebnisse herunterlädt, ein Run-Chain-Ereignis 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 Chain einen Fehler ausgelöst hat oder das Herunterladen eines Abfrageergebnisses fehlgeschlagen ist, führen Sie folgende Prüfungen durch:
- Überprüfen Sie, ob beide Chains in Ihrem Arbeitsbereich veröffentlicht wurden. Jede Kette muss separat veröffentlicht werden.
- Stellen Sie sicher, dass die Abfrage in Wdata auf die aktuelle Version aktualisiert wurde.
- Stellen Sie beim Eingeben von Abfrage-ID, Typ, Schlüssel und Wert im Steuerungsblatt sicher, dass die gesamte ID eingegeben wurde und keine führenden oder nachgestellten Leerzeichen vorhanden sind. Überprüfen Sie außerdem, ob Schlüssel und Werte korrekt mit den in Wdata verwendeten Parametern übereinstimmen.
- Vergewissern Sie sich, dass der OAuth2 Grant, der mit der Workiva-Verbindung verbunden ist, über den entsprechenden Zugriff verfügt.
- Stellen Sie sicher, dass alle in einer Abfrage verwendeten Parameter im Steuerungsblatt enthalten 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