Background
Quando orchestriamo i processi di reporting utilizzando la Data Management Suite, spesso ci imbattiamo in scenari di flusso di lavoro complessi. Ad esempio, un'applicazione può avere bisogno di eseguire:
- Un singolo flusso di lavoro più volte con vari input
- Più flussi di lavoro distinti
- Diversi flussi di lavoro simultanei, ciascuno con input specifici
- Flussi di lavoro di integrazione del sistema sorgente che richiedono parametri specifici, come date, nomi di file o nomi di regole
Per automatizzare e gestire in modo efficiente questi intricati requisiti del flusso di lavoro, il concetto di foglio di controllo si rivela prezioso. Un foglio di controllo funge da strumento di gestione centralizzato che consente di predefinire gli input per l'esecuzione di ogni flusso di lavoro. Sfruttando i fogli di controllo, gli utenti possono specificare i parametri e le condizioni in base ai quali ogni flusso di lavoro deve funzionare, facilitando così un processo automatizzato e continuo che esegue tutti i flussi di lavoro necessari con gli input appropriati senza la necessità di un intervento manuale in ogni fase.
Creando e sfruttando un foglio di controllo, gli utenti possono:
- Definire i valori di input che verranno passati a una catena ad ogni esecuzione
- Definire i flag che determinano se una catena deve eseguire determinate operazioni
- Inserisci valori, come parametri di query, nomi di regole o filtri di data, nel flusso di lavoro del sistema quando esegui una catena o una regola.
- Eseguire parti delle operazioni di roll-forward
- Gestisci gli ID per gli artefatti all'interno di Workiva
- Registrare lo stato di esecuzione di un flusso di lavoro
Questo articolo guida gli utenti alla creazione di un semplice foglio di controllo. Questo foglio permetterà agli utenti di eseguire lo stesso flusso di lavoro con diversi tipi di input.
Prerequisiti
- Configura il connettore Workiva
- Configura il connettore JSON
- Configurare il connettore Handlebars
Passo 1: Impostazione di un foglio di controllo
- Crea un foglio di controllo all'interno della piattaforma Workiva
- Assegna i permessi di proprietà all'utente associato alla concessione OAuth2.
- Rinomina il foglio di calcolo e il foglio come
- Foglio di controllo
- Foglio di controllo
Passo 2: Impostazione delle intestazioni (chiavi) per il foglio di controllo
Stabilisci le intestazioni per ogni valore che verrà elaborato dal flusso di lavoro a catena. In questo esempio, vengono impostate le seguenti intestazioni:
- Active_Flag: Per determinare se questa riga deve essere elaborata o meno
- Nome_file: Nome del file da elaborare
- Table_ID: ID della tabella Wdata in cui verrà importato il file
Passo 3: Assegnare i valori alle intestazioni del foglio di controllo
- In questo esempio, sono stati definiti tre valori per ogni coppia Chiave/Valore. Pertanto, quando ogni riga viene letta, vengono immessi i seguenti dati:
true, file_x.csv, df2a1988929e4358858306956685e162
true, file_y.csv, df2a1988929e4358858306956685e162
true, file_z.csv, df2a1988929e4358858306956685e162
Passo 4: creare una catena per recuperare i dati del foglio di controllo
Per recuperare i dati del foglio di controllo dal foglio di calcolo, è necessario creare una catena per leggere il foglio di calcolo.
- Vai al modulo Catene e crea una nuova catena
- Naviga nelle impostazioni della catena e dai un titolo alla tua nuova catena Ottieni i dati del foglio di controllo
- Aggiungi due variabili della catena :
- cv-SpreadsheetID
- cv-FoglioNome
- Popola ogni variabile con i corrispondenti valori SpreadsheetID e SheetName del tuo foglio di controllo.
Passo 5: Ottenere i dati del foglio
Per utilizzare i dati all'interno del tuo foglio di controllo, devi utilizzare il comando Get Sheet Data. Il comando legge il contenuto di un foglio in un foglio elettronico e produce un output .csv.
- Trascina il comando Workiva Get Sheet Data nella sezione START dell'area di disegno.
- Configura il comando
- Rinominalo Ottieni i dati del foglio di controllo
- Utilizza la variabile di catena cv-SpreadsheetID per il campo ID del foglio di calcolo
- Usa la variabile di catena cv-SheetName per il campo ID/Nome del foglio
- Inserisci A1: per la regione
- Lascia Stile di valore e Revisione come Calcolato e -1
- Fai clic su Salva
Passo 6: convertire i dati del foglio in JSON
Dopo aver recuperato con successo i dati del foglio di controllo in formato .csv, il passo successivo è quello di convertirli in JSON. Questa conversione assicura che le intestazioni e i valori delle colonne siano riformattati correttamente nella struttura JSON Key-Value. Questo formato è fondamentale per i passi successivi.
- Trascina il comando CSV to JSON nell'area di disegno.
- Collega il comando Ottieni dati del foglio di controllo al comando CSV to JSON
- Modifica il comando CSV to JSON
- Nel campo File di input, utilizza i dati in uscita dal menu a tendina Ottieni dati del foglio di controllo
- Lascia il campo Delimitatore come Virgola (,)
- Fai clic su Salva
Passo 7: iterazione dei dati JSON
Ora che i dati del foglio di controllo sono in formato JSON, è possibile utilizzare un gruppo di comandi per iterare ogni riga di dati all'interno del foglio di controllo.
- Aggiungi il gruppo di comandi all'area di disegno
- Collega il comando CSV to JSON alla parte In del gruppo di comandi
- Modifica il gruppo di comandi e denominalo Iteratore JSON
- Clicca sul simbolo dell'iterazione a destra della scheda Informazioni di base
- Attiva l'iteratore
- Lascia il Tipo di modificatore selezionato come Elenco
- Per la sezione Iterazioni, seleziona l'output <> File JSON dal menu a tendina del comando CSV to JSON
- Fai clic su Salva
Passo 8: Anteprima di ogni iterazione di dati
Ora che la catena è in grado di iterare ogni riga del foglio di controllo, è possibile utilizzare un comando Handlebars per visualizzare l'anteprima delle informazioni in uscita.
Nota: Il comando Handlebars serve come segnaposto per esaminare i valori in questo articolo, ma possono essere utilizzati anche altri comandi per elaborare i valori.
- Trascina e rilascia un comando Render Text Template sull'area di disegno
- Collega il comando Inizio gruppo del gruppo di comandi al comando Modello di testo di rendering
- Modifica il comando e assegnagli il nome Anteprima dati foglio di controllo
- Nel campo Modello, inserisci quanto segue:
Nome file ID tabella flag attivo
- Per ricavare i valori dal foglio di controllo, è necessario applicare una trasformazione variabile per ogni iterazione JSON
- Accanto a File Name, scegli JSON File Iteration dalla barra laterale, sotto il menu a tendina Group Iterator.
-
- Clicca su Iterazione file JSON, seleziona Ottieni valore da JSON
- Nel campo Valore, inserisci l'intestazione Nome_File dal tuo foglio di controllo
- Nota: È buona norma copiare l'intestazione del foglio di controllo direttamente nel campo del valore.
- Premi Invio e Accetta
-
- Ripeti i passaggi precedenti per le intestazioni di Active_Flag e Table_ID dal foglio di controllo.
- Una volta completato, il campo del modello dovrebbe apparire come segue:
- Salva il comando
Passo 9: Eseguire la catena e l'anteprima
Ora che la catena e il foglio di controllo sono impostati, è importante assicurarsi che ogni iterazione dell'output del Manubrio contenga i dati per ogni riga del foglio di controllo.
- Clicca su Pubblica e poi Esegui la catena
- Esegui la catena
- Dopo che la Catena è stata eseguita con successo, clicca sul comando Preview Control Sheet Data e vai alla scheda Log
- In "Start Rendered Text" dovrebbe essere visibile l'output della prima iterazione.
- Passa al valore 2 dell'opzione sopra la scheda Log per vedere i risultati della seconda iterazione
- Infine, passa al valore 3 per vedere i risultati della terza iterazione
- Ogni iterazione dovrebbe apparire come segue:
Valore 1:
Valore 2:
Valore 3:
Sfruttare il flag attivo
Incorporare una logica condizionale che utilizzi il valore del flag attivo è il passo successivo, utilizzando la stessa catena che è stata costruita.
- Modifica la Catena ed elimina il collegamento tra l' Iteratore JSON e i Dati del Foglio di Controllo dell'Anteprima
- Aggiungi un comando condizionale e collega il comando Inizio Gruppo del Gruppo di Comando al nuovo comando
- Collega il comando Condizionale al comando Anteprima dei dati del foglio di controllo
- Modifica il comando condizionale
- Dai un nome al comando Bandiera attiva?
- Clicca sul pulsante + Regola
- Nel campo del valore, clicca su <> JSON File Iteration dal menu a tendina dell'Iteratore di Gruppo
- Aggiungi una trasformazione variabile e utilizza l'intestazione Active_Flag del foglio di controllo come valore
- Clicca su Accetta
- Cambia la condizione da "Is Blank" a "=".
- Inserisci la parola "true" nel campo dell'espressione
- Clicca su Salva
Ora, ogni volta che la catena viene eseguita, il comando Preview Control Sheet Data verrà eseguito solo se il valore Active_Flag in quell'iterazione è uguale a true.
- Poiché il flag attivo per due delle iterazioni era impostato su "FALSO", il comando Preview Control Sheet Data è stato eseguito solo per la terza iterazione.
- I comandi che seguono il comando condizionale "Flag attivo?" saranno saltati se la loro iterazione nel foglio di controllo ha valore "FALSO".
Casi d'uso aggiuntivi
Il Foglio di controllo offre un modo molto efficace per centralizzare, gestire e automatizzare i valori utilizzati nell'esecuzione dei flussi di lavoro. Può essere applicato in vari scenari, tra cui:
- Un hub centrale per la gestione degli ID di un sistema sorgente, di Workiva e degli elementi Wdata
- Utilizzo di un flag per filtrare e decidere se un processo specifico debba essere eseguito.
- Specificare gli endpoint URL per l'esecuzione dei report da un sistema di origine
- Definizione di date e convenzioni di denominazione per file specifici
- Identificare le directory dei file per un SFTP per recuperare i file designati