I Commands |
  
|
I Commands |
|
I Commands sono strumenti per l'arricchimento di un Book. Essi consentono di definire ed impostare l'esecuzione run-time di particolari attività per rispondere a specifiche esigenze applicative. In particolare consentono di:
✓ eseguire istruzioni SQL che coinvolgono uno o più tabelle del Model;
✓ eseguire oggetti del Package esterni al Model;
✓ esportare i dati esposti in un Viewer;
✓ esportare oggetti del Model su file, DataShelf o DB esterni.
Inoltre i Command possono richiamare particolari stored procedure di sistema, dette Action, mediante le quali gestire e monitorare le esecuzioni del Book ad essi associato (cfr. Controllo delle esecuzioni).
Per definire un nuovo Command è necessario selezionare l'omonimo tab della UI di un Book. Il tab Commands si presenta diviso in due sezioni principali:
✓ la sezione di sinistra mostra la lista dei Command già definiti,
✓ la sezione di destra mostra gli elementi definitori specifici del Command selezionato nella colonna di sinistra.
Il ribbon presenta, nel tab Book, il gruppo contestuale Commands. Da esso è possibile inserire tutte le tipologie di command.
In alternativa, dal menu contestuale del tab Commands del Book (in edit) è possibile:
✓ aggiungere un nuovo Command (Add 
),
✓ cancellare un Command (Delete 
).
Il tasto Add Command permette anche di:
✓ creare nuovi Folder con cui organizzare i Command;
✓ definire istruzioni aggiuntive, sotto forma di Statement, ai Command che ne prevedono l'utilizzo.
I Command possono essere ordinati e inclusi in nuove cartelle mediante drag & drop. |
Tutti i Commands condividono alcune proprietà di configurazione site nei riquadri General e Parameter list.
Il riquadro General permette di impostare le seguenti proprietà:
✓ Name, nome attribuito al comando;
✓ Modifier, scope del command;
✓ Confirm Message, messaggio di conferma da mostrare all'utente prima di lanciare l’esecuzione del comando;
✓ Description, descrizione del comando con cui integrare la documentazione del Package corrente;
✓ Button, flag per rendere visibile, nel tab di esecuzione Book (run) del ribbon, un pulsante specifico con cui richiamarne il Commands corrente.
La proprietà Modifier specifica se il Command sia:
✓ Private, ovvero richiamabile solo internamente al Book (e.g. da Viewer o altri Command);
✓ Public, ovvero richiamabile anche al di fuori del Book (e.g. tramite WebAPI Server).
Il flag Startup, se selezionato, comporta l'esecuzione di un Command al lancio del Book. Per maggiori dettagli si faccia riferimento al paragrafo relativo ai Chapters.
Su il flag Startup è selezionato, allora il Command non può essere richiamato da User Interface o da altri Command del Book. |
Il flag Button, se selezionato, rende visibile nel tab di esecuzione Book (run) del ribbon – all’interno della Collection dei Commands – un pulsante per richiamarne l’esecuzione, personalizzabile tramite:
✓ Image: eventuale immagine da associare al pulsante per il lancio del Command corrente. È possibile scegliere un'immagine dal file system (tasto 
) oppure eliminare un'immagine precedentemente scelta (tasto 
);
✓ Caption: didascalia del pulsante del Command;
✓ Active Viewers: il pulsante associato al Command sarà visibile nella relativa Collection solo in corrispondenza dei Viewer specificati.
Le proprietà Caption, Active Viewer e Image risultano abilitate solo se il flag Button Visible risulta attivo. |
Il riquadro Parameter list consente di valorizzare eventuali parametri di esecuzione. Esso si presenta in forma di tabella con opzione di inserimento di una nuova riga.
In ciascuna nuova riga è possibile impostare:
✓ Name, il nome del parametro, preceduto dal simbolo @ (un nome @NewCommandParameter è proposto in automatico);
✓ DataType, il tipo di dato previsto per il parametro;
✓ DataTypeSize, la dimensione del dato;
✓ DataTypeScale, la scala, ove prevista dal tipo dato;
✓ Description, la descrizione opzionale estesa;
✓ Direction, la direzione del parametro (i.e. In, Out o InOut) da impostare a seconda del tipo di utilizzo del parametro.
Nel caso in cui sia definito un Parameter con Direction In e non sia valorizzato in fase di richiamo del command, il valore assegnato al parametro è NULL. |
I Commands disponibili per l'arricchimento di un Book sono:
✓ Run SQL, esegue un’istruzione T-SQL che coinvolge una o più tabelle del Model;
✓ Run Sequence, esegue due o più Command in successione;
✓ Export Viewer, esporta su file i dati esposti da un Viewer;
✓ Run Chapters, esegue uno o più Chapter del Book in contemporanea;
✓ Run Entity, esegue un oggetto presente nel Package corrente o in una sua Library;
✓ Run Invoke Workflow, lancia l’esecuzione di un Workflow;
✓ Export To DataShelf, esporta i dataset presenti nel Model su un DataShelf;
✓ Export Book To DB, esporta i dataset presenti nel Model su un DB esterno;
✓ Export Book To File, esporta su file i dati presenti nel Model.
I Command Run SQL ed Export Viewer sono i soli che consentono la definizione di parametri con Direction Out e InOut, |
Ciascun Command dispone di propri elementi di configurazione, come descritto nei paragrafi successivi.
APPROFONDIMENTI E ARGOMENTI CORRELATI
& Run SQL