Questa guida fornisce istruzioni dettagliate per implementare il template Esegui query e scarica i risultati con il foglio di controllo. Questo template è un'alternativa al comando Esegui query, che in precedenza richiedeva agli utenti di inserire manualmente i parametri nelle catene prima della distribuzione e dell'esecuzione.
Con l'uso di un foglio di controllo, gli utenti possono aggiungere più ID query e definire parametri, come Elenco a scelta o Selezione multipla, in modo dinamico. Questo template è comunemente integrato nelle catene esistenti, ma può essere utilizzato anche in qualsiasi flusso di lavoro che richieda risultati di query in formato CSV.
Prerequisiti
I seguenti connettori devono essere abilitati e configurati nel tuo workspace.
- Configura il connettore Workiva
- Configura il connettore JSON
- Configura il connettore Handlebars
- Configura il connettore di richiesta HTTP
- Configura il connettore di trasformazione tabellare
Le seguenti variabili del workspace devono essere create all'interno del tuo workspace:
- URL di base wsv_API - IAM
- wsv_Client ID
- wsv_Client Secret
- URL di base di wsv_API - Wdata
Trova il template
Il template Esegui query e scarica i risultati con il foglio di controllo si trova nella sezione Catene di Workiva della schermata Template.
Ecco come trovarlo:
- In Generatore di catene, accedi alla scheda Template .
- Seleziona Catene di Workiva dal menu in alto.
- Cerca 0.0 Execute a Query | Top-Level Orchestration in alto a destra e apri il template.
-
Dopo aver individuato il template, fai clic su Nuova catena per distribuirlo nel tuo workspace.
Nota: una volta configurata, ogni catena di questo template deve essere pubblicata nel workspace.
Variabili
| Tipo di variabile | Nome della variabile | Descrizione |
|---|---|---|
| Variabile del workspace | URL di base wsv_API - IAM |
Inserisci l'URL di base per l'API in base alla tua area geografica:
|
| Variabile del workspace | wsv_Client ID |
Inserisci l'ID client che ricevi quando configuri una sovvenzione API. Consulta qui per ulteriori istruzioni sull'API Workiva. |
| Variabile del workspace | wsv_Client Secret |
Puoi visualizzare il segreto della tua sovvenzione API andando alla scheda Sicurezza nel tuo profilo utente e facendo clic sull'opzione Rigenera nel menu a discesa Azioni accanto alla sovvenzione. Consulta qui per ulteriori istruzioni sull'API Workiva. |
| Variabile del workspace | URL di base di wsv_API - Wdata |
Inserisci l'URL di base per l'API in base alla tua area geografica: |
Input di runtime
| Input di runtime | Scopo | Tipo di campo | Obbligatorio |
|---|---|---|---|
| ID del foglio di calcolo | Qui si trova il foglio di calcolo di controllo. | Testo | Sì |
| ID foglio | Qui si trova il foglio di controllo. | Testo | Sì |
Configura il template
Questo template è composto da due catene: 0.0 Execute a Query | Top-Level Orchestration e 0.1 Execute a Query | Download Results. Quando la catena principale viene distribuita nel tuo workspace, la catena viene distribuita automaticamente insieme a essa.
- Top-Level Orchestration: in base alle informazioni del foglio di controllo, questa catena determina se una query utilizza un singolo tipo di parametro (Elenco a scelta o Selezione multipla) oppure più tipi di parametro (sia Elenco a scelta che Selezione multipla).
- Execute a Query | Download Results: questa catena esegue una query utilizzando i parametri specificati e recupera i dati corrispondenti. Una volta eseguita la query, i risultati vengono scaricati in formato CSV per ulteriori analisi o usi.
Una volta che il foglio di controllo è configurato e il template catena è distribuito nel tuo workspace, ti servono solo l'ID del foglio di calcolo e l'ID foglio del foglio di controllo.
Questi valori devono essere aggiunti come input di runtime per la catena Top-Level Orchestration.
Configurazione del foglio di controllo per tipo di parametro
Il modo in cui configuri il foglio di controllo dipende dai tipi di parametro definiti nella query Wdata. Se una query include più tipi di parametro (ad esempio, sia Elenco a scelta che Selezione multipla), ogni parametro deve essere definito in una riga separata utilizzando lo stesso ID query. Se una query utilizza un solo tipo di parametro, il foglio di controllo richiede una singola riga per quella query.
Gli esempi seguenti illustrano entrambi gli scenari.
Esempio: query con più tipi di parametro
Per una query che richiede sia parametri di tipo Elenco a scelta che di tipo Selezione multipla, il foglio di controllo deve includere righe separate per ogni parametro, tutte con lo stesso ID query.
Nota: la colonna Chiave fa riferimento al Nome parametro definito nella query Wdata.
Esempio di configurazione:
| ID query | Tipo | Chiave | Valori |
|---|---|---|---|
| ID query Wdata | Parametri-Elenco-a-scelta | Anno | Specifica un singolo valore predefinito (ad es. 2023). |
| ID query Wdata | Parametri-Selezione-multipla | Tipo di account | Inserisci più valori accettabili, separati da virgola (ad es. Attività, Spese, Patrimonio netto, Ricavi). |
Esempio: query con un singolo tipo di parametro
Per una query che utilizza solo un tipo di parametro, il foglio di controllo deve contenere una singola riga per quell'ID query.
Ad esempio, se la query utilizza solo un parametro di tipo Elenco a scelta:
| ID query | Tipo | Chiave | Valori |
|---|---|---|---|
| ID query Wdata | Parametri-Elenco-a-scelta | Anno | Specifica un singolo valore predefinito (ad es. Gennaio). |
Assicurati che il foglio di controllo sia configurato correttamente, poiché una configurazione errata potrebbe causare problemi a valle.
Caricamento dei dati in una tabella
Puoi automatizzare il processo di caricamento dell'output direttamente in una tabella. Per caricare i dati di output in una tabella, valuta l'utilizzo del template "Carica dati in Wdata". Puoi attivarlo come parte del tuo processo aggiungendo un evento Esegui catena al connettore HTTP che scarica i risultati.
Risoluzione dei problemi
Per visualizzare la cronologia dell'esecuzione della catena, compresi gli errori:
- Vai alla scheda Monitor di Generatore di catene.
-
Passa il mouse sul punto interrogativo per visualizzare lo stato dell'esecuzione della catena.
Se la tua catena ha generato un errore o non è riuscita a scaricare il risultato di una query, esegui i controlli seguenti:
- Verifica che entrambe le catene siano state pubblicate nel tuo workspace. Ogni catena deve essere pubblicata separatamente.
- Assicurati che la query in Wdata sia aggiornata all'ultima versione.
- Quando inserisci l'ID query, il tipo, le chiavi e il valore nel foglio di controllo, assicurati che l'ID completo sia stato inserito e che non ci siano spazi vuoti iniziali o finali. Verifica inoltre che le chiavi e i valori corrispondano esattamente ai parametri utilizzati in Wdata.
- Assicurati che la sovvenzione OAuth2 associata alla connessione Workiva abbia un accesso appropriato.
- Assicurati che tutti i parametri utilizzati in una query siano inclusi nel foglio di controllo.
Risorse aggiuntive
- Connettore Workiva
- Connettore Utilità dei file
- Connettore JSON
- Connettore Trasformazione tabellare
- Esegui una catena all'interno di un'altra catena ("Esegui eventi a catena")
- Sovvenzioni OAuth2
- Limiti delle funzioni e delle API di Wdata