Estrattore SQL

(dalla versione 4.6.10 di geowebframework, issue #1076)

L'Estrattore SQL è una particolare UI, impostata come wizard, che permette di configurare modelli di estrazione SQL.

Un modello di estrazione si riferisce sempre ad un particolare dataset (che rappresenta la fonte dei dati) e ne determina le modalità con le quali i dati ne vengono estratti.

Una volta definito un modello di estrazione, è possibile utilizzarlo per lanciare l'estrazione SQL vera e propria.

Esistono anche delle API js che permettono, di integrare ulteriori funzionalità dell'estrattore come azioni di dettaglio in lista.

Fasi del wizard:

1. creazione nuovo modello di estrazione/modifica modello di estrazione esistente
2. scelta campi da estrarre, con eventuale configurazione di alias per le intestazioni di colonna
3. scelta dei criteri di filtro
4. effettiva creazione nuovo modello/salvataggio modello esistente

Creare le tabelle necessarie eseguendo gli script di base sulla schema dei dati.

-- DROP TABLE data_schema.gw_dataset;
 
CREATE TABLE IF NOT EXISTS data_schema.gw_dataset
(
    pk_dataset INTEGER NOT NULL,
    name_dataset CHARACTER VARYING(100) COLLATE pg_catalog."default" NOT NULL,
    description CHARACTER VARYING(400) COLLATE pg_catalog."default",
    class_name_dataset CHARACTER VARYING(100) COLLATE pg_catalog."default",
    cod_dataset CHARACTER VARYING(100) COLLATE pg_catalog."default" NOT NULL,
    CONSTRAINT gw_dataset_pkey PRIMARY KEY (pk_dataset),
    CONSTRAINT cod_ds_uk UNIQUE (cod_dataset)
)
WITH (
    OIDS = FALSE
)
TABLESPACE pg_default;
 
ALTER TABLE data_schema.gw_dataset
    OWNER TO data_schema;

Scaricare, estrarre dall'archivio ed importare le classi di base gw_dataset e gw_extraction_model. Assegnare i permessi necessari alle classi e relative azioni.

Creare una tabella/view/vista materializzata 'piatta' con tutti i campi in chiaro (non codificati, senza bisogno di join con tabelle esterne) cosi come vanno esportati. Creare la relativa classe in geoweb. la quale:

• non ha bisogno di aggiungere widget in lista: se non per poter esplicitarne la width da utilizzare nel caso l'utente li scelta per l'estrazione (Utile quando ci sono tantissimi campi scelti, per evitare che la grid assegni la width di default, a campi come le Note, per esempio, che farebbero incrementare l'altezza della riga
• non ha bisogno di aggiungere widget nella sezione filtro: anche se si possono aggiungere determinati attributi e configurarli per poterne determinare la modalità di scelta del valore (supportati: scelta da lista, scelta da finestra, scelta statica. Ovviamente è esculsa la decodifica, e i vari valori in visualizzazione label, fieldToShow etc saranno i medesimi di quelli nel tracciato del db)
• non ha bisogno di configurare l'xml dei widget, anche se si può configurare un formato specifico per i widget date/time, che verrà utilizzato per l'export
• gli attributi vanno obbligatoriamente associati a dei gruppi attributi, con la convenzione nel nome 'ext_'+[n_order]+'_'+[label gruppo campi], dove 'ext_' è fisso, n_order è un intero che determina l'ordine fra i gruppi, e label gruppo campi è il nome del gruppo effettivamente visualizzato.

Esempio di classe pma_tri_tax_datamart.

Nell'xml di progetto, aggiungere i menu di terzo livello:

	<leafItem name="gw_extraction_model" label="Modelli estrazione dati" image="fa-solid fa-file-export" type="leafItemListFilters">
		<parameter name="attributeToFilter" value="cod_dataset" hideToClient="false"/>
		<parameter name="className" value="gw_extraction_model" hideToClient="false"/>
	</leafItem>

ed opzionalmente:

	<leafItem name="gw_dataset" label="Dataset" image="fa-solid fa-database" type="gwClassList">	  
		<parameter name="className" value="gw_dataset" hideToClient="false"/>
	</leafItem>

Al click sul leafItem Modelli estrazione dati, si apre la lista dei modelli già configurati. Il wizard, in generale, può essere lanciato tramite l'apposita API js. Nello specifico si lancia dall'azione in toolbar Nuovo modello di estrazione (marker 1)

Nel primo step del wizard la prima cosa da fare è selezionare il dataset sul quale configurare il modello di estrazione. Inoltre si può scegliere se creare un nuovo modello da zero, oppure modificare parzialmente un modello già esistente, per poi scegliere alla fine se sovrascriverlo e crearne un altro con differente nome.

Caso NUOVO.

Nel secondo step si deve:

• scegliere i campi da esportare
• scegliere l'ordine delle colonne esportate
• si può opzionalmente impostare un alias

I campi sono divisi in gruppi, come da convenzione di configurazione. C'è un filtro globale che opera sui vari gruppi e lavora indistintamente sia con il nome che con la label degli attributi (spazi ammessi per separare più criteri messi in AND logico).

I campi possono essere spostati singolarmente (tramite button e drag&drop), per gruppo (tramite button e drag&drop) e globalmente (tramite button in toolbar grid). Per il drag&drop è supportata la selezione multipla (sia con CTRL, che con SHIFT).

Le proprietà movimentate tramite i comandi verranno sempre aggiunte in coda alla lista.

Utilizzando i comandi di spostamento massivi verrà sempre rimosso l'eventuale filtro impostato.

Una volta associato un campo a quelli da esportare, se ne può variare l'ordine di esportazione, tramite drag&drop.

Una volta associato un campo a quelli da esportare, si può impostare un alias alternativo alla label suggerita (quella della gwClass), che verrà utilizzata nelle fasi successive.

Al click sui button 'chiudi' verrà visualizzato un button di conferma.

Al click sul button 'indietro' e sul button 'avanti' e successivo ritorno allo step corrente, verrà ripristinato lo stato impostato.

1. titolo
2. descrizione sintetica step + tooltip descrizione estesa
3. filtro campo inter-gruppo
4. accordion gruppo campi (espandibile/collassabile)
5. button 'Aggiungi tutti (gruppo)'
6. singolo campo
7. nome campo
8. label campo
9. button 'Aggiungi'
10. button in toolbar grid 'Aggiungi tutti'
11. button in toolbar grid 'Rimuovi selezionati'
12. button su singolo campo aggiunto 'Rimuovi singolo'
13. colonna indicatore ordine campo
14. colonna per impostare alias alternativi alle label dei campi
15. button indietro
16. button avanti
17. button chiudi

Impostare i criteri per il modello di estrazione (filtri) agendo sul filtro incrementale, configurando per ogni filtro: proprietà, operatore ed eventualmente uno o più valori. Ogni filtro aggiunto può essere successivamente modificato o rimosso. I filtri verranno applicati automaticamente. Eventuali filtri non corretti, o non completi, verranno notificati all'utente e non saranno applicati alla preview.

Sulla toolbar della preview si può già lanciare l'estrazione dei dati, che da questo step verrà sempre eseguita con le configurazioni di campi e filtri correnti.

Al click sui button 'chiudi' verrà visualizzato un button di conferma.

Al click sul button 'indietro' e sul button 'avanti' e successivo ritorno allo step corrente, verrà ripristinato lo stato impostato.

La sezione 'stato' informa sull'effettiva applicazione dei filtri correnti (e validi) alla preview. La sezione 'stato' inoltre notifica la presenza di filtri non validi e quando il set di filtri impostato è (temporaneamente) differente da quello già applicato alla preview. Elenco stati:

• applicato quando i criteri di filtro validi sono correntemente applicati alla griglia di preview
• in applicazione quando i criteri di filtro validi sono in corso di applicazione alla griglia di preview
• non applicabile nella modalità avanzato, il filtro non risulta applicabile per problemi alla struttura dei filtri
• parzialmente non valido alcuni dei filtri non validano o non sono completi (può mancare ed non essere valido il campo, ll valore, etc..). Si procede comunque all'applicazione dei filtri validi
• modificato quando il filtro corrente è differente da quello applicato alla grid di preview

Agendo sullo switch 'distinct', si abilità l'utilizzo dell'analogo comando SQL nell'esecuzione della query. In pratica per i criteri scelti non si ammettono nel risultato dell'esportazione record duplicati. Da notare che si possono quindi ottenere un numero minore di record di aquelli che si avrebbero avuti aggiungendo più campi nell'estrazione, i quali avrebbero denotato le differenze fra i record.

Agendo sullo switch 'avanzato', si abilitano maggiori possibilità di configurazione, potendo agire anche sulla 'condizione' e sulle parentesi (di apertura '(' e di chiusura ')'), utili per poter innestare a piacimento i filtri, determinandone l'ordine di valutazione. Nella modalità 'avanzato' si abilita una sezione 'struttura' che notifica la coerenza delle parentesi impostate tramite il colore verde. Disabilitando la modalità 'avanzato', verranno rimosse dai filtri tutte le eventuali condizioni 'OR' e le parantesi impostate.

Da notare che lo step, come il due, viene aperto in un floating Pane a tutto schermo, che può essere collassato tramite l'apposito comando in altro a destra vicino al 'chiudi' X.

1. titolo
2. descrizione sintetica step + tooltip descrizione estesa
3. button expand/collapse floatingPane
4. button chiudi floatingPane
5. colonna campo criterio di filtro
6. colonna operatore criterio di filtro
7. colonna valore(i) criterio di filtro
8. switch distinct
9. switch avanzato
10. area stato
11. griglia preview
12. button in toolbar grid 'Estrazione diretta'
13. button in toolbar grid 'rimuovi criteri di filtro'
14. button 'indietro'
15. button 'avanti'
16. button 'chiudi'

Questo step prevede l'assegnazione di un nome al nuovo modello di estrazione.

Al click sui button 'chiudi' verrà visualizzato un button di conferma.

Al click sul button 'indietro' e successivo ritorno allo step corrente, verrà ripristinato lo stato impostato.

Utilizzare il radiobutton per abilitare il select di scelta di un modello estrazione esistente. Alla scelta si abilita il button 'avanti'

Caso MODIFICA . Si apre una UI del tutto simile a quella del caso NUOVO, ma già con degli attributi selezionati, con relativo ordine ed eventuali alias.

Caso MODIFICA. Si apre una UI del tutto simile a quella del caso NUOVO, ma già con dei filtri impostati.

Nel caso il modello di estrazione utilizzi un filtro avanzato, la UI si presenterebbe con la relativa modalità attivata.

Caso MODIFICA. In questo step si può decidere se salvare i cambiamenti sul modello di estrazione di partenza o crearne uno totalmente nuovo, con relativo nome.

Nella lista dei modelli di estrazione sono rpesenti scorciatoie al wizard standard

Al click sulla gwAction in lista icona 'excel' (marker 2), viene lanciata l'estrazione del file .xlsx, cosi come da modello di estrazione.

Al click sulla gwAction in lista icona 'search' (marker 3), viene aperto il wizard nello step 3. senza possibilità di andare avanti/indietro nel wizard.

Al click sulla gwAction in lista icona 'edit' (marker 4), viene aperto il wizard nello step 1 con select dataset e modelli di estrazione bloccati, con la sola possibilità di andare avanti nel wizard, che poi proseguirà come una normale modifica.

Lista signature api js.

function openGwExtractionWizardStart(/*String*/cod_dataset, /*String*/ cod_extraction_model, /*Boolean*/ isEdit, /*String*/ stateId)
 
function openGwExtractionWizardChooseFields(
	cod_dataset, //String
	cod_extraction_model, //String
	stateId, //String
	selectedAttributes //Object[], {name: '', field: ''}
)
 
function openGwExtractionWizardPreview(
	cod_dataset, //String
	cod_extraction_model, //String
	gwState, //Object, optional
	listedAttributesNames, //String, optional, array, string comma separated
	stateId, //String, optional (used when cod_extraction_model is null)
	isOnlyPreview //Boolean
)
 
function createGwExtractionXLSX(
	cod_extraction_model, //optional, alternative to grid
	grid //optional, alternative to cod_extraction_model
)