W tym przewodniku znajdują się instrukcje krok po kroku dotyczące wdrażania szablonu Uruchom zapytanie i pobierz wyniki za pomocą arkusza kontrolnego . Ten szablon stanowi alternatywę dla polecenia Run Query , które wcześniej wymagało od użytkowników ręcznego wprowadzania parametrów w łańcuchach przed wdrożeniem i wykonaniem.
Za pomocą arkusza sterowania użytkownicy mogą dynamicznie dodawać wiele identyfikatorów zapytań i definiować parametry, takie jak Lista wyboru lub Wybór wielokrotny . Ten szablon jest powszechnie integrowany z istniejącymi łańcuchami, ale można go również używać w dowolnym przepływie pracy wymagającym wyników zapytania w formacie CSV .
Wymagania wstępne
Następujące łączniki muszą być włączone i skonfigurowane w Twojej przestrzeni roboczej.
- Skonfiguruj łącznik Workiva
- Skonfiguruj łącznik JSON
- Skonfiguruj Złącze kierownicy
- Skonfiguruj łącznik żądań HTTP
- Skonfiguruj Złącze transformacji tabelarycznej
Następujące zmienne obszaru roboczego muszą zostać utworzone w obszarze roboczym:
- wsv_API Podstawowy adres URL — IAM
- Identyfikator klienta wsv
- wsv_Client Secret
- wsv_API Podstawowy adres URL — Wdata
Znajdź szablon
Szablon Uruchom zapytanie i pobierz wyniki z arkuszem kontrolnym znajduje się w sekcji Łańcuchy Workiva ekranu Szablony .
Oto jak to znaleźć:
- W Chain Builder przejdź do zakładki Szablony
- Wybierz Łańcuchy Workiva z menu u góry.
- Wyszukaj 0.0 Wykonaj zapytanie | Orkiestracja najwyższego poziomu w prawym górnym rogu i otwórz szablon.
-
Po zlokalizowaniu szablonu kliknij Nowy łańcuch , aby wdrożyć go w obszarze roboczym.
Uwaga: Po skonfigurowaniu każdy łańcuch w tym szablonie musi zostać opublikowany w obszarze roboczym.
Zmienne
| Typ zmiennej | Nazwa zmiennej | Opis |
|---|---|---|
| Zmienna obszaru roboczego | wsv_API Podstawowy adres URL — IAM |
Wprowadź adres URL bazowy interfejsu API na podstawie swojego regionu:
|
| Zmienna obszaru roboczego | Identyfikator klienta wsv |
Wprowadź identyfikator klienta, który otrzymasz podczas konfiguracji przyznania interfejsu API. Więcej instrukcji dotyczących interfejsu API Workiva znajdziesz tutaj . |
| Zmienna obszaru roboczego | wsv_Client Secret |
Możesz wyświetlić tajny klucz przyznanego interfejsu API, przechodząc do karty Bezpieczeństwo w swoim profilu użytkownika, a następnie klikając opcję Wygeneruj ponownie na liście rozwijanej Akcje obok przyznanego klucza. Więcej instrukcji dotyczących interfejsu API Workiva znajdziesz tutaj |
| Zmienna obszaru roboczego | wsv_API Podstawowy adres URL — Wdata |
Wprowadź adres URL bazowy interfejsu API na podstawie swojego regionu:
|
Wejścia w czasie wykonywania
| Dane wejściowe środowiska wykonawczego | Zamiar | Typ pola | Wymagane |
|---|---|---|---|
| Identyfikator arkusza kalkulacyjnego | Tutaj znajduje się arkusz kalkulacyjny kontrolny. | Tekst | Tak |
| Identyfikator arkusza | Tutaj znajduje się arkusz kontrolny. | Tekst | Tak |
Skonfiguruj szablon
Ten szablon składa się z dwóch łańcuchów: 0.0 Wykonaj zapytanie | Orkiestracja najwyższego poziomu i 0.1 Wykonaj zapytanie | Pobierz wyniki . Po wdrożeniu łańcucha podstawowego w obszarze roboczym automatycznie wdrażany jest również cały łańcuch.
- Orkiestracja najwyższego poziomu : Na podstawie informacji z arkusza sterowania łańcuchy te określają, czy zapytanie używa pojedynczego typu parametru ( Lista wyboru lub Wybór wielokrotny ) czy wielu typów parametrów (zarówno Lista wyboru , jak i Wybór wielokrotny ).
- Wykonaj zapytanie | Pobierz wyniki: Ten łańcuch uruchamia zapytanie przy użyciu określonych parametrów i pobiera odpowiadające im dane. Po wykonaniu zapytania wyniki zostaną pobrane w formacie CSV w celu dalszej analizy lub wykorzystania.
Po skonfigurowaniu arkusza kontrolnego i wdrożeniu szablonu łańcucha w obszarze roboczym potrzebne są jedynie identyfikator arkusza kalkulacyjnego i identyfikator arkusza kontrolnego .
Wartości te muszą zostać dodane jako dane wejściowe środowiska wykonawczego dla łańcucha orkiestracji najwyższego poziomu .
Konfiguracja arkusza kontrolnego według typu parametru
Sposób konfiguracji arkusza sterowania zależy od typów parametrów zdefiniowanych w zapytaniu Wdata. Jeżeli zapytanie obejmuje wiele typów parametrów (na przykład zarówno Lista wyboru , jak i Wybór wielokrotny ), każdy parametr musi zostać zdefiniowany w oddzielnym wierszu przy użyciu tego samego identyfikatora zapytania . Jeżeli zapytanie używa tylko jednego typu parametru , arkusz kontrolny wymaga pojedynczego wiersza dla tego zapytania.
Poniższe przykłady ilustrują oba scenariusze.
Przykład: zapytanie z wieloma typami parametrów
W przypadku zapytania wymagającego parametrów Pick List i Multi-Select arkusz kontrolny powinien zawierać oddzielne wiersze dla każdego parametru , wszystkie używające tego samego identyfikatora zapytania .
Uwaga: Kolumna Klucz odnosi się do nazwy parametru zdefiniowanej w zapytaniu Wdata.
Przykładowa konfiguracja:
| Identyfikator zapytania | Typ | Klucz | Wartości |
|---|---|---|---|
| Identyfikator zapytania Wdata | Parametry listy wyboru | Rok | Określ pojedynczą wartość domyślną (np. 2023 ). |
| Identyfikator zapytania Wdata | Parametry wielokrotnego wyboru | Typ konta | Wprowadź wiele dopuszczalnych wartości, rozdzielonych przecinkami (np. Aktywa, Koszty, Kapitał własny, Przychody ). |
Przykład: zapytanie z pojedynczym typem parametru
W przypadku zapytania wykorzystującego tylko jeden typ parametru arkusz kontrolny powinien zawierać pojedynczy wiersz dla tego identyfikatora zapytania.
Na przykład, jeśli zapytanie używa tylko parametru Pick List :
| Identyfikator zapytania | Typ | Klucz | Wartości |
|---|---|---|---|
| Identyfikator zapytania Wdata | Parametry listy wyboru | Rok | Podaj jedną wartość domyślną (np. styczeń ). |
Upewnij się, że arkusz kontrolny jest poprawnie skonfigurowany, gdyż nieprawidłowa konfiguracja może prowadzić do problemów w dalszej części procesu.
Ładowanie danych do tabeli
Możesz zautomatyzować proces ładowania danych wyjściowych bezpośrednio do tabeli. Aby załadować dane wyjściowe do tabeli, rozważ użycie szablonu " Załaduj dane do Wdata " . Można to uruchomić w ramach procesu, dodając zdarzenie Run Chain w łączniku HTTP, które pobiera wyniki.
Rozwiązywanie problemów
Aby wyświetlić historię przebiegów łańcucha, w tym błędy:
- Przejdź do zakładki Monitor w Chain Builder.
-
Umieść kursor nad znakiem zapytania, aby wyświetlić status przebiegu łańcucha.
Jeżeli łańcuch wywołał błąd lub nie udało się pobrać wyniku zapytania, wykonaj następujące sprawdzenia:
- Sprawdź, czy oba łańcuchy zostały opublikowane w Twojej przestrzeni roboczej. Każdy łańcuch musi zostać opublikowany osobno.
- Upewnij się, że zapytanie w Wdata zostało zaktualizowane do najnowszej wersji.
- Podczas wprowadzania Identyfikatora zapytania , Typu, Kluczy i Wartości w arkuszu sterowania należy upewnić się, że wprowadzono cały identyfikator i nie ma na nim żadnych spacji na początku ani na końcu. Sprawdź również, czy klucze i wartości odpowiadają parametrom używanym w Wdata.
- Upewnij się, że uprawnienie OAuth2 powiązane z połączeniem Workiva ma odpowiedni dostęp.
- Upewnij się, że wszystkie parametry użyte w zapytaniu znajdują się w arkuszu sterowania.
Dodatkowe zasoby
- Złącze Workiva
- Łącznik File Utilities
- Łącznik JSON
- Łącznik transformacji tabelarycznej
- Uruchom łańcuch w innym łańcuchu („Uruchom zdarzenia łańcucha”)
- Udzielanie uprawnień OAuth2
- Funkcja Wdata i ograniczenia API