DOCSMarshal /Grid /Processes

URL: /Grid/Processes

Method: GET

Descrizione

Questo metodo ritorna una pagina con una griglia di processi. La griglia offre funzionalità di base come ordinamento e ricerca e offre svariate opzioni di personalizzazione e integrazione.

I processi sono opzionalmente filtrati tramite i seguenti parametri:

  • Where
  • RelatedProfile
  • RelatedProfiles
  • WorkflowTag
  • WorkflowTags
  • LoadParents
  • LoadChildren
tramite il parametro Where, oppure tramite il parametro RelatedProfile/s.

Formato richieste

{
SessionId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
ConfigUrl: 'http://www.site.com/config.json',
ElementId: 'MyGrid',
SelectExternalIds: "Priority;CompletedPercentage;Name;Message",
GroupByExternalIds: "Name",
OrderByExternalIds: "Priority_D;EndDt_A",
ProcessStates: "None;Started;Idle;Ended;Error;Preparing",
NoLayout: true/false,
NoJQuery: true/false,
NoBootstrap: true/false,
NoDxIncludes: true/false,
SearchVisible: true/false,
SearchText: "Search",
DateFormat: "dd/mm/yyyy",
DateTimeFormat: "dd/mm/yyyy HH:mm:ss",
MultipleSelection: true/false,
EnableSelection: true/false,
NoColumnChooser: true/false,
NoGrouping: true/false,
NoColReordering: true/false,
NoColResizing: true/false,
UsePaging: true/false,
PageSize: 25,
ShowNavigationButtons: true/false,
GridId: 'MyGridId',
UserId: 'MyUser',
SaveLayout: true/false,
LoadLayout: true/false,
SaveLayoutFilters: true/false,
ShowRowLines: true/false,
ShowColLines: true/false,
RowFilterCallback: "rowFilterCallback",
OnRowPrepared: "onRowPrepared",
Where:
    [
        {
            FieldExternalId: "Priority",
            Condition: "Between",
            Value: 2,
            Value2: 5,
            ValueFormat: "0.00",
            ValueCultureInfoName: "IT-it",
            Values: [ 1, 2, 3]
        },
        ...
    ],
WorkflowTag: "MyTag",
WorkflowTags: ["MyTag1", "MyTag2"],
RelatedProfile: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
RelatedProfiles: ["xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"],
RelatedProfilesDirection: "in/out",
LoadChildren: true/false,
LoadChildrenMaxDepth: 10,
LoadParents: true/false,
LoadParentsMaxDepth: 10,
Height: "200px",
TitlesFg: "rgb(51, 51, 51)",
AlternateRows: true/false,
AlternateRowsColor: "rgba(100, 20, 150, .3)",
FocusOnLoad: true/false,
Export: true/false,
ExportFileName: "Riepilogo",
Autorefresh: 60,
UserIdForFilter: 1/2/3...,
GetConnectedUserProcesses: true/false
}

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.

UserIdForFilter

Int

Se valorizzato permette di caricare esclusivamente i processi in cui ha lavorato l'utente con l'ID impostato.

GetConnectedUserProcesses

Bool

Se valorizzato permette di caricare esclusivamente i processi in cui ha lavorato l'utente connesso.

Valore di default: false.

Codice di esempio: API JS

<div id="my-grid"></div>
$('#my-grid').dmProcessesGrid({
    SelectExternalIds: 'Priority;CompletedPercentage;Name;Message',
    OrderByExternalIds: 'StartDt_D',
    Where: [
        {
            FieldExternalId: 'Name',
            Condition: 'Contains',
            Value: 'Test'
        }
    ]
});