DOCSMarshal /Home /

URL: /Home/

Method: GET

Descrizione

Questa sezione accentra diverse funzionalità del DocsMarshalPortal per permettere l'accesso a diverse funzionalità di DocsMarshal sul web.

La sezione Home è configurabile tramite un apposito file JSON che permette di configurarne l'aspetto e le funzionalità, così da poter costruire velocemente un sito che vada incontro alle esigenze del cliente basandosi interamente sulle funzionalità che DocsMarshal mette a disposizione.

Il file di configurazione deve essere posizionato all'indirizzo specificato della proprietà SiteJsonPath nella configurazione del sito.

Il file è strutturato in formato JSON e può avere queste opzioni:

Formato richieste

Legenda:
Parametro obbligatorio
Parametro opzionale

{
    SiteName: 'DocsMarshal',
    LogoUrl: '/images/logo.svg',
    ThemeBackgroundColor: 'DocsMarshal',
    ThemeForegroundColor: 'DocsMarshal',
    SiteBackground: 'DocsMarshal',
    SiteBackgroundAlternative: 'DocsMarshal',
    SiteForeground: 'DocsMarshal',
    ProfileActions:
    [
        {
            Name: '',
            GroupName: '',
            ClassTypeId: 4,
            ClassTypeExternalId: 'Clienti',
            AllClassTypes: true/false,
            Url: 'http://www.google.it/search?q={nome} {cognome}'
        },
        ...
    ],
    Menu:
    {
        Items:
        [
            {
                Url: '/Clienti',
                Name: 'Anagrafica clienti',
                Icon: 'fa fa-user',
                Role: 'DmGroup_5',
                Hide: true/false,
                Size: '2x1',
                BackgroundColor: '',
                ForegroundColor: '',
                ResetNavButtons: true/false,
                Expanded: true/false,
                Items:
                [
                    ...elementi figlio con la stessa struttura 
                ],
                NavButtons:
                [
                    {
                        Name: 'Info utente',
                        Url: '/Account',
                        Icon: 'fa fa-user',
                        BackgroundColor: '',
                        ForegroundColor: '',
                        Role: 'DmGroup_6',
                        Hide: true/false
                    },
                    ...
                ]
            },
            ...
        ]
    }
}

Descrizione parametri

SiteName

String

Nome del sito. Viene usato per dare un titolo alle pagine e per il breadcrumb nella navbar.

LogoUrl

String

Indirizzo dell'immagine da usare come logo nella navbar in alto a sinistra.

ThemeBackgroundColor

String

Colore CSS da utilizzare come sfondo degli elementi in rilievo e per la navbar.

ThemeForegroundColor

String

Colore CSS da utilizzare per il testo degli elementi in rilievo e nella navbar.

SiteBackground

String

Colore CSS da utilizzare come sfondo del sito.

SiteBackgroundAlternative

String

Colore CSS da utilizzare come sfondo di alcuni elementi particolari.

SiteForeground

String

Colore CSS da utilizzare per il testo.

ProfileActions

Array di oggetti

Specifica delle azioni che si possono eseguire sui profili. Queste azioni vengono mostrate quando, visualizzando una griglia di profili, se ne seleziona uno. Le azioni vengono visualizzate nel menu a sinistra.

Ogni elemento è così formato:

Name

String

Testo che deve apparire sui bottoni relativi a quest'azione.

GroupName

String

Questa stringa (opzionale) serve ad organizzare le azioni qualora fossero numerose, o fosse necessario raggrupparle. Tutte le azioni con lo stesso GroupName vengono raggruppate.

ClassTypeId

int

Se specificato, questa azione apparirà solamente sui profili della classe documentale specificata.

ClassTypeExternalId

string

Se specificato, questa azione apparirà solamente sui profili della classe documentale specificata.

AllClassTypes

bool

Se specificato, questa azione apparirà su tutti i profili.

Url

string

Url da aprire quando l'azione viene cliccata.

L'url può essere costruita dinamicamente utilizzando dati provenienti dal profilo sul quale è stata invocata l'azione. Per fare questo è sufficiente utilizzare nell'url questa sintassi:
{ExternalIdCampo}
Ad esempio quest'URL:
http://www.google.it/search?q={NomeCognome}
effettua una ricerca su google iniettando nell'URL il contenuto del campo con l'ExternalId NomeCognome. Gli ExternalId sono case sensitive ma è sempre disponibile e valido anche il nome alternativo tutto minuscolo, quindi quest'url è equivalente:
http://www.google.it/search?q={nomecognome}

Menu

Oggetto

Definisce l'albero di navigazione del sito. Questo albero viene utilizzato per visualizzare il menu nella sidebar, il menu a tiles per tablet e per aggiungere bottoni nella navbar quando si è in particolari zone del sito.

Ogni elemento è così formato:

Url

String

Url a cui punta il menu.

Name

String

Testo che deve apparire sui bottoni.

Icon

String

Icona da visualizzare per questa voce di menu. Può essere:

  • Un URL ad un'immagine
  • Un'icona di FontAwesome, usando una stringa come "fa fa-search"
  • Un'icona di DevExtreme

Role

String

Se definito, questa voce di menu appare solamente agli utenti che rispettano determinate regole.

Le regole utilizzabili sono le seguenti:

  • DmBusinessRole_X: L'utente deve ricoprire il Business Role con ExternalId X;
  • DmGroup_X: L'utente deve appartenere al Gruppo con ExternalId X;
  • DmSkill_X: L'utente deve possedere la Skill con ExternalId X;
  • DmSkill_X_Y: L'utente deve possedere la Skill con ExternalId X per l'Area con ExternalId Y;
  • DmSkillValue_X: L'utente deve possedere lo Skill Value con ExternalId X;
  • DmSkillValue_X_Y: L'utente deve possedere lo Skill Value con ExternalId X per l'Area con ExternalId Y;

È possibile indicare più di una regola, separandole con il carattere ",".
In questo caso la voce di menu sarà visibile se l'utente rispetta una qualsiasi delle regole indicate.
Ad esempio, per includere il Gruppo Amministrazione e il Business Role Responsabile HR:
DmGroup_Amministrazione,DmBusinessRole_ResponsabileHR

Size

String

Definisce la dimensione di questa voce di menu nel menu a tiles.

La stringa deve essere nel formato larghezzaxaltezza, ad esempio il valore 2x1 crea un tile largo due unità e alto una.

BackgroundColor

String

Stringa CSS. Definisce il colore di sfondo del tile.

ForegroundColor

String

Stringa CSS. Definisce il colore del testo nel tile.

ResetNavButtons

bool

Se true, allora questa zona del sito non eredita i NavButtons definiti nei menu superiori.

Expanded

bool

Se true, allora questa voce è espansa di default nel menu ad albero della sidebar.

Items

Array di oggetti

Lista dei sottomenu disponibili. Ogni oggetto ha lo stesso formato del campo "Menu".

NavButtons

Array di oggetti

Definisce dei bottoni aggiuntivi da visualizzare nella navbar quando si sta navigando in questo menu o in un suo sottomenu.

Name

String

Testo da visualizzare nel bottone.

Url

String

Url da aprire al click.

Icon

String

Icona da visualizzare sul bottone.

BackgroundColor

String

Stringa CSS del colore di sfondo da dare al bottone.

ForegroundColor

String

Stringa CSS del colore del testo nel bottone.

Role

String

Regole di visualizzazione per questo bottone.
Fare riferimento al parametro Role per conoscere la sintassi e le possibili regole.

Hide

bool

Se true, il bottone non viene visualizzato.