Workiva Support Center

Hintergrund

Bei der Orchestrierung von Berichtsprozessen mit der Data Management Suite stoßen wir häufig auf komplexe Workflow-Szenarien. Zum Beispiel kann es sein, dass eine Anwendung ausgeführt werden muss:

• Ein einziger Arbeitsablauf mehrmals mit unterschiedlichen Eingaben
• Mehrere unterschiedliche Arbeitsabläufe
• Mehrere gleichzeitige Arbeitsabläufe, jeder mit spezifischen Eingaben
• Workflows zur Integration von Quellsystemen, die bestimmte Parameter wie Daten, Dateinamen oder Regelnamen erfordern

Um diese komplizierten Arbeitsabläufe effizient zu automatisieren und zu verwalten, erweist sich das Konzept eines Kontrollblatts als unschätzbar wertvoll. Ein Kontrollblatt fungiert als zentrales Verwaltungsinstrument, das die Vordefinition von Eingaben für jede Workflow-Ausführung ermöglicht. Durch den Einsatz von Control Sheets können Benutzer die Parameter und Bedingungen festlegen, unter denen die einzelnen Arbeitsabläufe ablaufen sollen, und so einen nahtlosen, automatisierten Prozess ermöglichen, der alle erforderlichen Arbeitsabläufe mit den entsprechenden Eingaben ausführt, ohne dass bei jedem Schritt ein manueller Eingriff erforderlich ist.

Durch die Erstellung und Nutzung eines Kontrollblatts können Benutzer:

• Definieren Sie Eingabewerte, die bei jeder Ausführung an eine Kette übergeben werden
• Definieren Sie Flags, die bestimmen, ob eine Kette bestimmte Operationen durchführen soll
• Übergeben Sie Werte wie Abfrageparameter, Regelnamen oder Datumsfilter in den Systemworkflow, wenn Sie eine Kette ausführen oder eine Regel starten.
• Teile von Roll-forward-Vorgängen durchführen
• Verwalten Sie die ID's für Artefakte innerhalb von Workiva
• Protokollierung des Ausführungsstatus eines Workflows

Dieser Artikel führt Sie durch den Prozess der Erstellung eines einfachen Kontrollblatts. Dieses Blatt ermöglicht es den Benutzern, denselben Arbeitsablauf mit verschiedenen Eingabesätzen auszuführen.

Voraussetzungen

• Konfigurieren Sie den Workiva Connector
• Konfigurieren Sie den JSON-Anschluss
• Konfigurieren Sie den Handlebars-Konnektor

Schritt 1: Einrichten eines Kontrollblatts

• Erstellen Sie eine Tabellenkalkulation innerhalb der Workiva-Plattform
• Weisen Sie dem Benutzer, der mit der OAuth2 -Gewährung verbunden ist, Eigentumsrechte zu.
• Benennen Sie die Tabellenkalkulation und das Blatt um in 
  • Kontrollarbeitsblatt
  • Kontrollblatt

Schritt 2: Einstellen von Überschriften (Schlüsseln) für das Kontrollblatt

Legen Sie Kopfzeilen für jeden Wert fest, der durch den Ketten-Workflow verarbeitet werden soll. In diesem Beispiel werden die folgenden Kopfzeilen eingerichtet: 

• Active_Flag: Zur Bestimmung, ob diese Zeile verarbeitet werden soll oder nicht
• Datei_Name: Name der zu verarbeitenden Datei
• Table_ID: ID der Wdata-Tabelle, in die die Datei importiert werden soll

Schritt 3: Weisen Sie den Überschriften im Kontrollblatt Werte zu

• In diesem Beispiel wurden für jedes Schlüssel/Wert-Paar drei Werte definiert. Daher werden beim Lesen jeder Zeile die folgenden Daten eingegeben:

Schritt 4: Erstellen einer Kette zum Abrufen von Kontrollblattdaten

Um die Daten des Kontrollblatts aus der Kalkulationstabelle abrufen zu können, muss eine Kette zum Lesen der Kalkulationstabelle erstellt werden. 

• Navigieren Sie zum Modul "Ketten" und erstellen Sie eine neue Kette
• Navigieren Sie zu den Ketteneinstellungen und betiteln Sie Ihre neue Kette mit Get Control Sheet Data
• Fügen Sie zwei Chain Variablen hinzu:
  • cv-SpreadsheetID
  • cv-SheetName
• Füllen Sie jede Variable mit den entsprechenden SpreadsheetID und SheetName Werten aus Ihrem Kontrollblatt.

   

Schritt 5: Blattdaten abrufen

Um die Daten in Ihrem Kontrollblatt verwenden zu können, müssen Sie den Befehl Get Sheet Data verwenden. Der Befehl liest den Inhalt eines Blattes in einer Tabellenkalkulation und erzeugt eine .csv Ausgabe. 

• Ziehen Sie den Befehl Workiva Get Sheet Data per Drag & Drop in den START-Bereich des Canvas
• Konfigurieren Sie den Befehl
  • Umbenennen in Kontrollblattdaten abrufen
  • Verwenden Sie die Kettenvariable cv-SpreadsheetID für das Feld Spreadsheet ID
  • Verwenden Sie die Kettenvariable cv-SheetName für das Feld Sheet ID/Name
  • Geben Sie A1: für die Region ein.
  • Belassen Sie den Wert Stil und Revision als Berechnet und -1
  • Speichern anklicken

Schritt 6: Blattdaten in JSON konvertieren

Nach dem erfolgreichen Abruf der Kontrollblattdaten im .csv-Format besteht der nächste Schritt darin, sie in JSON zu konvertieren. Diese Konvertierung stellt sicher, dass die Kopfzeilen und Spaltenwerte korrekt in die JSON Key-Value Struktur umformatiert werden. Dieses Format ist entscheidend für die folgenden Schritte.

• Ziehen Sie den Befehl CSV to JSON auf die Leinwand.
• Verknüpfen Sie den Befehl Get Control Sheet Data mit dem Befehl CSV to JSON
• Bearbeiten Sie den Befehl CSV to JSON
  • Verwenden Sie im Feld Input File die Ausgabe Data aus dem Dropdown-Menü Get Control Sheet Data
  • Belassen Sie das Feld Delimiter als Komma (,)
  • Auf „Speichern“ klicken

 

Schritt 7: Iteration durch JSON-Daten

Da die Daten des Kontrollblatts nun im JSON-Format vorliegen, kann eine Befehlsgruppe verwendet werden, um durch jede Datenzeile in Ihrem Kontrollblatt zu iterieren

• Befehlsgruppe zur Leinwand hinzufügen
• Verbinden Sie den Befehl CSV to JSON mit dem Teil In der Befehlsgruppe
• Bearbeiten Sie die Befehlsgruppe und nennen Sie sie JSON Iterator
  • Klicken Sie auf das Iterationssymbol rechts neben der Registerkarte Basisinformationen
  • Aktivieren Sie den Iterator
  • Belassen Sie den Modifikatortyp auswählen als Liste
  • Wählen Sie für den Abschnitt Wiederholungen die Ausgabe <> JSON-Datei aus dem Dropdown-Menü des Befehls CSV zu JSON
• Speichern anklicken

 

Schritt 8: Vorschau auf jede Iteration von Daten

Da die Kette nun in der Lage ist, jede Zeile Ihres Kontrollblatts zu durchlaufen, kann ein Handlebars-Befehl verwendet werden, um die Ausgabe der Informationen in der Vorschau anzuzeigen.

Hinweis: Der Befehl Handlebars dient als Platzhalter für die Überprüfung der Werte in diesem Artikel, es können aber auch andere Befehle zur Verarbeitung der Werte verwendet werden.

• Ziehen Sie den Befehl Textvorlage rendern per Drag & Drop auf die Leinwand.
• Verknüpfen Sie den Gruppenstart der Befehlsgruppe mit dem Befehl Textvorlage rendern
• Bearbeiten Sie den Befehl und nennen Sie ihn Vorschau Kontrollblattdaten
• Geben Sie in das Feld Vorlage Folgendes ein:

Dateiname active Markierung Tabellen-ID 

• Um die Werte aus dem Kontrollblatt abzuleiten, muss für jede JSON-Iteration eine Variablentransformation durchgeführt werden
• Neben File Name wählen Sie JSON File Iteration aus der Seitenleiste, die sich unter dem Dropdown-Menü Group Iterator befindet.
  • • Klicken Sie auf die JSON-Datei-Iteration, wählen Sie „Wert aus JSON beziehen“
    • Geben Sie in das Feld Wert die Kopfzeile File_Name aus Ihrem Kontrollblatt ein.
      • Hinweis: Es empfiehlt sich, die Kopfzeile aus dem Kontrollblatt direkt in das Wertefeld zu kopieren.
  • Drücken Sie Enter und Akzeptieren
• Wiederholen Sie die obigen Schritte für die Überschriften Active_Flag & Table_ID aus dem Kontrollblatt 
• Nach dem Ausfüllen sollte das Vorlagenfeld wie folgt aussehen:

• Speichern Sie den Befehl

 

Schritt 9: Ausführen der Kette und Vorschau

Nachdem nun die Kette und das Kontrollblatt eingerichtet sind, muss sichergestellt werden, dass jede Iteration der Handlebar-Ausgabe Daten für jede Zeile im Kontrollblatt enthält.

• Klicken Sie auf Veröffentlichen und dann Ausführen die Kette
• Führen Sie die Kette aus
• Nachdem die Kette erfolgreich ausgeführt wurde, klicken Sie auf den Befehl Vorschau Kontrollblattdaten und navigieren Sie zur Registerkarte Protokoll
  • Unter "Start Rendered Text" sollte eine Ausgabe für die erste Iteration zu sehen sein.
  • Wechseln Sie in der Option über der Registerkarte Protokoll zu Wert 2, um die Ergebnisse für die zweite Iteration zu sehen
  • Wechseln Sie schließlich zu Wert 3, um die Ergebnisse der dritten Iteration zu sehen
• Jede Iteration sollte wie folgt aussehen:

Wert 1:

 

Wert 2:

 

Wert 3:

Nutzen Sie die aktive Flagge

Der nächste Schritt ist die Einbindung einer bedingten Logik, die den Wert des Aktiv-Merkers nutzt, unter Verwendung derselben Kette, die bereits erstellt wurde.

• Bearbeiten Sie die Kette und löschen Sie die Verknüpfung zwischen dem JSON Iterator und dem Preview Control Sheet Data
• Fügen Sie einen bedingten Befehl hinzu und verbinden Sie den Gruppenstart der Befehlsgruppe mit dem neuen Befehl
• Verknüpfen Sie den Befehl Conditional mit dem Befehl Preview Control Sheet Data
• Bearbeiten Sie den Befehl „Bedingt“
  • Wie lautet der Befehl Active Flag?
  • Klicken Sie auf die Schaltfläche Regel
  • Klicken Sie im Wertefeld auf <> JSON File Iteration aus dem Dropdown-Menü des Group Iterator
  • Fügen Sie eine Variablentransformation hinzu und verwenden Sie als Wert die Überschrift Active_Flag aus dem Kontrollblatt
    • Annehmen
  • Ändern Sie die Bedingung von "ist leer" in "=".
  • Geben Sie das Wort "true" in das Ausdrucksfeld ein.
  • Speichern anklicken 

 

 

• Da das Active_Flag für zwei der Iterationen auf "FALSE" gesetzt war, wurde der Befehl Preview Control Sheet Data nur für die dritte Iteration ausgeführt.
• Befehle, die auf den bedingten Befehl "Active Flag?" folgen, werden übersprungen, wenn ihre Iteration im Kontrollblatt den Wert "FALSE" hat.

Zusätzliche Anwendungsfälle

Das Kontrollblatt bietet eine äußerst effektive Möglichkeit, die bei der Workflow-Ausführung verwendeten Werte zu zentralisieren, zu verwalten und zu automatisieren. Sie kann in verschiedenen Szenarien eingesetzt werden, unter anderem: 

• Ein zentraler Knotenpunkt für die Verwaltung von IDs eines Quellsystems, Workiva und Wdata-Elementen
• Verwendung einer Markierung zum Filtern und Ergreifen von Maßnahmen, ob ein bestimmter Prozess ausgeführt werden soll
• Angabe von URL-Endpunkten für die Ausführung von Berichten aus einem Quellsystem
• Festlegung von Daten und Namenskonventionen für bestimmte Dateien
• Identifizierung von Dateiverzeichnissen für ein SFTP zum Abrufen bestimmter Dateien