Creare report, o stampe, è uno dei problemi principali che si incontrano quando si sviluppano applicazioni web. Per creare report bisogna sempre ricorrere a dei prodotti il cui uso non è sempre così facile ed intuitivo richiedendo quindi conoscenza ed esperienza dello strumento in questione.
Il problema si è presentato anche in che è lo strumento ideale per creare applicazioni web e mobile, anche in maniera completamente autonoma e la soluzione trovata per generare report è tutta rivolta ad aiutare l’utente.
Quindi, cosa utilizzare per creare report in maniera semplice e veloce?
Strumenti quali Microsoft Word™, Open Office o Libre Office sono largamente diffusi e la conoscenza degli stessi è ormai di dominio pubblico. Questi strumenti permettono la creazione di documenti in formato docx che, essendo basato sull’xml, risulta facilmente leggibile da 4WS.Platform.
Allora perché non sfruttare la conoscenza di questi strumenti?
La diffusa conoscenza di questi strumenti, la semplicità nella creazione dei documenti e la possibilità di sfruttare un linguaggio facilmente leggibile sono le motivazioni alla base della scelta di utilizzare il formato docx per la generazione dei report in 4WS.Platform. Report che sono quindi realizzabili da tutti gli utenti.
Come creare un modello docx
Come detto sopra l’utente può creare il suo modello seguendo poche semplici regole, ma prima di tutto deve scrivere e formattare il proprio documento pensando al risultato che vuole ottenere.
Una volta completato il proprio documento vanno identificate le parti da sostituire con i dati recuperati dall’applicazione. A questo punto basta scrivere la query che alimenta il report ed inserire nei documenti le variabili da sostituire.
Variabili
sono gestite due tipologie di variabili con la seguente sintassi:
- <control>valore</control>: ‘valore’ viene sostituito con il dato recuperato dalla query;
- <translation>descrizione</translation>: ‘descrizione’ viene sostituita con il dato recuperato dalla query tradotto nella lingua del report.
Il risultato è quello visualizzato nelle immagini che seguono
Sottoreport
È inoltre possibile gestire due tipologie di sottoreport con la seguente sintassi:
- <table>tabella</table> dove ‘tabella’ è il nome assegnato al sottoreport poi, per ogni colonna, un identificativo
<td>colonna1</td> <td>colonna2</td> …
E’ sempre possibile prevedere celle da tradurre il lingua utilizzando il tag ‘tdtranslation‘.
Tutte le celle che presentano dei tag ‘<td>’ verranno replicate per ogni record recuperato dalla query creando la tabella.
Di seguito possiamo vedere un esempio del risultato.
- <subform>sottoform</subform> dove sottoform è il nome assegnato al sottoreport e i controlli vanno identificati con i tag ‘subcontrol’ o ‘subcontroltranslation’ per la traduzione in lingua automatica.
Alimentare il modello
Definito il modello si deve scrivere la query che lo alimenta. 4WS.Platform mette a disposizione diverse modalità di scrittura di un Business Component dando la possibilità all’utente di scrivere interamente la query o di utilizzare il modulo per la composizione automatica delle stesse.
Come configurare il report
Una volta creato il nostro modello e definita la query che lo alimenta possiamo configurarlo nel “Web Designer” di 4WS.Platform.
Bastano quattro semplici passi per completare la configurazione di un documento che poi può essere riutilizzato in tutta l’applicazione.
1. Inserimento nuovo modello
L’utente può definire il nome da assegnare alla configurazione del documento accompagnata da una breve descrizione. Poi scegliere il Business Component di riferimento che servirà per alimentare il report in fase di generazione.
Nell’ultima sezione è poi possibile scegliere il file (docx) da caricare: 4WS.Platform permette la scelta di un file per ogni lingua censita, ma è chiaro che la struttura del file deve essere la stessa per essere valorizzato nello stesso modo con la medesima query.
2. Parametri
Se il Business Component prevede l’utilizzo di variabili per l’esecuzione della query o il report stesso necessita di un valore da stampare che non viene estratto dal db è possibile definire dei parametri. Questi che possono essere di tipo testo, numero o data e vengono resi disponibili anche nella sostituzione delle variabili del report.
3. Campi del report
In questa griglia ci vengono mostrati i campi da sostituire nel report con i valori recuperati dalla query. Per ogni associazione è inoltre possibile definire una formattazione diversa del dato o, in alternativa, utilizzare i metodi di utilità resi disponibili da 4WS.Platform.
Nell’esempio viene utilizzata la funzione ‘formatNumber’ per la gestione delle formattazione dei numeri, ma è prevista anche ‘numberToText’ che converte i numeri in testo nella lingua desiderata.
4. Sottoreport
Se nel file docx caricato sono presenti sottoreport (tabella o form) viene valorizzata anche l’ultima griglia. In questa sezione l’utente deve associare ad ogni sottoreport il business component da utilizzare per alimentarlo e poi associare i campi del report con i campi estratti dalla query, come fatto nel punto 3 per il form principale.
Una volta completata la configurazione del report l’utente potrà modificare il modello ogni volta che lo desidera cambiando testo, formattazione ecc gli basterà rieseguire l’upload del file docx.
Generare il report
Completata la configurazione del modello l’utente può passare alla creazione di un’azione che si occuperà della generazione del report.
L’azione è molto semplice e richiede solo la chiamata al servizio lato server che poi si occuperà della generazione del file finale in formato docx.
utils.generateDocx(reportId, args, langId, path, fileName);
Con la stessa modalità è possibile poi convertire il file generato in formato pdf ottenendo una stampa in tutto e per tutto.
Conclusione
Non è più necessario conoscere complessi strumenti di reportistica per generare un modello per un report. Ora grazie a 4WS.Platform è possibile creare report semplici in formato docx e questo sarà interpretato e convertito nei formati richiesti.
Grazie alla diffusa conoscenza degli strumenti capaci di generare file di tipo docx e all’ interfaccia semplice e intuitiva del Web Designer di 4WS.Platform tutti possono configurare, gestire e creare report!
