Ajouter un contenu d'aide personnalisé

Article
07/06/2017

Date de publication : novembre 2016

S’applique à : Dynamics CRM 2015

Avec Mise à jour de Microsoft Dynamics CRM 2015 et de Microsoft Dynamics CRM Online 2015, les administrateurs peuvent configurer quelles pages de contenu de l'aide apparaissent dans toute l'organisation ou pour certaines entités. Les organisations qui ont un système hautement personnalisé, notamment celles qui utilisent les entités personnalisées, constateront que le contenu d'aide de l'application peut ne pas correspondre aux besoins de leurs utilisateurs. Les administrateurs peuvent configurer le système pour remplacer le contenu d'aide par défaut en spécifiant une URL à ouvrir à la place. La page à ouvrir peut être une page statique sur un site SharePoint, une page Web sur Internet ou une application d'aide personnalisée créée à l'aide des ressources Web et intégrée à une solution.

Les développeurs doivent maîtriser les options disponibles et savoir quelles informations contextuelles peuvent être transmises avec l'URL afin de pouvoir créer des pages et afficher le contenu approprié. Vous pouvez également obtenir des informations supplémentaires dans la rubrique Personnalisation de votre système CRM : Personnalisation de l'expérience de l'aide.

Contenu de la rubrique

Options d'aide personnalisées

Paramètres de chaîne de requête contextuelle

Utilisation des ressources Web pour fournir le contenu de l'aide

Options d'aide personnalisées

Le comportement de l'aide personnalisée dépend des données stockées dans l'entité Organization et des définitions de EntityMetadata pour chaque entité, comme le décrit le tableau suivant.

Paramètre système ou d'entité	Données	Type	Description
Paramètre système : Utilisation de l'aide personnalisée pour les entités personnalisables	Organization.GlobalHelpUrlEnabled	Booléen	Indique si l'aide personnalisée est activée pour l'organisation.
Paramètre système : URL d'aide personnalisée globale	Organization.GlobalHelpUrl	Chaîne	URL pour l'aide globale de l'organisation.
Paramètre système : Ajout de paramètres à l'URL	Organization.GlobalAppendUrlParametersEnabled	Booléen	Indique si les paramètres de chaîne de requête avec les informations de contexte sont ajoutés à l'URL de l'aide.Pour plus d'informations :Paramètres de chaîne de requête contextuelle
Paramètre d'entité : Utilisation de l'aide personnalisée	EntityMetadata.EntityHelpUrlEnabled	Booléen	Indique si l'aide personnalisée est activée pour l'entité.
Paramètre d'entité : URL d'aide	EntityMetadata.EntityHelpUrl	Chaîne	Page d'aide personnalisée à afficher pour cette entité.

La combinaison de paramètres appliqués contrôle quelle rubrique d'aide s'affiche. Les options sont décrites dans le tableau suivant.

Organization.GlobalHelpUrlEnabled	Organization.GlobalHelpUrl	EntityMetadata.EntityHelpUrlEnabled	EntityMetadata.EntityHelpUrl	Comportement
false	N/D	N/D	N/D	La page d'aide par défaut s'ouvre
vrai	Non	false	N/D	La page d'aide par défaut s'ouvre
vrai	Non	vrai	Non	La page d'aide par défaut s'ouvre
vrai	Non	vrai	Oui	La page d'aide d'entité s'ouvre
vrai	Oui	vrai	Oui	La page d'aide d'entité s'ouvre
vrai	Oui	vrai	Non	La page d'URL globale s'ouvre
vrai	Oui	false	N/D	La page d'URL globale s'ouvre

Notes

Lorsque l'aide globale est activée, la page personnalisée s'affiche lorsque n'importe quel bouton d'aide de l'application est utilisé, y compris les pages qui ne sont pas associées à une zone personnalisable de l'application. Du fait que cette opération masque le contenu susceptible d'être utile aux administrateurs, l'aide personnalisée doit généralement être appliquée entité par entité.

Paramètres de chaîne de requête contextuelle

Lorsque Organization.GlobalAppendUrlParametersEnabled est true, les valeurs suivantes de paramètre de chaîne de requête peuvent être ajoutées à l'URL d'aide personnalisée.

Paramètre	Description
entrypoint	Type de page à partir duquel l'aide a été ouverte. Les valeurs possibles sont form et hierarchychart. Ce paramètre n'est pas inclus si l'aide est ouverte à partir d'une vue sous forme de liste.
formid	Valeur GUID du graphique de formulaire ou de hiérarchie à partir duquel l'aide a été ouverte.
typename	Nom logique de l'entité à partir de laquelle le contenu de l'aide a été ouvert.
userlcid	Identificateur du code langue utilisé par l’utilisateur actuel.Les valeurs d'ID de paramètres régionaux valides sont disponibles sur la page Tableau des ID de paramètres régionaux (LCID).

Accès aux valeurs de chaîne de requête

Le fichier HTML suivant fournit un exemple illustrant sur la manière d'accéder à ces valeurs de chaîne de requête avec JavaScript. Cette page affiche un tableau indiquant les valeurs de ces paramètres si elles sont transmises.

<!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>

Utilisation des ressources Web pour fournir le contenu de l'aide

L'utilisation des ressources Web HTML comme contenu de l'aide a pour avantage que celles-ci peuvent être incluses dans une solution pour toutes les entités personnalisées qu'elles décrivent. Il est également possible d'utiliser JavaScript dans ces pages pour accéder aux données et aux métadonnées de Dynamics 365 afin de fournir le contenu dynamique susceptible de refléter les champs existants dans un formulaire ou obtenir des informations sur les privilèges attribués à l'utilisateur.

Les champs Organization.GlobalHelpUrl et EntityMetadata.EntityHelpUrl sont des valeurs de chaîne simples sans qu'aucune mise en forme nécessite un protocole valide. Cela permet d'utiliser des descriptions de chemin d'accès relatif dans l'URL représentant une ressource Web de sorte que la référence à la ressource Web puisse fonctionner sans être modifiée lorsqu'une solution est utilisée pour déplacer le contenu de l'aide d'une organisation à l'autre. Une ressource Web spécifique peut être référencée avec une URL relative comme suit :

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

Important

Lorsqu’un utilisateur appartient à plusieurs organisations sur un serveur, ce chemin d’accès fera toujours référence à l’organisation par défaut de l’utilisateur. Si l’utilisateur n’utilise pas l'organisation par défaut et que la ressource Web attendue ne fait pas partie de l’organisation par défaut de l’utilisateur, une erreur « Fichier introuvable » se produit, même si la ressource Web fait partie de l’organisation dans laquelle l’utilisateur travaille actuellement. Si une ressource Web portant le même nom existe dans l'organisation par défaut, la ressource Web pour cette organisation apparaît et peut ne pas être adaptée à l'organisation actuelle.

Si cela cause des problèmes pour les utilisateurs de l'organisation, les valeurs de l'URL concernant les paramètres peuvent être mises à jour afin d'ajouter l'URL de l'organisation de base au début de l'URL relative de la ressource Web dans l'organisation.

Voir aussi

EntityMetadata
Personnalisation de votre système CRM : Personnalisation de l'expérience de l'aide
Guide destiné aux développeurs chargés de la personnalisation de Microsoft Dynamics CRM 2015
Ressources Web pour Microsoft Dynamics CRM 2015
Ressources Web Webpage (HTML)

Partager via

Ajouter un contenu d'aide personnalisé

Contenu de la rubrique

Options d'aide personnalisées

Paramètres de chaîne de requête contextuelle

Accès aux valeurs de chaîne de requête

Utilisation des ressources Web pour fournir le contenu de l'aide

Voir aussi

Ressources supplémentaires