SITI-Reports. Progetto SITI. Manuale Utente. SITI-Reports. ABACO S.r.l.

Transcript

1 Progetto SITI Manuale Utente SITI-Reports ABACO S.r.l.

2 ABACO S.r.l. C.so Umberto, Mantova (Italy) Tel Fax info@abacogroup.eu 02/03/2010 Revisione 1.0

3 Sommario SOMMARIO... 1 INTRODUZIONE... 2 CONFIGURAZIONE / INSTALLAZIONE... 2 ACCESSO A SITI-REPORTS... 3 AMMINISTRAZIONE REPORTS... 4 REPORTS ALFANUMERICI... 5 Definire una categoria... 5 Modificare una categoria... 5 Eliminare una categoria... 6 Elenco reports per categoria... 6 Definire un report...6 Modificare un report...7 Eliminare un report...7 REPORTS GRAFICI... 8 Definire un report grafico... 8 CONSULTAZIONE REPORTS... 9 CREARE UN REPORT ALFANUMERICO DEFINIZIONE DEI PARAMETRI CREARE UN REPORT GRAFICO DEFINIZIONE DEI PARAMETRI RICHIAMARE UN REPORT DA WEB Sommario 1

4 Introduzione L applicazione web siti-reports è un applicazione utilizzata per catalogare e visualizzare report creati con l applicativo ireport. Possono essere create 2 tipologie di report: Report alfa-numerifici (utilizzando ireport) Report grafici (utilizzando un progetto di DbMAP) La catalogazione dei report è realizzata con la definizione di opportune categorie. Configurazione / Installazione L applicazione siti-reports viene rilasciata come war / ear. Per configurare l accesso al database si deve aprire il file applicationcontext.xml e modificare il bean con nome datasource. L accesso al database può essere fornito in 2 modi: con la stringa di connessione al database (parametri url, username e password) <bean id="datasource" class="org.apache.commons.dbcp.basicdatasource"> <property name="driverclassname" value="oracle.jdbc.driver.oracledriver" /> <property name="url" value="jdbc:oracle:thin:@localhost:1521:sviluppo" /> <property name="username" value="siti-reports" /> <property name="password" value="siti-reports" /> </bean> con il nome di un datasource (parametro jndiname) <bean id="datasource" class="org.springframework.jndi.jndiobjectfactorybean"> <property name="jndiname" value="jdbc/sitireports"/> </bean> Le variabili utilizzate dall applicazione sono definite su database nella tabella GISPARAMS. Il path in cui vengono salvati i file di definizione per i reports è definito dal valore della variabile PATHFRAZIONAMENTI. Per installare l applicazione si deve deployare il war / ear nel container web utilizzato. Introduzione 2

5 Accesso a siti-reports L'applicazione deve essere invocata tramite questo URL: dove al posto di <server> va impostato l indirizzo completo del server su cui è installata l applicazione. All accesso verrà visualizzata una pagina con le seguenti voci di menù. Amministrazione JReport: accesso all amministrazione dei reports definiti con ireport Amministrazione DbMAP: accesso all amministrazione dei reports grafici Consultazione JReport: consultazione dei reports definiti con ireport Consultazione DbMAP: consultazione dei reports grafici Consultazione di tutti i Reports: consultazione di tutti i reports Consultazione code: consultazione delle code di stampa Consultazione stato Coda: consultazione dello stato di una coda di stampa L accesso ad ogni sezione di siti-reports è protetto da login con filtro SSO. Per poter accedere l utente deve aver associato il contesto ABACO-REPORTS e le funzioni ABACOREPORT_READ (reports in sola lettura) oppure ABACOREPORT_MANAGE (gestione reports). Accesso a siti-reports 3

6 Amministrazione reports Come detto in precedenza si possono creare due tipologie differenti di reports: alfanumerici e grafici. I reports alfanumerici si definiscono utilizzando il programma ireport. Questo programma permette di definire in modo semplice attraverso un interfaccia grafica il layout di un report. Il layout sarà salvato in forma di file xml. I reports grafici invece si definiscono utilizzando il programma DbMAP ASJ Viewer. Questo programma permette di impostare un progetto grafico per la visualizzazione di layer GIS. Il progetto grafico realizzato non è altro che un file xml. Amministrazione reports 4

7 Reports alfanumerici Premendo il link Amministrazione JReport si accede all amministrazione dei reports alfanumerici. Verranno elencate tutte le categorie definite in siti-reports (vedi figura 1). Figura 1- Amministrazione report alfanumerici Dall amministrazione sarà possibile eseguire le seguenti operazioni: Definire una nuova categoria (icona ) Modificare una categoria (icona ) Eliminare una categoria (icona ) Accedere ai reports definiti per una categoria (icona ) Definire una categoria Premendo l icona comparirà la maschera per definire una nuova categoria (vedi figura 2). Figura 2- Definire una categoria Una categoria è definita dai seguenti parametri: Codice: identifica il codice univoco di una categoria Descrizione: descrizione della categoria Premere il pulsante Invia per creare la categoria. Premere il pulsante Torna ad elenco per tornare alla pagina con l elenco delle categorie definite. Modificare una categoria Premendo l icona comparirà la maschera per la modifica di una categoria (vedi figura 3). Figura 3- Modificare una categoria Potranno essere modificati il codice e la descrizione della categoria. Amministrazione reports 5

8 Premere il pulsante Invia per creare la categoria. Premere il pulsante Torna ad elenco per tornare alla pagina con l elenco delle categorie definite. Eliminare una categoria Premendo l icona verrà eliminata la rispettiva categoria. La categoria potrà essere eliminata solamente se non vi è definito alcun report. Elenco reports per categoria Premendo l icona si accede alla pagina con l elenco dei reports alfanumerici per categoria (vedi figura 4). Figura 4- Elenco reports per categoria Da questa pagina sarà possibile eseguire le seguenti operazioni: Definire un nuovo report (icona ) Modificare un report (icona ) Eliminare un report (icona ) Premere il pulsante Categorie per tornare alla pagina con l elenco delle categorie. Definire un report Premendo l icona si accede alla pagina per definire un nuovo report (vedi figura 5). Un report è definito dai seguenti parametri: Figura 5- Definire un report Amministrazione reports 6

9 Codice: identifica il codice univoco di un report Categoria: identifica la categoria di appartenenza del report Descrizione: descrizione del report Tag: eventuale parametro per definire una proprietà del report Jasper XML: file xml che descrive il report (file generato con ireport) Query di Validazione: eventuale query SQL di validazione del report. Se definita il report viene eseguito solamente se la query di validazione è valida (torna almeno un record). Nella query di validazione possono essere utilizzati tutti i parametri in input al report, tra parentesi graffe. Es : {nome_parametro} Bisogna fare qualche precisazione per il campo Jasper XML, ovvero capire come specificare i files di progetto nel caso di presenza di sotto-reports o di più reports distinti da concatenare. Sotto-reports: specificare un file zip contenente i files di progetto. Il report principale dovrà chiamarsi report.jrxml mentre i sotto-reports posso assumere un qualsiasi nome. Reports da concatenare: specificare un file zip contenente i files di progetto. I files jrxml di progetto dovranno tutti chiamarsi come report + <codice>. I reports saranno concatenati in ordine alfabetico. Es : report01.jrxml, report02.jrxml, report03.jrxml. Premere il pulsante Invia per creare il report. Premere il pulsante Torna ad elenco per tornare alla pagina con l elenco dei reports definiti per la categoria precedentemente selezionata. Modificare un report Premendo l icona si accede alla pagina per la modifica di un report (vedi figura 6). Figura 6 - Modificare un report Potranno essere modificati i seguenti parametri: categoria, descrizione, tag, jasper XML e query di validazione. Inoltre sarà possibile scaricare il file di progetto precedentemente caricato premendo l icona. Premere il pulsante Invia per modificare il report. Premere il pulsante Torna ad elenco per tornare alla pagina con l elenco dei reports definiti per la categoria precedentemente selezionata. Eliminare un report Premendo l icona verrà eliminato il rispettivo report. Amministrazione reports 7

10 Reports grafici Premendo il link Amministrazione Jasper si accede all amministrazione dei reports grafici. Verranno elencate tutte le categorie definite in siti-reports (vedi figura 1). I comandi disponibili sono identici a quelli descritti per i reports alfanumerici (sia per le categorie che per i reports). Gli unici comandi che si differenziano sono: L elenco dei reports per categoria, per cui vengono elencati i reports grafici e non i report alfanumerici (vedi figura 4) Definizione di un report grafico Definire un report grafico Dall elenco dei reports per categoria (vedi figura 4), premendo l icona report grafico (vedi figura 7). si accede alla pagina per definire un nuovo Figura 7- Definire un report grafico Un report grafico è definito dai seguenti parametri: 1. Codice: identifica il codice univoco di un report 2. Categoria: identifica la categoria di appartenenza del report 3. Descrizione: descrizione del report 4. Tag: eventuale parametro per definire una proprietà del report 5. Template URL: URL per il file template da utilizzare in caso di report grafico in formato HTML. Se omesso viene utilizzato il template standard di siti-reports. 6. Progetto: file XML che definisce il progetto grafico creato con il programma DbMAP ASJ Viewer 7. File gifs: eventuale zip con le immagini utilizzate nel progetto grafico 8. Query di Validazione: eventuale query SQL di validazione del report. Valgono le stesse regole descritte nel paragrafo Definire un report. Premere il pulsante Invia per creare il report grafico. Premere il pulsante Torna ad elenco per tornare alla pagina con l elenco dei reports grafici definiti per la categoria precedentemente selezionata. Amministrazione reports 8

11 Consultazione reports Siti-Reports mette a disposizione tre diverse modalità di consultazione dei reports. Consultazione JReport: consultazione dei reports alfanumerici. Verranno visualizzate tutte le categorie definite in siti-reports ma saranno visibili solamente i reports alfanumerici. Consultazione DbMAP: consultazione dei reports grafici. Verranno visualizzate tutte le categorie definite in siti-reports ma saranno visibili solamente i reports grafici. Consultazione di tutti i Reports: consultazione di tutti i reports, sia alfanumerici che grafici. Verranno visualizzate tutte le categorie definite in siti-reports e tutti i tipi di reports. Premendo uno qualsiasi tra i link per la consultazione (vedi paragrafo Accesso a siti-reports) verrà visualizzato l elenco delle categorie definite (vedi figura 8). Figura 8 - Consultazione categorie di reports Premendo l icona si accede alla pagina con l elenco dei reports per categoria (vedi figura 9). Figura 9 - Consultazione reports Vediamo il significato delle icone: identifica un report alfanumerico identifica un report grafico Premere una qualsiasi di queste icone per eseguire il relativo report. Premere il pulsante Categorie per tornare alla pagina con l elenco delle categorie. Dopo aver premuto l icona per l esecuzione di un report, se tale report necessita di parametri in input verrà visualizzata una maschera per il loro inserimento (vedi figura 10 per reports alfanumerici e figura 11 per reports grafici). Consultazione reports 9

12 Figura 10 - Inserimento parametri report Di default un report alfanumerico viene generato in formato PDF. E comunque possibile selezionare un altro formato dall apposito menù a tendina (vedi figura 10). Figura 11 - Inserimento parametri report Di default un report grafico viene generato in formato HTML. E possibile generare il report anche come immagine, selezionando i formati JPEG o PNG tra quelli disponibili. In questo modo è possibile inserire un report grafico in un report alfanumerico. Vedremo successivamente questa particolare funzionalità. Premere il pulsante Invia per eseguire il report. Consultazione reports 10

13 Creare un report alfanumerico Per creare un report alfanumerico eseguibile da siti-report si deve utilizzare il programma ireport. Attualmente siti-report supporta file XML di reportistica generati con la versione ireport Definizione dei parametri Vediamo come definire un parametro in ireport (figura 12). Figura 12 - Definizione parametro Nome parametro: nome del parametro in input al report. Tipo del parametro: classe java che rappresenta il tipo del parametro. I tipi di parametri supportati da siti-report sono: o java.lang.integer o java.lang.float o java.lang.double o java.math.bigdecimal o java.lang.string o java.lang.date Richiedi valore all utente: impostando questo check, prima dell esecuzione del report verrà richiesto il suo valore in input. Descrizione: utilizzare la sintassi <descrizione_parametro> value=<valore_di_default> per la descrizione e l eventuale valore di default del parametro in input. Nell esempio riportato in figura 12, prima dell esecuzione del report verrà richiesto il parametro Codice Nazionale che avrà come valore di default C758 (vedi figura 13). Figura 13 - Richiesta parametro Creare un report alfanumerico 11

14 Creare un report grafico Per creare un report grafico eseguibile da siti-report si deve utilizzare il programma DbMAP ASJ Viewer. Il progetto grafico salvato come file XML è statico, nel senso che non può ricevere parametri in input. Vediamo come poter definire e come utilizzare dei parametri nel progetto grafico per renderlo dinamico. Definizione dei parametri Figura 14 - Definizione parametro Il tag <DbMAP_asj_Project> definisce il report grafico. Subito dopo questo tag è possibile definire i parametri in input al report grafico. Tutti i parametri devono essere racchiusi tra i tags <Parameters></Parameters>. La definizione di ogni singolo parametro deve essere racchiusa tra i tags <Parameter></Parameter>. Vediamo i singoli tags per la definizione di un parametro: <name></name>: nome del parametro <descr></descr>: descrizione del parametro <valueclassname></valueclassname>: classe java che identifica il tipo del parametro <handlerparams><param>value=xxx</param</handlerparams>: per impostare un valore di default al parametro Creare un report grafico 12

15 I parametri definiti possono essere utilizzati all interno del progetto grafico con la sintassi: [nome_parametro]. Vediamo un esempio: Figura 15 - Utilizzo parametro In figura 15 il parametro [cod_nazionale] è utilizzato per visualizzare i limiti provinciali di un determinato comune. Un altro parametro utilizzabile nei reports grafici è [SERVER_URL], che identifica l URL del server su cui è installata l applicazione siti-reports. Nel caso in cui l applicazione siti-reports e l applicazione che mette a disposizione la servlet DbMAP sono deployate sullo stesso server, risulta molto utile l utilizzo di questo parametro perché evita di scolpire nel codice l indirizzo del server. Vediamo un esempio: <ServerURL>[SERVER_URL]/siticatasto/DbMAPservlet?function=</ServerURL> Creare un report grafico 13

16 Richiamare un report da web Siti-reports permette di richiamare un singolo report (alfanumerico / grafico) con un URL. La sintassi da utilizzare è la seguente: <url_siti-reports>/report.actions?action=report.jasper.run&subaction=runreport&rpt_format=pdf &RPT_ID=1&<param1>=<value1>&<params2>=<value2> <url_siti-reports>: identifica l URL dell applicazione siti-reports. RPT_ID: identificativo del report. Nell esempio verrà richiamato il report con ID = 1. Successivamente si possono specificare tutti i parametri in input al report. L ID del report fa riferimento alla chiave del report su DB. Questo valore non è facilmente ricordabile e non è imputabile durante la creazione di un report. Per questo motivo è stato introdotto il concetto di codice report che specifica un codice univoco per un report. Questo parametro è imputabile durante la creazione di un report (vedi paragrafo Definire un report). Inoltre è utilizzabile per richiamare un report da URL nel seguente modo: <url_siti-reports>/report.actions?action=report.jasper.run&subaction=runreport&rpt_format=pdf &CODE=report_particelle&<param1>=<value1>&<params2>=<value2> CODE: codice del report. Nell esempio verrà richiamato il report con codice = report_particelle. Un esempio di chiamata per un report grafico potrebbe essere la seguente: <url_siti-reports>/report.actions?action=report.jasper.run&subaction=runreport&rpt_format=jpeg &CODE=report_grafico& width=500& height=500&<param1>=<value1>&<params2>=<value2> Nella chiamata ai reports grafici possono essere specificati altri 2 parametri per specificare larghezza e altezza dell immagine generata: width: larghezza in pixel dell immagine generata height: altezza in pixel dell immagine generata La precedente chiamata genera un immagine JPEG. Il programma ireport permette di poter inserire delle immagini all interno di un report, sia fornendo un percorso fisso che un URL. Questo ci permette di poter specificare come percorso dell immagine l URL di un progetto grafico (come l esempio precedente) e di avere all interno di un report alfanumerico un report grafico. Richiamare un report da web 14