DOCSMarshal /JS

$().dmTaskAdmin()

Questo componente permette di visualizzare un task, anche se è già stato chiuso e anche se non è assegnato all'utente connesso.
L'unico requisito è di avere le riservatezze di lettura sul processo relativo al task.

Il seguente codice mostra come costruire il task passandogli dei parametri, ed ottenerne l'istanza per invocare successivamente dei metodi; 

<div id="container"></div>
<script>
    // costruisco il task
    $('#container').dmTaskAdmin({
        ...oggetto contenente i parametri...
    });
    // ottengo l'istanza
    let instance = $('#container').dmTaskAdmin('instance');
</script>

Elenco parametri

Elenco metodi

Descrizione parametri

cancelButtonLabel

Type: String

Permette di definire l'etichetta del bottone di outcome di "Cancel".

defaultLayoutMode

Type: String
Default: Tabbed

Permette di definire il tipo di layout da utilizzare per la visualizzazione del task.
Valori possibili: SingleColumn, Tabbed, Designer

height

popup

Type: Bool
Default: false

Se il parametro ha valore "true" allora il task verrà mostrato in un popup.
Se il parametro ha valore "false" allora il task verrà costruito all'interno del contenitore indicato dal contesto jQuery.

popupOptions

Type: PopupOptions
Default: null

Consente di personalizzare la dimensione, posizione e comportamento del popup all'interno del quale il task verrà visualizzato. Questo parametro ha effetto solamente se popup ha valore "true".

returnUrl

Type: String
Default: null

Permette di definire un url da aprire in seguito all'esecuzione degli outcome di uscita dal task.

saveAndCloseButtonLabel

Type: String

Permette di definire l'etichetta del bottone di outcome di "Save and close".

sessionId

Type: Guid
Default: null

Indica il SessionId della sessione da utilizzare per autenticarsi a DocsMarshal.

showBorders

showCancelButton

Type: Bool

Permette di definire se mostrare il bottone dell'outcome "Cancel".

showMenuButton

showMenuInfos

showOperations

showOutcomes

showProcessInfos

showProcessNotes

showSaveAndCloseButton

Type: Bool

Permette di definire se mostrare il bottone dell'outcome "Save and close".

showSearch

showTaskInfos

showTaskTakeInChargeInfos

showVariables

showWorkflowInfos

skipCustomUrl

Type: Bool
Default: false

Permette di definire se ignorare il valore dell'url custom del task, se definito.

stopTakeInChargeButtonLabel

Type: String

Permette di definire l'etichetta del bottone di annullamento presa in carico di un task

takeInChargeButtonLabel

Type: String

Permette di definire l'etichetta del bottone di presa in carico di un task

taskExternalId

Type: string

Indica l'externalId del task da aprire

taskId

Type: Guid

Indica l'ID del task da aprire

Descrizione metodi, parametri e valori di ritorno

task.on()

Registra un callback ad un evento.
Il parametro eventName indica il nome dell'evento a cui iscriversi.
Gli eventi disponibili sono i seguenti:

  • afterComplete
  • afterOperationExecuted
  • afterSaveAndClose
  • afterStopTakeInCharge
  • afterTakeInCharge
  • beforeCancel
  • beforeComplete
  • beforeOpenCustomUrl
  • beforeOpenReturnUrl
  • contentReady
  • disposed
  • error
  • variableValueChanged
Il parametro callback è la funzione Javascript che deve essere invocata quando l'evento viene scatenato.

task.off()

Annulla l'iscrizione di un callback ad un evento.

Questo metodo consente di annullare l'iscrizione ad un evento che era stata precedentemente effettuata tramite l'utilizzo del metodo on oppure tramite i parametri dedicati agli eventi (onContentReady, onCustomButtonClick, ...).
Il parametro eventName indica il nome dell'evento da cui annullare l'iscrizione.
Gli eventi disponibili sono i seguenti:

  • afterComplete
  • afterOperationExecuted
  • afterSaveAndClose
  • afterStopTakeInCharge
  • afterTakeInCharge
  • beforeCancel
  • beforeComplete
  • beforeOpenCustomUrl
  • beforeOpenReturnUrl
  • contentReady
  • disposed
  • error
  • variableValueChanged
Il parametro callback è la funzione Javascript che si desidera non venga più invocata quando l'evento si verifica.

task.dispose()

task.close()

Chiude il visualizzatore del task.
Se il task era aperto in un popup allora quest'ultimo verrà chiuso, altrimenti tutto il contenuto del task verrà distrutto e il contenitore verrà lasciato vuoto.

task.startLoading()

Mostra l'indicatore di caricamento del task.
Il parametro options permette di fornire ulteriori opzioni al componente che si occupa di mostrare il pannello di caricamento. L'oggetto accetta le seguenti opzioni:

  • message: permette di impostare il messaggio da mostrare nel pannello di caricamento (facoltativo)
Questo metodo può essere utilizzato per impedire all'utente di interagire con il task mentre si stanno eseguendo operazioni in background.

task.endLoading()

Nasconde l'indicatore di caricamento custom.

await task.loadTask(taskId, mustBuild, forceRefresh)

await task.refresh(repaint)

task.taskIsUsable()

await task.saveAndClose(task)

task.focusSection(section)

await task.executeOutcome(task, outcome, triggerEvent)

task.getTask()

task.getDomains()

task.getLanguages()

task.getOutcomesList(task)