ARPA Fonte Dati Regione Toscana Redatto da L. Folchi (TAI) Rivisto da Approvato da Versione 1.0 Data emissione 06/08/13 Stato DRAFT 1
Versione Data Descrizione 1,0 06/08/13 Versione Iniziale 2
Sommario 1 INTRODUZIONE... 5 1.1 RUOLI PER L'ACCESSO ALLA AMMINISTRAZIONE DELLA FONTE DATI... 5 2 FONTE DATI... 7 2.1 PREVIEW DELLA FONTE DATI... 8 2.2 ASSEGNAZIONE DIRITTI... 9 2.3 AVVIO/BLOCCO COMPILAZIONE... 10 2.4 PUBBLICAZIONE/DEPUBBLICAZIONE... 10 3 DOMINIO UTENTI... 10 3.1 CARICAMENTO UTENTI CON FILE CSV... 11 3.2 ELENCO UTENTI... 12 4 ATTRIBUTI FONTE DATI... 13 4.1 VALORI DI ATTRIBUTI... 14 5 COLLEZIONI DI ATTRIBUTI... 14 6 VALIDATORI... 17 3
Indice delle figure Figura 1: Configurazione per l'accesso alla portlet di Amministrazione 5 Figura 2: Fonte Dati 7 Figura 3: Inserimento, modifica, cancellazione Fonte Dati 7 Figura 4: Definizione Fonte Dati 8 Figura 5: Preview Fonte Dati 9 Figura 6: Assegnazione diritti 9 Figura 7: Dominio utenti 10 Figura 8: Definizione Dominio utenti 11 Figura 9: Caricamento file CSV 11 Figura 10: Elenco nominativi per Dominio Utente 12 Figura 11: Definizione nominativo 12 Figura 12: Attributi per fonte Dati 13 Figura 13: Definizione di un attributo 14 Figura 14: Elenco dei valori di attributo 15 Figura 15: Elenco delle collezioni di attributo 15 Figura 16: Definizione di una Collezione 16 Figura 17: Attributi disponibili e selezionati 16 Figura 18: Assegnazione dei diritti di compilazione 17 Figura 19: Definizione di un validatore 17 Figura 20: Test del validatore 18 4
1 Introduzione Il presente manuale ha lo scopo di illustrare il funzionamento della portlet di Amministrazione delle Fonti Dati. La parte di amministrazione delle Fonti Dati serve per poter definire le varie Fonti e la loro strutturazione. Ogni Fonte Dati sarà definita dai seguenti elementi attributi collettori di attributi domini utente Ogni singola funzionalità verrà descritta in dettaglio nel paragrafi che seguono. 1.1 Ruoli per l'accesso alla amministrazione della Fonte Dati Per l'accesso alla portlet di amministrazione sono previsti almeno due ruoli. Il primo ruolo è quello dell'amministratore globale, il quale può definire la Fonte Dati in tutte le sue parti e può anche decidere quanto la Fonte Dati può passare alla compilazione e quando è pronta per la pubblicazione e quindi fruibile dai servizi RFC 146/156. Il secondo ruolo è quello degli amministratori base i quali non hanno accesso alla parte di definizione della fonte dati, avvio alla compilazione e pubblicazione, ma solo alla sua amministrazione, limitando l'intervento dell' amministratore base alla definizione dei Domini utente, attributi e collettori di Attributi. L' amministratore globale della fonte dati può, attraverso l'assegnazione dei diritti di Liferay, limitare l'accesso all'amministrazione di una fonte ad un gruppo limitato di amministratori, modellati da un opportuno ruolo di Liferay. L azione che profila l accesso alla definizione della Fonte Dati si chiama Definizione Fonte Dati ed è accessibile dal pannello di configurazione della portlet di Liferay Figura 1: Configurazione per l'accesso alla portlet di Amministrazione 5
Ad ogni ruolo che deve poter accedere alla portlet deve essere data l azione Visualizza, mentre l azione Definizione Fonte Dati deve essere data solo ai ruoli che posso creare le istanze. Nel esempio in Figura 1 si può vedere che i ruoli Arpa - Amministratore Fonte Dati e Arpa - Amministratore Fonte Dati Base possono accedere alla portlet (azione: Visualizza) mentre solo il primo ruolo può definire le Fonti Dati (azione: Definizione Fonte Dati). 6
2 Fonte dati L'accesso al pannello delle fonti dati presenta in automatico l'elenco delle Fonti che sono state definite. Per ogni fonte è possibile eseguire diverse azioni in dipendenza dallo stato della fonte stessa. Figura 2: Fonte Dati Le operazioni principali che possono essere eseguire sono quelle di creazione modifica cancellazione Figura 3: Inserimento, modifica, cancellazione Fonte Dati La creazione di una fonte dati si ha selezionando il pulsante in alto a destra dello schermo mentre per la modifica si ha selezionando l'icona 7
L'effetto di entrambe le operazioni è l'apertura della finestra di definizione della fonte dati. Figura 4: Definizione Fonte Dati I campi Nome e Identificativo sono obbligatori, il campo nome serve per avere un nome simbolico per il riconoscimento della fonte, mentre l'identificativo sarà utilizzato dai servizi RFC 146/156 per l'individuazione delle fonte dati a fronte della quale viene fatta la comunicazione. Le altre operazioni che possono essere eseguite sulla fonte dati sono le seguenti: Preview della composizione della Fonte Dati Assegnazione diritti Avvio/Blocco compilazione Pubblicazione/Depubblicazione 2.1 Preview della Fonte dati L'icona permette la visualizzazione della definizione della fonte dati, di cui vengono elencati tutti gli attributi per essa definiti. 8
Figura 5: Preview Fonte Dati 2.2 Assegnazione diritti L'assegnazione dei diritti per una Fonte Dati serve per assegnare agli utenti di un particolare ruolo di Liferay il diritto di definire la Fonte in tutte le parti in cui è composta, come: dominio utenti, attributi, e collettori di attributi. L azione da assegnare è Amministrazione Fonte Dati. Figura 6: Assegnazione diritti 9
2.3 Avvio/Blocco compilazione Durante la fase di amministrazione di una Fonte Dati questa non è utilizzabile per la fase di compilazione (cfr. <<doc compilazione>>) e tanto meno è utilizzabile dai servizi di RFC 146/156. Quando l'amministratore globale ritiene che la fonte dati è ben definita può passarla alla compilazione selezionando l'icona. L'effetto del passaggio in compilazione di una fonte dati è che in amministrazione la Fonte non è più modificabile, è fruibile dalla portlet di compilazione e può essere pubblicata e quindi utilizzabile dai servizi RFC 146/156. Diametralmente, quando una Fonte è in compilazione può essere rimossa dalla compilazione selezionando l'icona, con l effetto che, se la Fonte era anche Pubblicata, viene rimossa dalla Pubblicazione. 2.4 Pubblicazione Quando una Fonte Dati è in compilazione può essere abilitata anche alla pubblicazione (RFC 146/156) attraverso al selezione dell'icona. Una volta che la fonte è stata pubblicata è possibile rimuoverla dalla pubblicazione attraverso la funzione apposita selezionando l'icona. 3 Dominio Utenti La pagina del Dominio Utenti è inizialmente vuota, in quanto l'elenco dei Domini Utenti è legato alla selezione di una Fonte Dati a fronte della quale viene definito ed amministrato il dominio stesso. Un Dominio Utenti ha il nome univoco all'interno della stessa fonte dati, ma possono esistere due Domini Utenti con lo stesso nome (non è lo stesso dominio, ma solo una omonimia del nome) assegnati a Fonte Dati diverse. Figura 7: Dominio utenti 10
La selezione della Fonte Dati sblocca la funzionalità Aggiungi Dominio Utenti, come illustrato in Figura 7. Figura 8: Definizione Dominio utenti Una volta creato il Dominio Utenti è possibile eseguire le seguenti operazioni: Caricamento di un elenco utenti con un foglio CSV; visualizzazione degli utenti con la possibilita di aggiungere modificare ed eliminare un nominativo; modifica del Dominio Utenti cancellazione. Le ultime due operazioni sono quelle tipiche di amministrazione. Vediamo nel dettaglio le prime due. Figura 9: Caricamento file CSV 3.1 Caricamento utenti con file CSV Selezionando l'icona è possibile accedere alla funzionalità di caricamento del file CSV dei nominativi utente. Come si vede dalla Figura 9 è possibile caricare un file di tipo CSV di nominativi e la cui dimensione massima consentita è 2MB; in caso contrario viene segnalata l'impossibilità di caricare il file. Il file da caricare deve contenere 3 colonne il cui ordine e contenuto è il seguente: 1. Codice fiscale 2. Cognome 3. Nome I caratteri di separazione tra i tre campi sono, (virgola) o ; (punto e virgola). Una qualsiasi altra forma del file non viene elaborata. Il caricamento del file CSV è from scratch cioè tutti i riferimenti già presenti nel Dominio vengono rimossi prima del caricamento del file. 11
L'elenco dei nominativi inseriti è ulteriormente depurato dei nominativi per cui il codice fiscale fornito non è valido. 3.2 Elenco utenti Alla selezione Elenco Utenti, che elenca i nominativi associati al Dominio Utenti, si accede attraverso la selezione dell'icona. Viene visualizzato un elenco di tutti nominativi inseriti nel dominio [Figura 10], dove per ciascuno è possibile modificarlo e rimuoverlo. E' inoltre possibile aggiungere ulteriori nominativi all'elenco [Figura 11]. Figura 10: Elenco nominativi per Dominio Utente Figura 11: Definizione nominativo Nota: Il codice fiscale del nominativo è univoco all interno del singolo Dominio Utenti, Domini diversi possono contenere lo stesso Codice Fiscale. 12
Figura 12: Attributi per fonte Dati 4 Attributi Fonte Dati Come per il Dominio Utenti, per definire gli attributi è necessario selezionare la Fonte Dati per la quale stiamo lavorando [Figura 12]. Come tutti gli altri oggetti definiti nella portlet è possibile creare, modificare e rimuovere un attributo. La definizione di un attributo è schematizzata in [Figura 13], i campi richiesti sono i seguenti: Chiave, campo obbligatorio; Descrizione: campo obbligatorio Tipo: campo obbligatorio, si può scegliere il valore tra una lista definita da : o Testo o Numero o Data o Selezione Numero massimo di risposte, se viene messo il valore 0 viene inteso che l attributo non ha limite sul numero di risposte che possono essere inserite Validatore: viene reso disponibile solo se il campo è di tipo Testo e contiene l elenco dei validatori definiti nel sistema (cfr. <<paragrafo su i validatori<>>) 1 Obbligatorio Visibile Mostra messaggio validatore Esportabile 1 I campi di tipo Data e Numero vengono controllati con appositi campi guidati in grafica senza la necessità di creare un validatore. Se il campo prevede un formato non standard è consigliato dichiarare il campo di tipo Testo e creare una validatore, con Regular Expression ad hoc. I campi di tipo Selezione non hanno validatori perché elencano una serie di risposte preconfezionate. 13
4.1 Valori di Attributi Per gli attributi il cui tipo è Selezione viene resa disponibile la funzione per aggiungere i valori di Attributo, cioè l elenco delle voci che dovranno essere elencati all interno della tendina. Figura 13: Definizione di un attributo Selezionando l icona, dall elenco degli attributi, è possibile accedere alla pagine di definizione dei valori possibili che l attributo può assumere. Come ogni altro elenco, le operazioni disponibili sono la creazione, la modifica e la cancellazione del valore inserito [Figura 14]. 5 Collezioni di attributi La collezione degli attributi è un raggruppamento logico degli attributi di una data Fonte Dati. Anche in questo caso la Fonte Dati deve essere selezionata per poter iniziare la definizione delle collezioni. Per una Fonte Dati posso essere definite più collezioni, per ogni collezione deve essere selezionato un insieme di attributi della Fonte ed un Dominio Utenti e alla collezione deve essere dato l accesso per la compilazione ad un ruolo di Liferay [Figura 15]. 14
Figura 14: Elenco dei valori di attributo Figura 15: Elenco delle collezioni di attributo Come per tutte le altre entità che abbiamo visto in queste pagine, vengono messe a disposizione le funzioni di creazione, modifica e rimozione. La fase di definizione prevede che venga, oltre ai normali campi di chiave e descrizione anche la selezione del Dominio Utente a fronte del quale la collezione viene definita [Figura 16]. Ricordiamo che una Fonte Dati può avere più domini utente e una serie non limitata di attributi, quindi una collezione di attributi è legata ad un solo dominio utenti ed un sotto insieme di attributi. 15
Figura 16: Definizione di una Collezione Una volta definita la collezione si deve selezionare l elenco degli attributi che lo compongono. La selezione dell icona, disponibile dall elenco delle collezioni, permette di accedere all elenco degli attributi disponibili della Fonte Dati ed all elenco degli attributi già inclusi nella collezione [Figura 17]. Figura 17: Attributi disponibili e selezionati Una volta terminata la definizione della collezione non rimane che assegnarne la compilazione agli operatori appartenenti ad un particolare ruolo selezionando l icona. L azione che deve essere assegnata è Compilazione Fonte Dati. 16
Figura 18: Assegnazione dei diritti di compilazione 6 Validatori I validatori servono per definire delle regole di validazione, Regular Expression, da utilizzare per validare le risposte agli attributi, di tipo Testo, fornite in fase di compilazione delle collezioni di attributi. I validatori non sono legati a nessuna fonte dati e sono assegnabili agli attributi solo se l attributo in questione è di tipo Testo. Figura 19: Definizione di un validatore 17
Una volta creato il validatore si hanno a disposizione le funzioni di modifica e cancellazione. Per i validatori viene messa a disposizione anche l operazione di test. Selezionando l icona è possibile accede alla pagina di test della formula inserita. Figura 20: Test del validatore 18