Aggiungere il contenuto personalizzato della guida

Articolo
07/06/2017

Data di pubblicazione: novembre 2016

Si applica a: Dynamics CRM 2015

Con Aggiornamento di Microsoft Dynamics CRM 2015 e Microsoft Dynamics CRM Online 2015, gli amministratori possono configurare la pagina del contenuto della guida che verrà visualizzata nell'intera organizzazione o per entità specifiche. Le organizzazioni che hanno un sistema ampiamente personalizzato, soprattutto quelle che utilizzano le entità personalizzate troveranno che il contenuto della guida dell'applicazione ha un utilizzo limitato. Gli amministratori possono tuttavia configurare il sistema per sostituire il contenuto della guida predefinito specificando un URL per aprirlo. La pagina da aprire potrebbe essere una pagina statica in un sito di SharePoint, una pagina Web su Internet oppure un'applicazione della guida personalizzata creata utilizzando le risorse Web e con una soluzione inclusa.

Gli sviluppatori devono comprendere le opzioni disponibili e le informazioni di contesto che possono essere passate con l'URL in modo da poterle creare le pagine per visualizzare il contenuto appropriato. È inoltre possibile trovare ulteriori informazioni nell'argomento Personalizzare il sistema CRM: Personalizzare l'esperienza della guida.

In questo argomento

Opzioni della guida personalizzata

Parametri stringa di query contestuale

Utilizzare le risorse Web per fornire il contenuto della guida

Opzioni della guida personalizzata

Il comportamento della guida personalizzata dipende dai dati archiviati nell'entità Organization e nelle definizioni EntityMetadata per ogni entità come descritto nella seguente tabella.

Impostazioni di sistema o di entità	Dati	Tipo	Descrizione
Impostazioni di sistema: Utilizzare la Guida personalizzata per le entità personalizzabili	Organization.GlobalHelpUrlEnabled	Booleano	Indica se la Guida personalizzata è abilitata per l'organizzazione.
Impostazioni di sistema: URL della guida personalizzata globale	Organization.GlobalHelpUrl	Stringa	L'URL della Guida globale per l'organizzazione.
Impostazioni di sistema: Aggiungi parametri all'URL	Organization.GlobalAppendUrlParametersEnabled	Booleano	Indica se i parametri stringa di query con le informazioni sul contesto vengono aggiunti all'URL della guida.Ulteriori informazioni:Parametri stringa di query contestuale
Impostazioni entità: Utilizzare la guida personalizzata	EntityMetadata.EntityHelpUrlEnabled	Booleano	Indica se la Guida personalizzata è abilitata per l'entità.
Impostazioni entità: URL entità	EntityMetadata.EntityHelpUrl	Stringa	La pagina Guida personalizzata da visualizzare per queste entità.

La combinazione di impostazioni applicate controlla l'argomento della guida che verrà visualizzato. Le opzioni sono descritte nella tabella seguente.

Organization.GlobalHelpUrlEnabled	Organization.GlobalHelpUrl	EntityMetadata.EntityHelpUrlEnabled	EntityMetadata.EntityHelpUrl	Comportamento
false	N/D	N/D	N/D	Verrà aperta la pagina Guida personalizzata
true	No	false	N/D	Verrà aperta la pagina Guida personalizzata
true	No	true	No	Verrà aperta la pagina Guida personalizzata
true	No	true	Sì	Verrà aperta la pagina Guida entità
true	Sì	true	Sì	Verrà aperta la pagina Guida entità
true	Sì	true	No	Verrà aperta la pagina URL globale
true	Sì	false	N/D	Verrà aperta la pagina URL globale

Nota

Quando viene abilitata la guida globale, verrà visualizzata la pagina personalizzata quando viene utilizzato il pulsante della guida nell'applicazione, incluse le pagine non correlate alle aree personalizzabili dell'applicazione. Poiché ciò nasconde il contenuto che potrebbe essere utile agli amministratori, in genere è necessario applicare la guida personalizzata in base all'entità.

Parametri stringa di query contestuale

Quando Organization.GlobalAppendUrlParametersEnabled è true, è possibile aggiungere i seguenti valori del parametro della stringa di query all'URL della guida personalizzata.

Parametro	Descrizione
entrypoint	Il tipo di pagina da cui è stata aperta la guida. I valori possibili sono form e hierarchychart. Questo parametro non è incluso se la guida viene aperta da una visualizzazione elenco.
formid	Il valore della GUID per il modulo o il grafico di gerarchie da cui è stata aperta la guida.
typename	Il nome logico dell'entità da cui è stato aperto il contenuto della guida.
userlcid	Identificatore del codice della lingua utilizzato dall'utente corrente.Valori LCID (ID impostazioni locali) validi sono disponibili alla pagina Grafico LCID (impostazioni ID locali).

Accesso ai valori della stringa di query

In HTML viene fornito un esempio in cui viene illustrato come accedere ai valori della stringa di query utilizzando JavaScript. In questa pagina verrà visualizzata una tabella in cui vengono riportati i valori per questi parametri se vengono passati.

<!DOCTYPE html>
<html>
<head>
 <title>Help topic</title>
 <style>
  body {
   font-family: 'Segoe UI';
  }
 </style>
 <script type="text/javascript">
  function getQueryStringParameter(parameter) {
   /// <summary>Parses query string values passed to the page and returns the value for the requested parameter or 'null'</summary>
   /// <param name="parameter" type="String">The parameter value to look for</param>
   /// <returns type="String" />
   var query = window.location.search.substring(1); 
   var params = query.split("&");
   for (var i = 0; i < params.length; i++) {
    var pair = params[i].split("=");
    if (pair[0] == parameter) {
     return pair[1];
    }
   }
   return "null";
  }


  document.onreadystatechange = function () {
   if (document.readyState == "complete") {

    var entrypointValue = getQueryStringParameter("entrypoint");
    var formidValue = getQueryStringParameter("formid");
    var typenameValue = getQueryStringParameter("typename");
    var userlcidValue = getQueryStringParameter("userlcid");

    if ((document.documentMode) && (document.documentMode <= 8))
    {
     //If page is being displayed in IE Compatibility mode
     document.getElementById("entrypointValue").innerText = entrypointValue;
     document.getElementById("formidValue").innerText = formidValue;
     document.getElementById("typenameValue").innerText = typenameValue;
     document.getElementById("userlcidValue").innerText = userlcidValue;
    }
    else
    {
     document.getElementById("entrypointValue").textContent = entrypointValue;
     document.getElementById("formidValue").textContent = formidValue;
     document.getElementById("typenameValue").textContent = typenameValue;
     document.getElementById("userlcidValue").textContent = userlcidValue;
    }


   }
  }

 </script>
</head>
<body>
 <p>This is a custom help topic that can accept query string parameters</p>
 <table>
  <thead><tr><th>Parameter</th><th>Value</th></tr></thead>
  <tbody>
   <tr><td>entrypoint</td><td id="entrypointValue">null</td></tr>
   <tr><td>formid</td><td id="formidValue">null</td></tr>
   <tr><td>typename</td><td id="typenameValue">null</td></tr>
   <tr><td>userlcid</td><td id="userlcidValue">null</td></tr>
  </tbody>
 </table>


</body>
</html>

Utilizzare le risorse Web per fornire il contenuto della guida

L'utilizzo delle risorse Web HTML come contenuto della guida ha il vantaggio di poter essere incluso insieme in una soluzione per le entità personalizzate descritte. È inoltre possibile utilizzare JavaScript in tali pagine per accedere ai dati e ai metadati di Dynamics 365 per fornire il contenuto dinamico che potrebbe riflettere i campi correnti in un modulo o per ottenere informazioni sui privilegi assegnati all'utente.

I campi Organization.GlobalHelpUrl e EntityMetadata.EntityHelpUrl sono semplici valori di stringa senza alcuna formattazione che richieda un protocollo valido. Ciò consente l'utilizzo di descrizioni di percorso relative nell'URL che rappresenta una risorsa Web in modo che il riferimento alla risorse Web possa funzionare senza essere modificata quando una soluzione viene utilizzata per spostare il contenuto della guida da un'organizzazione a un'altra. È possibile fare riferimento a una risorsa Web specifica utilizzando un URL relativo come questo:

/WebResources/new_/help/content/account.htm

Importante

Quando un utente appartiene a più di un'organizzazione in un server, il percorso si riferirà sempre all'organizzazione predefinita degli utenti. Se l'utente non utilizza l'organizzazione predefinita e la risorsa Web prevista non viene inclusa nell'organizzazione predefinita dell'utente, si verifica un errore "File non trovato" anche se la risorsa Web si verifica nell'organizzazione in cui l'utente sta attualmente lavorando. Se una risorsa Web con lo stesso nome è presente nell'organizzazione predefinita, la risorsa Web per tale organizzazione verrà visualizzata e potrebbe non essere corretta per l'organizzazione corrente.

Se ciò provoca problemi agli utenti nell'organizzazione, i valori dell'URL per le impostazioni possono essere aggiornati per anteporre l'URL dell'organizzazione di base all'URL relativo per la risorsa Web nell'organizzazione.

Vedere anche

EntityMetadata
Personalizzare il sistema CRM: Personalizzare l'esperienza della guida
Guida per sviluppatori sulla personalizzazione per Microsoft Dynamics CRM 2015
Risorse Web per Microsoft Dynamics CRM 2015
Risorse Web pagine Web (HTML)

Condividi tramite

Aggiungere il contenuto personalizzato della guida

In questo argomento

Opzioni della guida personalizzata

Parametri stringa di query contestuale

Accesso ai valori della stringa di query

Utilizzare le risorse Web per fornire il contenuto della guida

Vedere anche

Risorse aggiuntive