Tło
Organizując procesy raportowania za pomocą pakietu Data Management Suite, często napotykamy złożone scenariusze przepływu pracy. Na przykład, aplikacja może wymagać wykonania:
- Pojedynczy przepływ pracy wielokrotnie z różnymi danymi wejściowymi
- Wiele różnych przepływów pracy
- Kilka równoległych przepływów pracy, każdy z określonymi danymi wejściowymi
- Przepływy pracy integracji systemu źródłowego wymagające określonych parametrów, takich jak daty, nazwy plików lub nazwy reguł
Aby skutecznie zautomatyzować i zarządzać tymi skomplikowanymi wymaganiami dotyczącymi przepływu pracy, koncepcja arkusza kontrolnego okazuje się nieoceniona. Arkusz kontrolny działa jako scentralizowane narzędzie do zarządzania, które pozwala na wstępne zdefiniowanie danych wejściowych dla każdego wykonania przepływu pracy. Wykorzystując Control Sheets, użytkownicy mogą określić parametry i warunki, w których każdy przepływ pracy powinien działać, ułatwiając w ten sposób płynny, zautomatyzowany proces, który uruchamia wszystkie niezbędne przepływy pracy z odpowiednimi danymi wejściowymi bez potrzeby ręcznej interwencji na każdym etapie.
Tworząc i wykorzystując arkusz kontrolny, użytkownicy mogą
- Zdefiniuj wartości wejściowe, które będą przekazywane do łańcucha przy każdym wykonaniu
- Zdefiniuj flagi, które określą, czy łańcuch powinien wykonywać określone operacje
- Przekazuj wartości, takie jak parametry zapytania, nazwy reguł lub filtry daty, do przepływu pracy systemu podczas wykonywania łańcucha lub uruchamiania reguły.
- Wykonuj operacje przewijania do przodu
- Zarządzaj identyfikatorami ID dla artefaktów w Workiva
- Rejestruj status wykonania przepływu pracy
Ten artykuł poprowadzi użytkowników przez proces tworzenia prostego arkusza kontrolnego. Arkusz ten pozwoli użytkownikom na uruchomienie tego samego przepływu pracy z różnymi zestawami danych wejściowych.
Wymagania wstępne
- Skonfiguruj łącznik Workiva Connector
- Skonfiguruj konektor JSON
- Skonfiguruj złącze kierownicy
Krok 1: Konfiguracja arkusza kontrolnego
- Utwórz arkusz kalkulacyjny na platformie Workiva
- Przypisz uprawnienia własności do użytkownika powiązanego z grantem OAuth2.
- Zmień nazwę arkusza kalkulacyjnego i arkusza na
- Arkusz kalkulacyjny kontroli
- Arkusz kontrolny
Krok 2: Ustawianie nagłówków (kluczy) dla arkusza kontrolnego
Ustal nagłówki dla każdej wartości, która będzie przetwarzana przez przepływ pracy Chain. W tym przykładzie skonfigurowano następujące nagłówki:
- Active_Flag: Aby określić, czy ten wiersz powinien zostać przetworzony, czy nie
- File_Name: Nazwa pliku do przetworzenia
- Table_ID: ID tabeli Wdata, do której zostanie zaimportowany plik
Krok 3: Przypisz wartości do nagłówków w arkuszu kontrolnym
- W tym przykładzie zdefiniowano trzy wartości dla każdej pary klucz/wartość. W związku z tym, po odczytaniu każdego wiersza, podawane są następujące dane:
true, file_x.csv, df2a1988929e4358858306956685e162
true, file_y.csv, df2a1988929e4358858306956685e162
true, file_z.csv, df2a1988929e4358858306956685e162
Krok 4: Utwórz łańcuch do pobierania danych z arkusza kontrolnego
Aby pobrać dane arkusza kontrolnego z arkusza kalkulacyjnego, należy utworzyć łańcuch do odczytu arkusza kalkulacyjnego.
- Przejdź do modułu Łańcuchy i utwórz nowy łańcuch
- Przejdź do ustawień łańcucha i nadaj nazwę nowemu łańcuchowi Get Control Sheet Data
- Dodaj dwie zmienne Chain :
- cv-SpreadsheetID
- cv-SheetName
- Wypełnij każdą zmienną odpowiednimi wartościami SpreadsheetID i SheetName z arkusza kontrolnego.
Krok 5: Pobierz dane arkusza
Aby użyć danych w arkuszu kontrolnym, musisz użyć polecenia Get Sheet Data. Polecenie odczytuje zawartość arkusza w arkuszu kalkulacyjnym i tworzy plik wyjściowy .csv.
- Przeciągnij i upuść polecenie Workiva Get Sheet Data do sekcji START kanwy
- Skonfiguruj polecenie
- Zmień nazwę na Get Control Sheet Data
- Użyj zmiennej łańcuchowej cv-SpreadsheetID dla pola Spreadsheet ID
- Użyj zmiennej łańcuchowej cv-SheetName dla pola ID/Nazwa arkusza
- Wprowadź A1: dla regionu
- Pozostaw Style wartości i Revision jako Calculated i -1
- Kliknij Zapisz
Krok 6: Konwertowanie danych arkusza na JSON
Po pomyślnym pobraniu danych arkusza kontrolnego w formacie .csv, następnym krokiem jest przekonwertowanie ich na JSON. Ta konwersja zapewnia, że nagłówki i wartości kolumn są poprawnie sformatowane do struktury JSON Key-Value. Ten format jest kluczowy dla kolejnych kroków.
- Przeciągnij polecenie CSV to JSON na kanwę
- Połącz polecenie Get Control Sheet Data z poleceniem CSV to JSON
- Edytuj polecenie CSV to JSON
- W polu Input File użyj danych wyjściowych Data z listy rozwijanej Get Control Sheet Data
- Pozostaw pole Delimiter jako Przecinek (,)
- Kliknij Zapisz
Krok 7: Iteruj przez dane JSON
Teraz, gdy dane arkusza kontrolnego są w formacie JSON, można użyć grupy poleceń, aby iterować przez każdy wiersz danych w arkuszu kontrolnym
- Dodaj grupę poleceń do obszaru roboczego
- Połącz polecenie CSV to JSON z częścią grupy poleceń In
- Edytuj grupę poleceń i nadaj jej nazwę JSON Iterator
- Kliknij symbol iteracji po prawej stronie karty Informacje podstawowe
- Włącz iterator
- Pozostaw opcję Wybierz typ modyfikatora jako Lista
- W sekcji Iteracje wybierz dane wyjściowe <> Plik JSON z listy rozwijanej polecenia CSV to JSON
- Kliknij Zapisz
Krok 8: Podgląd każdej iteracji danych
Ponieważ łańcuch jest teraz w stanie iterować przez każdy wiersz arkusza kontrolnego, polecenie Handlebars może być wykorzystane do podglądu danych wyjściowych informacji.
Uwaga: Polecenie Handlebars służy jako symbol zastępczy do przeglądania wartości w tym artykule, ale inne polecenia mogą być również używane do przetwarzania wartości.
- Przeciągnij i upuść polecenie Renderuj szablon tekstowy na kanwę
- Połącz polecenie Group Start grupy poleceń z poleceniem Renderuj szablon tekstu
- Edytuj polecenie i nadaj mu nazwę Preview Control Sheet Data
- W polu Szablon wprowadź następujące dane:
Nazwa pliku ID tabeli aktywnej flagi
- Aby uzyskać wartości z arkusza kontrolnego, dla każdej iteracji JSON należy zastosować transformację zmiennej
- Obok File Name, wybierz JSON File Iteration z paska bocznego, znajdującego się pod rozwijaną listą Group Iterator.
-
- Kliknij na Iteracja pliku JSON, wybierz Pobierz wartość z JSON
- W polu Wartość wprowadź nagłówek File_Name z arkusza kontrolnego
- Uwaga: Dobrą praktyką jest kopiowanie nagłówka z arkusza kontrolnego bezpośrednio do pola wartości
- Naciśnij Enter i zaakceptuj
-
- Powtórz powyższe kroki dla nagłówków Active_Flag i Table_ID z arkusza kontrolnego
- Po wypełnieniu pole szablonu powinno wyglądać następująco:
- Zapisz polecenie
Krok 9: Uruchom łańcuch i wyświetl podgląd
Teraz, gdy łańcuch i arkusz kontrolny są skonfigurowane, ważne jest, aby upewnić się, że każda iteracja wyjścia Handlebar zawiera dane dla każdego wiersza w arkuszu kontrolnym.
- Kliknij na Publish, a następnie Execute łańcuch
- Uruchom łańcuch
- Po pomyślnym uruchomieniu łańcucha kliknij polecenie Preview Control Sheet Data i przejdź do zakładki Log
- W sekcji "Rozpocznij renderowanie tekstu" powinien być widoczny wynik pierwszej iteracji.
- Przełącz na Wartość 2 w opcji powyżej zakładki Dziennik, aby zobaczyć wyniki dla drugiej iteracji
- Na koniec przełącz się na wartość 3, aby zobaczyć wyniki trzeciej iteracji
- Każda iteracja powinna wyglądać następująco:
Wartość 1:
Wartość 2:
Wartość 3:
Wykorzystaj aktywną flagę
Włączenie logiki Conditional, która wykorzystuje wartość Active Flag jest kolejnym krokiem, przy użyciu tego samego łańcucha, który został zbudowany.
- Edytuj łańcuch i usuń powiązanie między Iteratorem JSON a Arkuszem kontrolnym podglądu danych
- Dodaj polecenie Conditional i połącz Group Start grupy poleceń z nowym poleceniem
- Połącz polecenie Conditional z poleceniem Preview Control Sheet Data
- Edytuj polecenie warunkowe
- Nazwij polecenie Active Flag?
- Kliknij przycisk + Rule
- W polu wartości kliknij Iteracja pliku <> JSON z listy rozwijanej Iteratora grupy
- Dodaj transformację zmiennej i użyj nagłówka Active_Flag z arkusza kontrolnego jako wartości
- Kliknij przycisk Akceptuj
- Zmień warunek z "Is Blank" na "="
- Wprowadź słowo "true" w polu wyrażenia
- Kliknij przycisk Zapisz
Teraz, przy każdym uruchomieniu łańcucha, polecenie Preview Control Sheet Data zostanie wykonane tylko wtedy, gdy wartość Active_Flag w danej iteracji będzie równa true.
- Ponieważ flaga Active_Flag dla dwóch iteracji była ustawiona na "FALSE", polecenie Preview Control Sheet Data zostało wykonane tylko dla trzeciej iteracji.
- Polecenia następujące po poleceniu warunkowym "Active Flag?" zostaną pominięte, jeśli ich iteracja w arkuszu kontrolnym ma wartość "FALSE".
Dodatkowe przypadki użycia
Control Sheet oferuje wysoce efektywny sposób centralizacji, zarządzania i automatyzacji wartości wykorzystywanych w realizacji przepływu pracy. Może być stosowany w różnych scenariuszach, w tym:
- Centralne centrum zarządzania identyfikatorami systemu źródłowego, elementów Workiva i Wdata
- Wykorzystanie flagi do filtrowania i podejmowania działań, czy określony proces powinien zostać wykonany
- Określanie punktów końcowych URL do wykonywania raportów z systemu źródłowego
- Definiowanie dat i konwencji nazewnictwa dla określonych plików
- Identyfikacja katalogów plików dla SFTP w celu pobrania wyznaczonych plików