Deze handleiding biedt stapsgewijze instructies voor het implementeren van de sjabloon Query uitvoeren en resultaten downloaden met besturingsblad . Deze sjabloon dient als alternatief voor de Run Query opdracht, waarbij gebruikers voorheen handmatig parameters in ketens moesten invoeren vóór de implementatie en uitvoering.
Met behulp van een besturingsblad kunnen gebruikers meerdere query-ID's toevoegen en parameters definiëren, zoals Keuzelijst of Meervoudige selectie , dynamisch. Deze sjabloon wordt vaak geïntegreerd in bestaande ketens, maar kan ook worden gebruikt in elke workflow die queryresultaten in CSV-formaat vereist.
Voorwaarden
De volgende connectoren moeten in uw werkruimte zijn ingeschakeld en geconfigureerd.
- Configureer de Workiva Connector
- Configureer de JSON-connector
- Configureer de Handlebars Connector
- Configureer de HTTP-aanvraagconnector
- Configureer de Tabular Transformation Connector
De volgende werkruimtevariabelen moeten binnen uw werkruimte worden aangemaakt:
- wsv_API Basis-URL - IAM
- wsv_Client-ID
- wsv_Client-geheim
- wsv_API Basis-URL - Wdata
Zoek de sjabloon
De sjabloon Query uitvoeren en resultaten downloaden met besturingsblad bevindt zich in het gedeelte Workiva Chains van het scherm Sjablonen .
Zo vind je het:
- Ga in Chain Builder naar het tabblad Templates
- Selecteer Workiva Chains in het menu bovenaan.
- Zoek naar 0.0 Voer een query uit | Orchestratie op het hoogste niveau rechtsboven en open de sjabloon.
-
Nadat je de sjabloon hebt gevonden, klik je op Nieuwe keten om deze in je werkruimte te implementeren.
Opmerking: Zodra geconfigureerd, moet elke keten in deze sjabloon naar de werkruimte worden gepubliceerd.
Variabelen
| Variabel type | Variabelenaam | Beschrijving |
|---|---|---|
| Werkruimtevariabele | wsv_API Basis-URL - IAM |
Voer de basis-URL voor de API in op basis van uw regio:
|
| Werkruimtevariabele | wsv_Client-ID |
Voer de client-ID in die u ontvangt bij het instellen van een API-toekenning. Zie hier voor meer instructies voor de Workiva API. |
| Werkruimtevariabele | wsv_Client-geheim |
Je kunt je API-grantgeheim bekijken door naar het tabblad Beveiliging in je gebruikersprofiel te gaan en vervolgens op de optie Opnieuw genereren te klikken in het vervolgkeuzemenu Acties naast de grant. Zie hier voor meer instructies voor de Workiva API |
| Werkruimtevariabele | wsv_API Basis-URL - Wdata |
Voer de basis-URL voor de API in op basis van uw regio: |
Runtime-invoer
| Runtime-invoer | Doel | Veldtype | Vereist |
|---|---|---|---|
| Spreadsheet-ID | Hier bevindt zich het controle-spreadsheet. | Tekst | Ja |
| Blad-ID | Hier bevindt zich het bedieningspaneel. | Tekst | Ja |
Configureer de sjabloon
Deze sjabloon bestaat uit twee ketens, de 0.0 Een query uitvoeren | Orchestratie op het hoogste niveau en de 0.1 Een query uitvoeren | Resultaten downloaden . Wanneer de primaire keten in uw werkruimte wordt geïmplementeerd, wordt de ketenketen automatisch mee geïmplementeerd.
- Orchestratie op het hoogste niveau : Op basis van de informatie uit het besturingsblad bepaalt deze keten of een query één parametertype gebruikt (ofwel Keuzelijst of Meervoudige selectie ) of meerdere parametertypen (zowel Keuzelijst als Meervoudige selectie ).
- Voer een query uit | Download resultaten: Deze keten voert een query uit met de opgegeven parameters en haalt de bijbehorende gegevens op. Zodra de query is uitgevoerd, worden de resultaten gedownload in CSV-formaat voor verdere analyse of gebruik.
Zodra het controleblad is geconfigureerd en de ketensjabloon in uw werkruimte is geïmplementeerd, hebt u alleen nog de Spreadsheet-ID en Blad-ID van het controleblad nodig.
Deze waarden moeten worden toegevoegd als runtime-inputs voor de topniveau-orkestratieketen .
Configuratie van het bedieningspaneel per parametertype
De manier waarop u het configuratiescherm instelt, hangt af van de parametertypen die in uw Wdata-query zijn gedefinieerd. Als een query meerdere parametertypen bevat ( bijvoorbeeld zowel keuzelijst als meerkeuze ) , moet elke parameter op een aparte regel worden gedefinieerd met dezelfde query - ID. Als een query slechts één parametertype gebruikt, vereist het besturingsblad één rij voor die query.
De onderstaande voorbeelden illustreren beide scenario's.
Voorbeeld: Query met meerdere parametertypen
Voor een query die zowel Keuzelijst als Meervoudige selectie parameters vereist, moet het besturingsblad aparte rijen bevatten voor elke parameter , die allemaal dezelfde query-ID gebruiken.
Opmerking: De Sleutel kolom verwijst naar de Parameternaam gedefinieerd in de Wdata-query.
Voorbeeldconfiguratie:
| Zoek-ID | type | Sleutel | Waarden |
|---|---|---|---|
| Wdata-query-ID | Keuzelijstparameters | Jaar | Geef één standaardwaarde op (bijv. 2023 ). |
| Wdata-query-ID | Meerdere selectieparameters | Accounttype | Voer meerdere acceptabele waarden in, gescheiden door komma's (bijv. Activa, Kosten, Eigen vermogen, Omzet ). |
Voorbeeld: Query met één parametertype
Voor een query die slechts één parametertype gebruikt , moet het besturingsblad één rij bevatten voor die query-ID.
Als de query bijvoorbeeld alleen een Keuzelijst parameter gebruikt:
| Zoek-ID | type | Sleutel | Waarden |
|---|---|---|---|
| Wdata-query-ID | Keuzelijstparameters | Jaar | Geef één standaardwaarde op (bijv. januari ). |
Zorg ervoor dat het configuratieblad correct is ingesteld, aangezien een onjuiste configuratie tot problemen verderop in het proces kan leiden.
Gegevens in een tabel laden
Je kunt het proces van het direct laden van je output in een tabel automatiseren. Om de uitvoergegevens in een tabel te laden, kunt u de sjabloon " Load Data to Wdata " gebruiken. Dit kan worden geactiveerd als onderdeel van uw proces door een Run Chain-gebeurtenis toe te voegen aan de HTTP-connector die de resultaten downloadt.
Probleemoplossing
Om uw kettingloopgeschiedenis te bekijken, inclusief fouten:
- Ga naar het tabblad Monitor in Chain Builder.
-
Beweeg de muis over het vraagteken om de status van de kettingrun te bekijken.
Als er tijdens het uitvoeren van een query een fout is opgetreden of als het downloaden van een queryresultaat is mislukt, voer dan de volgende controles uit:
- Controleer of beide ketens in uw werkruimte zijn gepubliceerd. Elke keten moet afzonderlijk worden gepubliceerd.
- Zorg ervoor dat de query in Wdata is bijgewerkt naar de nieuwste versie.
- Zorg er bij het invoeren van de Query ID , Type, Keys en Value in het besturingsblad voor dat de volledige ID is ingevoerd en dat er geen spaties aan het begin of einde staan. Controleer ook of de sleutels en waarden correct overeenkomen met de parameters die in Wdata worden gebruikt.
- Zorg ervoor dat de OAuth2-toekenning die is gekoppeld aan de Workiva-verbinding de juiste toegang heeft.
- Zorg ervoor dat alle parameters die in een query worden gebruikt, in het besturingsblad zijn opgenomen.
Aanvullende bronnen
- Workiva-connector
- Connector voor bestandshulpprogramma's
- JSON-connector
- Connector voor tabeltransformatie
- Voer een keten uit binnen een andere keten ("Run Chain events")
- OAuth2-toekenningen
- Wdata-functie en API-limieten