URL: /Tools/Dashboard

Method: GET

Descrizione

Questo metodo fornisce un'interfaccia per visualizzare statistiche su dati interni o esterni a DocsMarshal in una Dashboard.

Formato richieste

Legenda:
Parametro obbligatorio
Parametro opzionale

{
    'SessionID': SID,

    'DashboardId': "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    oppure
    'DashboardExternalId': "MyDashboard",

    'ShowFilter': true/false,
    'ItemId': "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    'SqlParameters': [
        {
            "Name": "NomeCampo",
            "FieldType": "String",
            "Value": "ValoreDiProva",
            "ValueFormat": "ValueFormat",
        },
    ]
}

Note

• sessionId: Se non specificato propone la maschera di login DocsMarshal.
• DashboardId o DashboardExternalId: Indica quale dashboard si desidera visualizzare.
• ShowFilter: Se la sorgente dati della dashboard è una view che permette di applicare filtri, oppure un SQL con parametri, allora viene mostrata l'interfaccia di filtro prima di caricare la dashboard. Si può utilizzare il parametro ShowFilter (di default true) per saltare la pagina di filtro e visualizzare direttamente la pagina senza alcun filtro applicato.
• ItemId: Indica quale dashboard item deve essere inizialmente selezionato. Le dashboard item sono le diverse visualizzazioni disponibili all'interno di una stessa dashboard.
• È possibile, all'interno della dashboard, avere accesso al SessionId dell'utente connesso. Per usare questo valore è sufficiente dichiarare nella dashboard un parametro di tipo Guid che si chiama esattamente PortalSessionId. Quel parametro sarà valorizzato dal portal con il SessionId dell'utente corrente. Questo consente di comporre dei link ad altre pagine del portal conservando l'autenticazione utilizzata per la Dashboard.
• SqlParameters: in caso di dashboard con sorgente dati da sql command, è possibile impostare dei parametri che verranno inseriti nella query SQL, permettendo un filtro server-side della ricerca.
  'Name' rappresenta il nome dell'SQL parameter, 'FieldType' il tipo del parametro.
  Per maggiori informazioni, vedi la documentazione relativa a Grid/BySource