DOCSMarshal /Grid /Tasks

URL: /Grid/Tasks

Method: GET

Descrizione

Questo metodo ritorna una pagina con una griglia dei tasks attivi per l'utente connesso. La griglia offre funzionalità di base come ordinamento e ricerca e offre svariate opzioni di personalizzazione e integrazione.

Formato richieste

Legenda:
Parametro obbligatorio
Parametro opzionale

{
SessionId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
ElementId: 'ElementId',
Preload: true/false,
SearchVisible: true/false,
SearchText: 'SearchText',
DateTimeFormat: 'DateTimeFormat',
EnableSelection: true/false,
MultipleSelectionCheckboxes: "none/always/onClick/onLongTap",
NoColumnChooser: true/false,
NoGrouping: true/false,
NoColReordering: true/false,
NoColResizing: true/false,
AllowOpenTask: true/false,
UsePaging: true/false,
PageSize: 10,
GridId: 'MyGridId',
UserId: 'MyUser',
SaveLayout: true/false,
LoadLayout: true/false,
SaveLayoutFilters: true/false,
Export: true/false,
ExportFileName: 'ExportFileName',
ExportSelectedData: true/false,
ShowNavigationButtons: true/false,
ShowRowLines: true/false,
ShowColLines: true/false,
FocusOnLoad: true/false,
AutoRefresh: true/false,
SelectExternalIds: 'SelectExternalIds',
OrderByExternalIds: 'OrderByExternalIds',
GroupByExternalIds: 'GroupByExternalIds',
MenuVisible: true/false,
MenuEnabled: true/false,
NoLayout: true/false,
NoBootstrap: true/false,
NoJQuery: true/false,
NoDxIncludes: true/false,
Popups: {
        Fullscreen: false,
        Width: '100%',
        MaxWidth: '900px',
        Height: '100%',
        MaxHeight: '600px',
        ResizeEnabled: true,
        DragEnabled: true
    },
Where:
    [
        {
            FieldExternalId: 'Process.ExternalId',
            Condition: 'IsEqual',
            Value: 'GestioneNuovoCliente'
        }
    ]
}

Descrizione parametri

ElementId

string

Id dell'elemento HTML che verrà generato per creare la griglia. L'ID NON deve riferirsi ad un ID già esistente, in quando DocsMarshal ne creerà uno.

SearchVisible

bool

Se true allora viene mostrata la barra di ricerca.

Questa ricerca agisce client-side ed è modificabile dall'utente.

SearchText

string

Definisce il valore iniziale di ricerca.

Questa ricerca agisce client-side ed è modificabile dall'utente.

DateTimeFormat

string

Stringa di formato per la formattazione dei campi DateTime

EnableSelection

bool

Se true abilita la selezione, ovvero la possibilità di dare focus a una o più righe.

Valore di default: true.

MultipleSelectionCheckboxes

String

Definisce se e quando verranno visualizzati i checkbox per la gestione della multiselezione. I possibili valori sono i seguenti:

  • always: sempre visibili;
  • none: sempre nascosti, viene rimossa la colonna aggiuntiva dedicata ai checkbox;
  • onClick: visibili quando l'utente clicca la colonna dei checkbox, oppure se vengono selezionate due o più righe;
  • onLongTap: visibili se viene tenuto premuto il tasto sinistro del mouse, oppure se viene tenuto premuto il dito con un dispositivo touch.

NoColumnChooser

bool

Se true allora verrà tolta all'utente la possibilità di aggiungere e rimuovere colonne dalla griglia.

NoGrouping

bool

Se true allora verrà tolta all'utente la possibilità di usare la funzione "Group By".

NoColReordering

bool

Se true allora verrà tolta all'utente la possibilità di riordinare le colonne.

NoColResizing

bool

Se true allora verrà tolta all'utente la possibilità di modificare la largheza delle colonne.

AllowOpenTask

bool

Determina se l'utente può visualizzare ed evadere i task.

Valore di default: true

UsePaging

bool

Se true verrà impostata una paginazione con 20 elementi per pagina.

PageSize

int

Il numero impostato è il corrispettivo degli elementi visualizzati per ogni pagina.

Valore di default: 20

Export

bool

Se true, allora sarà visibile un pulsante che permette l'esportazione della griglia come file xlsx.

Valore di default: false

ExportFileName

string

Permette di specificare il nome del file generato dalla procedura di Export.

ExportSelectedData

bool

Abilita l'esportazione mirata alla selezione corrente.

ShowNavigationButtons

bool

Se true verranno visualizzati i bottoni avanti e indietro ( < e > ) nella paginazione.

ShowRowLines

bool

Se true mostra il bordo tra le righe

ShowColLines

bool

Se true mostra il bordo tra le colonne

FocusOnLoad

bool

Se true, allora il fuoco verrà portato sulla griglia non appena la griglia sarà stata generata.

Valore di default: true

AutoRefresh

bool

Indica che l'elenco dei task deve mantenersi aggiornato. La frequenza di refresh è gestita automaticamente ed è tanto più veloce quanti più task vengono ricevuti dall'utente.

Valore di default: true

SelectExternalIds

string

Elenco e ordine degli ExternalId dei campi da mostrare in griglia, separati dal carattere ';'. Per ogni campo elencato in questo parametro si può utilizzare questa sintassi particolare:

[Alias]: le parentesi quadre permettono di modificare il nome con il quale una colonna viene mostrata.
SelectExternalIds: "InsertDt[Data inserimento];Name"

OrderByExternalIds

string

Elenco degli ExternalId dei campi su cui effettuare ordinamento, separati dal carattere ';' e seguiti dal carattere underscore e A (Ascending) o D (Descending)

Ad esempio: Persone_A;Nome_D

GroupByExternalIds

string

Elenco degli ExternalId dei campi su cui effettuare raggruppamento, separati dal carattere ';'. È possibile inserire l'ExternalId tra (), così facendo il gruppo verrà inizialmente impostato come collassato, altrimenti verrà impostato come espanso

MenuVisible

Bool

Se impostato a "true" allora sarà visibile la barra laterale, che permette di eseguire operazioni sui tasks.

Valore di default: false

MenuEnabled

Bool

Se impostato a "true" allora verranno abilitati i comandi che permettono di mostrare e nascondere la barra laterale.

Valore di default: false

SessionId

Guid

SessionID dell'utente loggato. Se non specificato, allora verrà fatto eseguire il login dell'utente presso il DocsMarshalPortal.

NoLayout

Bool

Se true, l'HTML generato includerà esclusivamente i tag <script> e <link> necessari, oltre all'elemento contenitore specificato come ElementId.

Se false, l'HTML generato sarà una pagina completa.

NoBootstrap

Bool

Se true allora non verrà generato il codice per l'inclusione di Bootstrap. Usare solamente se Bootstrap è già incluso nella pagina di inclusione. È richiesto Bootstrap>=3.3.7, sia script che stylesheet.

NoJQuery

Bool

Se true allora non verrà generato il codice per l'inclusione di jQuery. Usare solamente se jQuery è già incluso nella pagina di inclusione. È richiesta una versione di jQuery pari o successiva a v3.x.

NoDxIncludes

Bool

Se true allora non verrà generato il codice per l'inclusione degli script DevExpress. Usare solamente se sono già inclusi nella pagina altri componenti di questo tipo.

SaveLayout

Bool

Se true, allora il sistema salverà ogni modifica che l'utente apporterà al layout della griglia. Se false, allora la griglia verrà mostrata ogni volta con le impostazioni di default definite tramite i parametri di configurazione.

DocsMarshal memorizza un layout per ogni UserId per ogni GridId.

Attenzione: se questo parametro è impostato su "true" alcuni parametri di ordinamento/raggruppamento come OrderById o GroupByExternalIds (e simili) verranno ignorati.

LoadLayout

Bool

Se true, allora il sistema caricherà il layout precedentemente salvato per questi utenti e griglia, se presente.

DocsMarshal memorizza un layout per ogni UserId per ogni GridId.

GridId

String

Identificatore della griglia per il salvataggio del layout.

Il GridId dovrebbe identificare in modo univoco la pagina nella quale viene usata la griglia, oppure dovrebbe indicare lo scopo della griglia. Uno stesso UserId avrà lo stesso layout in tutte le griglie che condividono lo stesso GridId.

Valore di default: Un identificativo univoco delle classi documentali selezionate.

UserId

String

Identificatore dell'utente per il salvataggio del layout.

Valore di default: Un identificativo univoco dell'utente loggato.

Where

Array di oggetti

Specifica dei filtri di ricerca da applicare server-side, non modificabili dall'utente. Ogni elemento dell'array specifica una condizione su un campo aggiuntivo. Tutte le condizioni vengono combinate in AND.

Ogni elemento è così formato:

FieldExternalId

String

ExternalId del campo su cui si vuole applicare il filtro. I valori possibili sono i seguenti:

  • IdTask
  • IdProcess
  • InsertDt
  • Name
  • Description
  • KeepInChargeDt
  • KeepInCharge
  • KeepInChargeSecurityIdentityId
  • SecurityIdentityId
  • ExternalId
  • Priority
  • WFServiceGetDt
  • WFServiceInstanceId
  • LanguageId
  • DomainId
  • TaskExpiration
  • KeepInChargeExpiration
  • ActivityId
  • ActivityRuntimeId
  • Tags
  • WFServerVersion
  • Process.WFServerVersion
  • Process.Message
  • Process.CompletedPercentage
  • Process.Name
  • Process.WorkStationId
  • Process.Priority
  • Process.OwnerId
  • Process.InsertDt
  • Process.StartDt
  • Process.EndDt
  • Process.IdWorkflow
  • Process.StorageId
  • Process.ProcessState
  • Process.WFServiceWorkstationId
  • Process.IdRuntimeWorkflow
  • Process.IdParentProcess
  • Process.ErrorMessage
  • Process.ToBeDeleted
  • Process.ExternalId
  • Process.IdWorkflowEventTrigger
  • SecurityIdentityName
  • KeepInChargeSecurityIdentityName
  • Domain

Condition

String

Condizione di ricerca da applicare sul campo specificato da FieldId o FieldExternalId.

Fare riferimento all'elenco delle condizioni valide riportato nella documentazione delle Condition

Value

String

Operando della condizione di ricerca.

Value2

String

Operando aggiuntivo della condizione di ricerca, necessario ad esempio per specificare una condizione Between su un campo di tipo DateTime.

Values

String

Operandi della condizione di ricerca.

ValueFormat

String

Stringa di formato da utilizzare per interpretare i valori Value e Value2 qualora il tipo del campo su cui si sta applicando il filtro non sia String e sia quindi necessaria una conversione.

ValueCultureInfoName

String

CultureInfo Name da utilizzare per interpretare i valori Value e Value2 qualora il tipo del campo su cui si sta applicando il filtro non sia String e sia quindi necessaria una conversione.

Ad esempio: IT-it, EN-us.

Popups

Oggetto

Permette di configurare l'aspetto e il comportamento di tutti i popup aperti dalla griglia.

Fullscreen

Bool

Indica che il popup deve essere aperto ad una dimensione pari a quella dell'intera pagina

DragEnabled

Bool

Consente all'utente di spostare il popup trascinandolo.

ResizeEnabled

Bool

Consente all'utente di ridimensionare il popup.

ShowTitle

Bool

Mostra il titolo del popup, ovvero la barra nella parte alta dello stesso.

ShowCloseButton

Bool

Mostra a fianco del titolo un bottone per la chiusura del popup.

Width

CSS size

Indica la larghezza del popup.

Height

CSS size

Indica l'altezza del popup.

MinWidth

CSS size

Indica la larghezza minima del popup.

MinHeight

CSS size

Indica l'altezza minima del popup.

MaxWidth

CSS size

Indica la larghezza massima del popup.

MaxHeight

CSS size

Indica l'altezza massima del popup.

Position

string

Indica dove deve essere posizionato il popup. Questo parametro accetta una stringa nel seguente formato:
my {position} at {position} of {container}

"position" può assumere uno dei seguenti valori:

  • bottom
  • center
  • left
  • left bottom
  • left top
  • right
  • right bottom
  • right top
  • top

"container" può essere il valore speciale "window", che quindi posiziona l'elemento relativamente alla finestra, oppure un selettore CSS che identifica l'elemento relativamente a cui posizionare il popup.

Valore di default: "my center at center of window"

Codice di esempio: API JS

<div id="my-grid"></div>
$('#my-grid').dmTaskGrid({
    SelectExternalIds: 'InsertDt[Date];TaskName;TaskDescription',
    OrderByExternalIds: 'InsertDt_D'
});