Den här guiden innehåller steg-för-steg-instruktioner för att implementera mallen Kör fråga och hämta resultat med kontrollblad . Den här mallen fungerar som ett alternativ till kommandot Run Query , som tidigare krävde att användare manuellt angav parametrar i kedjor före distribution och körning.
Med hjälp av ett kontrollblad kan användare lägga till flera fråge-ID:n och definiera parametrar, till exempel Pick-list eller Multi-select , dynamiskt. Den här mallen integreras vanligtvis i befintliga kedjor men kan också användas i alla arbetsflöden som kräver frågeresultat i CSV-format .
Förkunskapskrav
Följande kopplingar måste vara aktiverade och konfigurerade i din arbetsyta.
- Konfigurera Workiva Connector
- Konfigurera JSON-anslutning
- Konfigurera Styrets kontaktdon
- Konfigurera HTTP-förfrågningsanslutningen
- Konfigurera Tabelltransformationskopplingen
Följande arbetsytevariabler måste skapas i din arbetsyta:
- wsv_API Bas URL - IAM
- wsv_Klient-ID
- wsv_Klienthemlighet
- wsv_API Bas URL - Wdata
Hitta mallen
Mallen Kör fråga och ladda ner resultat med kontrollblad finns i avsnittet Workiva-kedjor på skärmen Mallar .
Så här hittar du den:
- I Chain Builder går du till fliken Templates .
- Välj Workiva Chains från menyn högst upp.
- Sök efter 0.0 Kör en fråga | Orkestrering på högsta nivå längst upp till höger och öppna mallen.
-
När du har hittat mallen klickar du på New Chain för att distribuera den till din arbetsyta.
Obs: När varje kedja i den här mallen har konfigurerats måste den publiceras på arbetsytan.
Variabler
| Variabel typ | Variabelns namn | Beskrivning |
|---|---|---|
| Variabel för arbetsyta | wsv_API Bas URL - IAM |
Ange bas-URL:en för API:et baserat på din region:
|
| Variabel för arbetsyta | wsv_Klient-ID |
Ange klient-ID:t som du får när du konfigurerar ett API-tilldelning. Se här för fler instruktioner för Workiva API. |
| Variabel för arbetsyta | wsv_Klienthemlighet |
Du kan se din API-tilldelningshemlighet genom att gå till fliken Säkerhet i din användarprofil och sedan klicka på alternativet Återskapa i rullgardinsmenyn Åtgärder bredvid tilldelningen. Se här för fler instruktioner för Workiva API |
| Variabel för arbetsyta | wsv_API Bas URL - Wdata |
Ange bas-URL:en för API:et baserat på din region:
|
Exekveringsingångar
| Inmatning vid exekvering | Syfte | Typ av fält | Krävs |
|---|---|---|---|
| Kalkylbladets ID | Det är här kontrollbladet finns. | Text | Ja |
| Ark-ID | Det är här kontrollbladet finns. | Text | Ja |
Konfigurera mallen
Den här mallen består av två kedjor, 0.0 Kör en fråga | Orkestrering på högsta nivå och 0.1 Kör en fråga | Ladda ner resultat . När den primära kedjan distribueras i din arbetsyta distribueras kedjekedjan automatiskt med den.
- Toppnivåorkestrering : Baserat på informationen från kontrollbladet avgör denna kedja om en fråga använder en enda parametertyp (antingen Väljlista eller Flerval ) eller flera parametertyper (både Väljlista och Flerval ).
- Kör en fråga | Ladda ner resultat: Den här kedjan kör en fråga med de angivna parametrarna och hämtar motsvarande data. När frågan har körts laddas resultaten ner i CSV-format för vidare analys eller användning.
När kontrollarket har konfigurerats och kedjemallen har distribuerats i din arbetsyta, behöver du bara kontrollarkets kalkylblads-ID och ark-ID .
Dessa värden måste läggas till som runtime-indata för Top-Level Orchestration-kedjan .
Konfiguration av kontrollark efter parametertyp
Hur du konfigurerar kontrollarket beror på de parametertyper som definierats i din Wdata-fråga. Om en fråga innehåller flera parametertyper (till exempel både Pick List och Multi-Select ), måste varje parameter definieras på en separat rad med samma fråge-ID . Om en fråga använder endast en parametertyp , kräver kontrollbladet en enda rad för den frågan.
Exemplen nedan illustrerar båda scenarierna.
Exempel: Fråga med flera parametertyper
För en fråga som kräver både parametrarna Pick List och Multi-Select bör kontrollbladet innehålla separata rader för varje parameter , alla med samma fråge-ID .
Obs: Kolumnen Nyckel refererar till Parameternamn som definierats i Wdata-frågan.
Exempel på konfiguration:
| ID för förfrågan | Typ | Nyckel | Värden |
|---|---|---|---|
| Wdata-fråge-ID | Parametrar för plocklista | År | Ange ett enda standardvärde (t.ex. 2023 ). |
| Wdata-fråge-ID | Multivalsparametrar | Kontotyp | Ange flera acceptabla värden, kommaavgränsade (t.ex. Tillgång, Kostnad, Eget kapital, Intäkt ). |
Exempel: Fråga med en enda parametertyp
För en fråga som endast använder en parametertyp bör kontrollarket innehålla en enda rad för det fråge-ID:t.
Om till exempel frågan bara använder parametern Pick List :
| ID för förfrågan | Typ | Nyckel | Värden |
|---|---|---|---|
| Wdata-fråge-ID | Parametrar för plocklista | År | Ange ett enda standardvärde (t.ex. januari ). |
Se till att kontrollbladet är korrekt konfigurerat, eftersom felaktig konfiguration kan leda till problem nedströms.
Läser in data i en tabell
Du kan automatisera processen att ladda dina utdata direkt i en tabell. För att läsa in utdata i en tabell kan du använda mallen " Ladda data till Wdata " . Detta kan utlösas som en del av din process genom att lägga till en Run Chain-händelse vid HTTP-anslutningen som laddar ner resultaten.
Felsökning
För att se din kedjekörningshistorik, inklusive fel:
- Gå till fliken Monitor i Chain Builder.
-
Håll muspekaren över frågetecknet för att se status för kedjekörningen.
Om din kedja utlöste ett fel eller misslyckades med att ladda ner ett frågeresultat, utför följande kontroller:
- Kontrollera att båda kedjorna har publicerats till din arbetsyta. Varje kedja måste publiceras separat.
- Se till att frågan i Wdata är uppdaterad till den senaste versionen.
- När du anger Fråge-ID , Typ, Nycklar och Värde i kontrollbladet , se till att hela ID:t har angetts och att det inte finns några inledande eller efterföljande mellanslag. Bekräfta också att nycklarna och värdena korrekt matchar parametrarna som används i Wdata.
- Se till att OAuth2-behörigheten som är associerad med Workiva-anslutningen har korrekt åtkomst.
- Se till att alla parametrar som används i en fråga finns med i kontrollbladet.
Ytterligare resurser
- Workiva-kontakt
- Anslutningsdon för filverktyg
- JSON-anslutning
- Tabulär transformationsanslutning
- Kör en kedja inom en annan kedja ("Run Chain events")
- OAuth2-bidrag
- Wdata-funktioner och API-gränser