DOCSMarshal /JS

$().dmProcessFollower()

Questo Componente, permette di costruire un process follower di DocsMarshal in pagina.

Il seguente codice mostra come costruire il componente passandogli dei parametri ed ottenerne l'istanza per invocare successivamente dei metodi. 

<div id="container"></div>
<script>
// costruisco il componente
    $('#container').dmProcessFollower({
        ...oggetto contenente i parametri...
    });
// ottengo l'istanza del componente
    let instance = $('#container').dmProcessFollower('instance');
    ...
// in un secondo momento, ad esempio rispondendo ad un evento, chiamo un metodo del componente
    instance.getProcess();
</script>

Elenco parametri

Elenco metodi

Elenco eventi

Descrizione parametri

idProcess

Type: Guid
Default: null

Permette di definire quale processo visualizzare.

sessionId

Type: String
Default: null

Permette di definire quale sessione del Portal utilizzare.

allowConfigOperations

Type: Boolean
Default: true

Permette di definire se permettere di eseguire operazioni da admin (assegnazione Task, riavvio, visualizzazione dei parametri), qualora le riservatezze lo permettessero.

showChildren

Type: Boolean
Default: true

Permette di definire se visualizzare anche i processi figli o meno.

maxDepthToCheckChildren

Type: Int
Default: null

Permette di definire un eventuale limite di profondità per la lettura dei processi figli.

showAllChildrenContent

Type: Boolean
Default: false

Permette di definire se visualizzare il Process Message anche dei processi figli.

loadProcessNotesMode

Type: String
Default: OnlyForRoot
Valori accettati: OnlyForRoot, Nothing

Permette di definire se visualizzare le note del Processo o meno.

showProcessNotesInAbsoluteTime

Type: Boolean
Default: false

Permette di definire se visualizzare le note di Processo in tempo assoluto o relativo.

loadTasksMode

Type: String
Default: All
Valori accettati: All, OnlyForIdle, Nothing

Permette di definire la modalità di lettura dei Task:

  • Nothing: non carica i Tasks
  • OnlyForIdle: carica i Tasks solo per i processi in idle
  • All: carica tutti i Tasks dei processi visualizzati

buttons

Type: String[]
Default: ["restart", "processParameters", "editTaskAssignment"]
Valori accettati: restart, processParameters, editTaskAssignment

Permette di definire quali bottoni utilizzare:

  • restart: permette di riavviare il processo
  • processParameters: permette di visualizzare i parametri del processo
  • editTaskAssignment: permette di visualizzare il bottone per modificare l'assegnazione di un task

stopWhenAllFinished

Type: Boolean
Default: true

Permette di definire se il componente deve smettere di effettuare la ricerca dei processi una volta che questi sono tutti conclusi o in errore.

updateInterval

Type: Int
Default: 1

Permette di definire l'intervallo di attesa tra una ricerca e l'altra, quest'ultima è espressa in secondi.

useGenericErrorMessage

Type: Boolean
Default: true

Permette di definire se il componente deve mostrare degli errori generici o meno.

popup

Type: Boolean
Default: false

Permette di definire se il componente deve essere costruito all'interno di un popup o meno.

popupOptions

Type: PopupOptions
Default: {}

Permette di definire delle opzioni custom per il popup utilizzato, vedi Popup.

taskOptions

Type: TaskOptions
Default: {}

Permette di definire delle opzioni custom per il task, vedi Task.

Descrizione metodi

on

Permette di registrarsi ad un evento mentre il componente è già in esecuzione.
Richiede un parametro stringa che identifica il nome dell'evento a cui registrarsi.
Vedi eventi

off

Permette di rimuovere l'iscrizione ad un evento mentre il componente è già in esecuzione.
Richiede un parametro stringa che identifica il nome dell'evento da cui rimuovere l'iscrizione.
Vedi eventi

dispose

Permette di applicare il dispose del componente.

startWatching

Avvia l'esecuzione delle ricerche dei processi.

stopWatching

Blocca l'esecuzione delle ricerche dei processi.

getProcess

Ritorna il Processo corrente.

getChildren

Ritorna i Processi figli correnti.

getAllProcesses

Ritorna tutti i Processi caricati.

getProcessById

Ritorna il processo desiderato (ricercato tra quelli presenti nel componente).
Richiede un parametro Guid che identifica l'id del processo da ritornare.

changeWatchingInterval

Permette di modificare l'intervallo di attesa tra una chiamata e l'altra.
Richiede un parametro intero che identifica i secondi din intervallo.

getTaskById

Ritorna il task desiderato (ricercato tra quelli presenti nel componente).
Richiede un parametro Guid che identifica l'id del task da ritornare.

Descrizione eventi

processSuccess

Questo evento viene invocato quando il processo (e i relativi processi figli) sono terminati con successo.
Al callback viene passato un oggetto con le seguenti proprietà:

  • component
    L'istanza del componente.
  • stopWatching
    Indica se il componente deve smettere di effettuare chiamate per leggere il processo o meno.

error

Questo evento viene invocato quando il componente riscontra un errore ed è possibile personalizzarne la visualizzazione dell'utente.
È possibile bloccare la visualizzazione dell'alert di default ritornando false durante l'esecuzione.
Al callback viene passato un oggetto con le seguenti proprietà:

  • cancel
    Permette di indicare se ignorare l'errore o meno.
  • message
    Il messaggio di errore.
  • idProcess
    L'id del processo.
  • stopWatching
    Indica se il componente deve smettere di effettuare chiamate per leggere il processo o meno.

disposed

Questo evento viene invocato quando il componente ha concluso il dispose.

beforeOpenTask

Questo evento viene invocato quando prima dell'apertura di un Task.
È possibile bloccare l'apertura del Task ritornando false durante l'esecuzione.
Al callback viene passato un oggetto con le seguenti proprietà:

  • task
    Il task da visualizzare.
  • doubleConfirm
    Permette di indicare se deve essere utilizzata o meno la doppia conferma per richiedere all'utente se desidera aprire il Task o meno.
  • confirmQuestion
    Permette di modificare il testo dell'alert relativo alla doppia conferma dell'apertura.
  • confirmTitle
    Permette di modificare il titolo dell'alert relativo alla doppia conferma dell'apertura.
  • confirmIcon
    Permette di modificare l'icona' dell'alert relativo alla doppia conferma dell'apertura.
  • byButton
    Indica se l'evento deriva dalla pressione del bottone o dal caricamento automatico del Task.