Il Command Export Book To File consente di esportare i dati presenti nel Model del Book corrente su un file di testo. Questo Command si compone di:
✓ un percorso del file system che punta ad una cartella dove salvare i file di output;
✓ uno o più Statement che contengono specifiche istruzioni di export.
Gli elementi definitori di questo Command sono impostabili mediante i seguenti riquadri, nella corrispondente UI:
✓ General, visualizza le informazioni anagrafiche del command;
✓ Parameter list, consente di valorizzare eventuali parametri di esecuzione;
✓ Dynamic properties, permette di impostare dinamicamente le Properties del command;
✓ Settings, permette la selezione del percorso ove esportare i dati;
Il pulsante Sample del ribbon, presente nel gruppo Query del tab Home, compila automaticamente la query nel working space destinato alle Dynamic Properties. |
La proprietà Default Path consente di specificare il percorso assoluto ad una cartella di salvataggio predefinita:
✓ manualmente,
✓ sfogliando il file system mediane un apposito wizard.
Nel comporre il Default Path è possibile far uso di variabili di sistema (e.g. <%Desktop>) e stringhe parametriche, del tipo <#string>. |
È possibile consentire all'utente finale del Book di modificare nome e percorso di default del file in output mediante la proprietà Ask For. Essa può assumere tre diversi valori:
✓ Folder, l'utente finale può modificare nome e percorso assoluto del file;
✓ File, l'utente finale può modificare il nome del file, ma non il percorso in cui salvarlo;
✓ None, l'utente finale non può modificare nè nome nè percorso assoluto.
In caso di Ask For impostato a None, è obbligatorio specificare un Default Path. |
Esistono due metodi equivalenti, per aggiungere un nuovo Statement ad un Command Export Book To File:
✓ selezionando il Command, il tasto Add mostra, in aggiunta ai Command disponibili, l'opzione Statement
;
✓ selezionando il Command con il tasto destro del mouse, il menù a tendina contestuale espone l'opzione Add Statement.
Entrambe queste azioni creano, in corrispondenza del Command Export Book To File selezionato, un sotto-elemento, denominato Statement.
Ogni elemento di tipo Statement dispone di una propria UI dove specificare:
✓ Name, nome da attribuire allo Statement;
✓ Description, descrizione dello Statement da integrare nella documentazione del Package;
✓ Table, ossia un oggetto del Package corrente oppure una Custom Query su cui iterare le istruzioni dello Statement.
Le modalità di definizione di un Iteratore (Table) e la sintassi, con cui richiamarne i campi, sono analoghe a quelle descritte per gli iteratori di un Database Link.
In presenza di un iteratore, viene abilitato il flag Execute Always. Se attivo, esso forza almeno una esecuzione dello Statement, anche in caso di iteratore privo di record.
La UI di uno Statement dispone di due ulteriori riquadri:
✓ il riquadro Settings, che espone impostazioni specifiche per la generazione del file di output.
✓ un riquadro dove definire una lista dei campi in input, da includere nel file di destinazione, e la loro formattazione.
Il riquadro Settings consente di impostare le proprietà riportate nella seguente tabella.
Proprietà |
Descrizione |
---|---|
DefaultDateFormat |
Specifica il formato stringa di campi di tipo Date e DateTime. |
DefaultIntegerFormat |
Specifica il formato stringa di campi di tipo Int, BigInt e SmallInt. |
DefaultNumericFormat |
Specifica il formato stringa di campi di tipo Float, Double e Money. |
EncodingName |
Modalità di codifica del file di destinazione (e.g. ASCII, Unicode o EBCDIC). |
ExecuteAtLeastOnce |
Consente l'eventuale creazione di un file vuoto, in caso la Input Query non restituisca record. |
FieldDelimiter |
Carattere da utilizzare come delimitatore di campo. |
FileExistsBehaviour |
Specifica il comportamento da seguire in caso il file di destinazione sia già esistente: ✓sovrascrivere (Override), ✓accodare i dati (Append), ✓restituire errore (Error). |
FileName |
Percorso relativo o assoluto del file di destinazione. In caso di percorso assoluto, esso sovrascrive il percorso specificato nel campo DefaultPath della UI del Command. |
FileNameColumn |
Consente di leggere il percorso relativo o assoluto del file di destinazione da una delle colonne in input. Questa proprietà è fondamentale per la creazioni di output di tipo multi-file. |
HeaderRow |
Specifica la presenza delle intestazioni di colonna. |
RecordTypeColumn |
Consente di specificare una colonna in input, contenente valori con cui categorizzare i record in due o più categorie. Questa proprietà è fondamentale per la creazioni di output di tipo multi-record. |
RowDelimiter |
Identifica il delimitatore di record da utilizzare nel file di destinazione. |
TextQualifier |
Carattere da utilizzare come delimitatore di testo. |
I campi DefaultDateFormat, DefaultIntegerFormat e DefaultNumericFormat dispongono di una maschera dedicata, per la definizione del relativo formato stringa. La maschera Edit FormatString espone le seguenti opzioni di formato:
Opzione |
Descrizione |
---|---|
Align |
Specifica l'allineamento del testo (destra o sinistra). |
Culture |
Definisce quali regional settings utilizzare per la formattazione di numeri e date. In caso questo campo sia vuoto, vengono utilizzati i regional settings del client corrente. |
DecimalSeparator |
Consente di mostrare o nascondere l'eventuale separatore delle cifre decimali. |
ErrorString |
Stringa da utilizzare in caso il valore in input abbia lunghezza maggiore di quella specificata nel campo Length. |
FillChar |
Caratteri da aggiungere alla stringa in output in caso la sua lunghezza sia inferiore a quella specificata nel campo Length. |
FormatString |
Consente di impostare uno specifico formato di output per numeri e date, utilizzando la sintassi per formati personalizzati di Excel. |
HideString |
Valore in input da considerare come valore NULL. |
Length |
Lunghezza massima di una stringa (valore maggiore o uguale a zero). Il valore -1 equivale a non impostare una massima lunghezza. |
NullString |
Stringa da sostituire in caso di valori mancati oppure NULL. |
Trim |
Consente di eliminare eventuali spazi superflui dalla stringa in output. |
Il campo Extended Format String della maschera Edit FormatString espone in modo sintetico l'elenco delle opzioni impostate.
Nel campo FileName è possibile far uso di variabili di sistema, quali <%Desktop>. |
L'elenco dei campi in input, da includere nel file di output, può essere compilato secondo tre diverse modalità:
✓ All Columns, seleziona in automatico tutte le colonne in input;
✓ All Columns except, consente di definire manualmente una lista di colonne da escludere;
✓ Selected Columns, consente di popolare manualmente la lista di colonne specificandone un'eventuale formattazione personalizzata.
In caso di compilazione manuale, è possibile visualizzare tutte le colonne in input disponibili premendo il tasto Auto Fill Columns |
In modalità Selected Columns, è possibile specificare alcuni specifici attributi dei campi in input da esportare, quali:
✓ Column Name, nome del campo in input;
✓ Output Column Name, nome del campo corrente in output;
✓ Format String, specifico formato di output che sovrascrive l'eventuale Default Format specificato nel tab Settings;
✓ Records Type List, stringa o numero che categorizza il campo corrente per la generazione di output di tipo multi-record.
Il campo Format String, analogamente ai campi DefaultDateFormat, DefaultIntegerFormat e DefaultNumericFormat, dispone della maschera Edit FormatString per definire il formato in output. |
I valori del campo Records Type List devono essere coerenti con il campo RecordTypeColumn del tab Settings. |