Controllo delle esecuzioni: le Action |
  
|
Controllo delle esecuzioni: le Action |
|
Il Model del Book mette a disposizione una serie di azioni con cui gestire e monitorare le esecuzioni del Book stesso. In particolare, esse permettono di:
✓ definire notifiche da esporre a video (NotifyMessage);
✓ inserire informazioni aggiuntive all’interno del Log (Log) o del Book Trace (Trace);
✓ apportare modifiche ad elementi del Model (AcceptChanges, DiscardChanges, FlushViewerData, SetCurrentRow e GetCurrentRow);
✓ intervenire sulla visualizzazione dei Viewer nella finestra di esecuzione (ShowViewer, HideViewer, RenderViewer, ResetViewer);
✓ agire sulle modalità di esposizione di una Grid (RefreshGridSort, RefreshGridFilters, ScrollGridToRow).
Queste Action (o System Action) possono essere richiamate all'interno di un Command con la speciale sintassi
EXEC idq.ActionName @Param1 = Value1 , … , @ParamN = ValueN
dove il simbolo @ permette di identificare eventuali parametri di esecuzione.
L'Action idq.NotifyMessage consente di visualizzare a video notifiche in stile pop-up. Essa accetta i seguenti parametri:
✓ @Message, testo della notifica da esporre;
✓ @Subject, intestazione della notifica;
✓ @Severity, gravità della notifica;
✓ @Pinned, consente di fissare la notifica sullo schermo.
Tutti i parametri di una idq.NotifyMessage sono di tipo VARCHAR tranne @Pinned, il quale è un BIT. |
In caso il parametro @Subject non sia specificato, il sistema visualizza il FullName del Book quale intestazione della modifica.
Il parametro @Severity, invece, ammette i seguenti valori:
✓Information, valore di default utilizzato in caso il parametro non sia specificato;
✓Warning;
✓Error.
Infine il valore di default, utilizzato in caso il parametro @Pinned non sia specificato, è 0 che coincide con unpinned.
In caso la idq.NotifyMessage sia unpinned, è possibile definire uno specifico tempo di visualizzazione della notifica mediante i Tools del menu Options nella toolbar Package Workspace. |
L'Action idq.Trace premette di inserire messaggi personalizzati nel Book Trace. Essa accetta i seguenti parametri:
✓ @Message, testo del messaggio da registrare nel Book Trace;
✓ @Severity, gravità del messaggio.
Il parametro @Severity, invece, ammette i seguenti valori:
✓Information, valore di default utilizzato in caso il parametro non sia specificato;
✓Warning;
✓Error.
Tutti i parametri di una idq.Trace sono di tipo VARCHAR. |
L'Action idq.Log premette di inserire messaggi personalizzati nel Log. Essa accetta i seguenti parametri:
✓ @Message, di tipo VARCHAR, testo del messaggio da registrare nel Book Trace;
L'Action idq.AcceptChanges svuota eventuali tabelle di sistema associate al Full Edit Mode. Essa accetta il parametro @TableName, di tipo VARCHAR, con cui specificare il nome della tabella del Model su cui agire e il parametro @RowId, di tipo INT, con cui specificare l'identificativo della riga da modificare.
L'Action idq.DiscardChanges ripristina le tabelle speciali associate al Full Edit Mode. Essa accetta il parametro @TableName, di tipo VARCHAR, con cui specificare il nome della tabella del Model su cui agire e il parametro @RowId, di tipo INT, con cui specificare l'identificativo della riga da candellare.
In caso il parametro di una idq.AcceptChanges o di una idq.DiscardChanges non sia specificato, l'Action prende in considerazione tutte le tabelle in Full Edit Mode. |
L'Action idq.FlushViewerData forza un aggiornamento delle viste speciali nel Model (e.g ActiveRow, SelectedRows, Info). Essa accetta il solo parametro @TableName, di tipo VARCHAR, con cui specificare il riferimento alla tabella del Model su cui agire, espressa nella forma ViewerName\Tabella\<info> , dove:
✓ ViewerName è il nome del Viewer;
✓ Tabella è il nome della tabella del Model;
✓ <info> può essere ActiveRow/SelectedRows/…
L'Action idq.SetCurrentRow imposta la riga corrente per una Table o Relation di un SyinchronizationGroup. Essa accetta i seguenti parametri obbligatori:
✓ @SynchronizationGroup specifica il gruppo di sincronizzazione della Table o Relation;
✓ @DataMember indica la Table o Relation esposta nel Viewer;
✓ @RowID indica la riga da impostare come corrente (i.e. __InternalIdentifier).
L'Action idq.GetCurrentRow restituisce la riga corrente per una Table o Relation di un SyinchronizationGroup. Essa accetta i seguenti parametri:
✓ @SynchronizationGroup specifica il gruppo di sincronizzazione della Table o Relation;
✓ @DataMember indica la Table o Relation esposta nel Viewer;
L'Action idq.ShowViewer permette di visualizzare un Viewer nascosto a video. Essa accetta i seguenti parametri:
✓ @Viewer specifica il FullPath del Viewer da mostrare;
✓ @Activate rende attivo il Viewer mostrato;
✓ @Pinned consente di fissare il Viewer sullo schermo;
✓ @SingleMode permette di nascondere i Viewer che condividono lo stesso tab.
Tutti i parametri di una idq.ShowViewer sono di tipo BIT tranne @Viewer, il quale è un VARCHAR. |
i valori di default degli ultimi tre parametri sono, rispettivamente:
✓ 1 rende attivo il Viewer mostrato a video;
✓ 1 fissa sullo Schermo il Viewer;
✓ 0 non nasconde gli altri Viewer presenti sullo stesso tab.
Nel caso in cui lo script di un command ExportToDb o ExportToDataShelf contenga esplicitamente la gestione di una transazione, la Action idq.ShowViewer avrà effetto solo impostando la property Use Transaction a False. |
L'Action idq.HideViewer consente di nasconde un Viewer esposto a video. Essa accetta il solo parametro @Viewer, di tipo VARCHAR, con cui specificare il FullPath del Viewer da nascondere.
L'Action idq.RenderViewer forza il rendering di un Viewer, ossia il suo caricamento a video. Essa accetta il solo parametro @Viewer, di tipo VARCHAR, con cui specificare il FullPath del Viewer su cui effettuare il rendering.
È possibile forzare il rendering di un Viewer: ✓ con AutoStart impostato a False; ✓ il cui Chapter non sia ancora stato caricato; ✓ su cui è stata applicata una Action di tipo idq.ResetViewer. |
L'Action idq.ResetViewer forza il reset di un Viewer, cioè lo espone come se non fosse stato caricato a video. Essa accetta il solo parametro @Viewer, di tipo VARCHAR, con cui specificare il FullPath del Viewer su cui effettuare il reset.
L'Action idq.RefreshGridSort forza l’aggiornamento di una Grid in relazione all’eventuale ordinamento impostato. Essa accetta il solo parametro @Viewer, di tipo VARCHAR, con cui specificare il FullPath del Viewer Grid.
L'Action idq.RefreshGridFilters forza l’aggiornamento di una Grid in relazione ad eventuali filtri impostati. Essa accetta il solo parametro @Viewer, di tipo VARCHAR, con cui specificare il FullPath del Viewer Grid.
L'Action idq.ScrollGridToRow esegue lo scroll di una Grid ad una specifica riga della prima Band in ordine gerarchico. Essa accetta i seguenti parametri:
✓ @Viewer, FullPath della Grid su cui effettuare lo scorrimento;
✓ @Table, tabella del Model visualizzata dalla Grid;
✓ @RowId, indice di riga sul quale deve fermarsi lo scorrimento;
✓ @Column, colonna della tabella del Model, rispetto alla quale effettuare un ulteriore scroll orizzontale fino ad una determinata cella;
✓ @Action, azione da eseguire sulla riga o cella in cui si arresta lo scorrimento (i.e. Select, Activate, SelectAndActivate, Edit).
Tutti i parametri di una idq.ScrollGridToRow sono di tipo VARCHAR tranne @RowId, il quale è un INT. |
L'Action idq.ShowMessage, disponibile a partire da Irion EDM 2016 Update 11, consente di visualizzate una finestra modale contenente informazioni e pulsanti che possono essere riferiti ad altri command del Book. Essa accetta i seguenti parametri:
✓@Caption (facoltativo), intestazione della finestra modale;
✓@Text (obbligatorio), testo esposto all’interno della finestra modale;
✓@Icon (facoltativo), icona esposta nella modale a fianco del testo;
✓@Buttons (facoltativo), elenco dei bottoni esposti nella modale;
✓@Command (facoltativo), il Command che viene scatenato al click su un bottone della modale.
Il parametro @Icon ammette i seguenti valori:
✓Information, valore di default utilizzato in caso il parametro non sia specificato;
✓Warning;
✓Error;
✓Question.
Il parametro @Buttons permette di specificare i bottoni da creare e le relative etichette, che devono essere elencate nell’ordine desiderato e separate da virgola, come ad esempio ‘Ok,Cancel’ o ‘Yes,No,Cancel’.
Il numero massimo di bottoni inseribili è 3. Se non specificato, viene creato un solo bottone con etichetta ‘Ok’. |
Il parametro @Command indica il Command lanciato dalla modale, a prescindere dal bottone cliccato. Specificando un parametro di tipo stringa in input al Command, in esecuzione riceverà l’etichetta del bottone cliccato, permettendo di specificare il comportamento a seconda della scelta dell’utente.
Se non specificato, il click di un qualsiasi bottone della modale ha come effetto la semplice chiusura della stessa.