Aangepaste Help-inhoud toevoegen

 

Gepubliceerd: november 2016

Is van toepassing op: Dynamics CRM 2015

Met Microsoft Dynamics CRM 2015 en Microsoft Dynamics CRM Online 2015 Update kunnen beheerders configureren welke Help-inhoudspagina in de hele organisatie of voor bepaalde entiteiten wordt weergegeven. Organisaties die een zeer aangepast systeem hebben, vooral organisaties die aangepaste entiteiten gebruiken, zullen constateren dat de Help-inhoud van toepassingen van beperkt nut is. Beheerders kunnen het systeem configureren om de inhoud van de standaard-Help te negeren door een URL op te geven die in plaats daarvan moet worden geopend. De pagina die moet worden geopend, kan een statische pagina op een SharePoint-site zijn, een webpagina op internet of een aangepaste Help-toepassing die is gemaakt met webresources en bij een oplossing is geleverd.

Ontwikkelaars moeten de beschikbare opties begrijpen en de contextuele informatie die kan worden doorgegeven met de URL, zodat ze pagina's kunnen maken met de juiste inhoud. U vindt meer informatie in het volgende onderwerp Uw CRM-systeem aanpassen: De Helpervaring aanpassen.

In dit onderwerp

Opties van aangepaste Help

Contextuele querytekenreeksparameters

Webresources gebruiken om Help-inhoud weer te geven

Opties van aangepaste Help

Het gedrag van aangepaste Help hangt af van gegevens die zijn opgeslagen in de entiteit Organization en de EntityMetadata-definities voor elke entiteit, zoals beschreven in de volgende tabel.

Systeem- of entiteitinstelling	Gegevens	Type	Beschrijving
Systeeminstelling: Aangepaste Help gebruiken voor aanpasbare entiteiten	Organization.GlobalHelpUrlEnabled	Boole-waarde	Geeft aan of aangepaste Help is ingeschakeld voor de organisatie.
Systeeminstelling: URL van aangepaste Help	Organization.GlobalHelpUrl	Tekenreeks	De globale Help-URL voor de organisatie.
Systeeminstelling: Parameters toevoegen aan URL	Organization.GlobalAppendUrlParametersEnabled	Boole-waarde	Geeft aan of querytekenreeksparameters met contextinformatie worden toegevoegd aan de Help-URL.Meer informatie:Contextuele querytekenreeksparameters
Entiteitinstelling: Aangepaste Help gebruiken	EntityMetadata.EntityHelpUrlEnabled	Boole-waarde	Geeft aan of aangepaste Help is ingeschakeld voor de entiteit.
Entiteitinstelling: Help-URL	EntityMetadata.EntityHelpUrl	Tekenreeks	De aangepaste Help-pagina die wordt weergegeven voor deze entiteit.

De toegepaste combinatie van instellingen bepaalt welk Help-onderwerp wordt weergegeven. De opties worden in de volgende tabel beschreven.

Organization.GlobalHelpUrlEnabled	Organization.GlobalHelpUrl	EntityMetadata.EntityHelpUrlEnabled	EntityMetadata.EntityHelpUrl	Gedrag
false	n.v.t.	n.v.t.	n.v.t.	Standaard-Help-pagina wordt geopend
true	Nee	false	n.v.t.	Standaard-Help-pagina wordt geopend
true	Nee	true	Nee	Standaard-Help-pagina wordt geopend
true	Nee	true	Ja	Entiteit-Help-pagina wordt geopend
true	Ja	true	Ja	Entiteit-Help-pagina wordt geopend
true	Ja	true	Nee	Algemene URL-pagina wordt geopend
true	Ja	false	n.v.t.	Algemene URL-pagina wordt geopend

Notitie

Als de algemene Help is ingeschakeld, wordt de aangepaste pagina weergegeven wanneer een Help-knop in de toepassing wordt gebruikt, inclusief pagina's die niet gerelateerd zijn aan een aanpasbaar gebied van de toepassing. Omdat hierdoor inhoud wordt verborgen die voor beheerders van belang kan zijn, moet aangepaste Help meestal worden toegepast per entiteit.

Contextuele querytekenreeksparameters

Wanneer Organization.GlobalAppendUrlParametersEnabledtrue is, kunnen de volgende querytekenreeksparameters worden toegevoegd aan de aangepaste Help URL.

Parameter	Beschrijving
entrypoint	Het type pagina waar vandaan de Help is geopend. De mogelijke waarden zijn form en hierarchychart. Deze parameter wordt niet opgenomen als de Help wordt geopend vanuit een lijstweergave.
formid	De GUID-waarde voor het formulier of de hiërarchie van waaruit de Help is geopend.
typename	De logische naam van de entiteit van waaruit de Help-inhoud is geopend.
userlcid	Taalcode-id die de huidige gebruiker gebruikt.U vindt de geldige lokale id-waarden in het Diagram van LCID (id van landinstelling).

Toegang tot querytekenreekswaarden

De volgende HTML toont een voorbeeld van hoe toegang tot deze querytekenreekswaarden kan worden gekregen met JavaScript. Deze pagina geeft een tabel weer met de waarden voor deze parameters als ze worden doorgegeven.

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

Webresources gebruiken om Help-inhoud weer te geven

HTML-webresources gebruiken als Help-inhoud heeft het voordeel dat ze samen kunnen worden opgenomen in een oplossing voor aangepaste entiteiten die ze beschrijven. Het is ook mogelijk om JavaScript in deze pagina's te gebruiken om toegang tot Dynamics 365-gegevens en -metagegevens te krijgen om dynamische inhoud te bieden die de huidige velden in een formulier kan reflecteren of om informatie te krijgen over de bevoegdheden die aan de gebruiker zijn toegewezen.

De velden Organization.GlobalHelpUrl en EntityMetadata.EntityHelpUrl zijn eenvoudige tekenreekswaarden zonder opmaak om een geldig protocol te vereisen. Hierdoor kunnen relatieve padbeschrijvingen worden gebruikt naar de URL die een webresource vertegenwoordigt, zodat de verwijzing naar de webresource zonder te worden gewijzigd kan werken wanneer een oplossing wordt gebruikt om de Help-inhoud te verplaatsen van de ene organisatie naar de andere. Naar een specifieke webresource kan worden verwezen met behulp van een relatieve URL, bijvoorbeeld zo:

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

Belangrijk

Als een gebruiker bij meerdere organisaties op een server hoort, zal dit pad altijd verwijzen naar standaardorganisatie van de gebruiker. Als de gebruiker de standaardorganisatie niet gebruikt en de verwachte webresource niet is opgenomen in de standaardorganisatie van de gebruiker, treedt een "bestand niet gevonden" fout op, hoewel de webresource wel voorkomt in de organisatie waar de gebruiker momenteel in werkt. Als een webresource met dezelfde naam in de standaardorganisatie bestaat, wordt de webresource voor die organisatie weergegeven; dit is mogelijk niet correct voor de huidige organisatie.

Als dit problemen veroorzaakt voor gebruikers in de organisatie, kunnen de URL-waarden voor de instellingen worden bijgewerkt om de URL van de basisorganisatie toe te voegen vóór de relatieve URL voor de webresource in de organisatie.

Zie ook

EntityMetadata
Uw CRM-systeem aanpassen: De Helpervaring aanpassen
Ontwikkelaarshandleiding over aanpassing voor Microsoft Dynamics CRM 2015
Webresources voor Microsoft Dynamics CRM 2015
Webpagina (HTML) webresources

© 2017 Microsoft. Alle rechten voorbehouden. Auteursrecht