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.

-- Table: data_schema.gw_dataset
 
-- 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;
 
 
 
 
 
 
-- Table: data_schema.gw_extraction_model
 
-- DROP TABLE data_schema.gw_extraction_model;
 
CREATE TABLE IF NOT EXISTS data_schema.gw_extraction_model
(
    pk_extraction_model INTEGER NOT NULL,
    name_extraction_model CHARACTER VARYING(100) COLLATE pg_catalog."default" NOT NULL,
    date_creation TIMESTAMP WITHOUT TIME zone,
    date_last_modify TIMESTAMP WITHOUT TIME zone,
    cod_dataset CHARACTER VARYING(100) COLLATE pg_catalog."default" NOT NULL,
    cod_extraction_model CHARACTER VARYING(50) COLLATE pg_catalog."default" NOT NULL,
    user_creation CHARACTER VARYING(255) COLLATE pg_catalog."default",
    user_last_modify CHARACTER VARYING(255) COLLATE pg_catalog."default",
    filters_ext CHARACTER VARYING COLLATE pg_catalog."default",
    gw_state_json CHARACTER VARYING COLLATE pg_catalog."default",
    CONSTRAINT gw_extraction_model_pkey PRIMARY KEY (pk_extraction_model),
    CONSTRAINT cod_extraction_model_uk UNIQUE (cod_extraction_model),
    CONSTRAINT cod_dataset_fk FOREIGN KEY (cod_dataset)
        REFERENCES data_schema.gw_dataset (cod_dataset) MATCH SIMPLE
        ON UPDATE NO ACTION
        ON DELETE NO ACTION
)
WITH (
    OIDS = FALSE
)
TABLESPACE pg_default;
 
ALTER TABLE data_schema.gw_extraction_model
    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:

• necessita degli attributi, con attenzione in particolare alla correttezza del data type
• di base non è mandatorio di aggiungere widget in lista, ma è buona prassi implementativa aggiungerne alcuni in lista al solo fine di 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
• di base non è mandatorio aggiungere widget nella sezione filtro, ma è buona prassi implementativa aggiungere determinati attributi e configurarli per poterne determinare la modalità di scelta del valore nella sezione 'Preview' del wizard (supportati: scelta da lista, scelta da finestra, scelta statica. Ovviamente è esclusa la decodifica, e i vari valori in visualizzazione label, fieldToShow etc saranno i medesimi di quelli nel tracciato del db)
• di base non è mandatorio configurare l'xml dei widget, ma è buona prassi implementativa 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.

Importante

Va creata anche un'azione 'Selezionati in lista (posta nella toolbar)', con appropriati permessi e questo codice

var cod_extraction_model = null;
createGwExtractionXLSX(cod_extraction_model, grid);

Configurazione di base:

• Nome: generate_extraction_xlsx
• Etichetta: Estrai (.xlsx)
• Descrizione: Estrai i dati in formato .xlsx
• Tootlip: Estrai i dati in formato .xlsx

Questa azione ha uguale nome, label, descr e tooltip di quella lanciabile dai modelli di estrazione, ma va configurata sulla Classe a cui fa riferimento il Dataset.

Quella lanciabile dai modelli di estrazione, usa il parametro cod_extraction_model, mentre questa grid.

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>

Pagina dedicata Estrattore SQL WIZARD.

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
)
 
//la versione con popolato cod_extraction_model va usata come azione in lista dei modelli di estrazione
//la versione con popolato grid va usata come azione 'Selezionati in lista (Posto nella Toolbar) nella classe di riferimento del dataset
function createGwExtractionXLSX(
	cod_extraction_model, //optional, alternative to grid
	grid //optional, alternative to cod_extraction_model
)