Hinzufügen von benutzerdefiniertem Hilfeinhalt

 

Veröffentlicht: Januar 2017

Gilt für: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Mit Microsoft Dynamics 365 (online und lokal) können Administratoren konfigurieren, welche Hilfeinhaltsseite in der gesamten Organisation oder für bestimmte Entitäten angezeigt wird. Organisationen, die über ein hochgradig benutzerdefiniertes System verfügen, insbesondere solche, die benutzerdefinierte Entitäten verwenden, werden feststellen, dass die Anwendungshilfeinhalte von begrenztem Nutzen sind. Administratoren können das System so konfigurieren, dass es den Standard Hilfeinhalt überschreibt, indem Sie stattdessen eine URL zum Öffnen angeben. Die zu öffnenden Seite ist möglicherweise eine statische Seite auf einer SharePoint-Website, eine Webseite im Internet oder eine benutzerdefinierte Hilfeanwendung, die mithilfe von Webressourcen erstellt und in einer Lösung enthalten ist.

Entwickler müssen die verfügbaren Optionen kennen und welche kontextbezogenen Informationen mit URL übergeben werden können, damit sie diese Seiten so erstellen können, dass die Inhalte entsprechend angezeigt werden. Sie können auch weitere Informationen finden im Thema Anpassen des CRM-Systems: Anpassen der Hilfeerfahrung.

In diesem Thema

Benutzerdefinierte Hilfeoptionen

Kontextbezogene Abfragezeichenfolgenparameter

Verwendung von Webressourcen, um Hilfeinhalte bereitzustellen

Benutzerdefinierte Hilfeoptionen

Benutzerdefiniertes Hilfeverhalten hängt von der Datenmenge ab, die in der Organization-Entität und den EntityMetadata-Defintionen für die einzelnen Entitäten gespeichert sind, wie in dder folgenden Tabelle zu finden.

System- oder Entitätseinstellung	Daten	Typ	Beschreibung
Systemeinstellung: Benutzerdefinierte Hilfe für anpassbare Entitäten verwenden	Organization.GlobalHelpUrlEnabled	Boolescher Wert	Gibt an, ob die anpassbare Hilfe für die Organisation aktiviert ist.
Systemeinstellung: Globale benutzerdefinierte Hilfe	Organization.GlobalHelpUrl	Zeichenfolge	Die URL für die globale Hilfe für die Organisation.
Systemeinstellung: Parameter an URL anfügen	Organization.GlobalAppendUrlParametersEnabled	Boolescher Wert	Gibt an, ob Abfragezeichenfolgenparameter mit Kontextinformationen an die Hilfe-URL angefügt werden.Weitere Informationen:Kontextbezogene Abfragezeichenfolgenparameter
Entitäts-Einstellung: Verwenden der benutzerdefinierten Hilfe	EntityMetadata.EntityHelpUrlEnabled	Boolescher Wert	Gibt an, ob die benutzerdefinierte Hilfe für die Entität aktiviert ist.
Entitäts-Einstellung: Hilfe-URL	EntityMetadata.EntityHelpUrl	Zeichenfolge	Die benutzerdefinierte Hilfeseite, die für diese Entität angezeigt wird.

Die Kombination der für übernommenen Einstellungen steuer, welches Hilfethema angezeigt wird. Die Optionen sind in der folgenden Tabelle beschrieben.

Organization.GlobalHelpUrlEnabled	Organization.GlobalHelpUrl	EntityMetadata.EntityHelpUrlEnabled	EntityMetadata.EntityHelpUrl	Verhalten
false	Nicht zutreffend	Nicht zutreffend	Nicht zutreffend	Standard-Hilfeseite wird geöffnet
true	Nein	false	Nicht zutreffend	Standard-Hilfeseite wird geöffnet
true	Nein	true	Nein	Standard-Hilfeseite wird geöffnet
true	Nein	true	Ja	Entitäts-Hilfeseite wird geöffnet
true	Ja	true	Ja	Entitäts-Hilfeseite wird geöffnet
true	Ja	true	Nein	Globale URL-Seite wird geöffnet
true	Ja	false	Nicht zutreffend	Globale URL-Seite wird geöffnet

Hinweis

Wenn globale Hilfe aktiviert ist, wird die benutzerdefinierte Seite angezeigt, wenn eine Hilfe-Schaltfläche in der Anwendung verwendet wird, einschließlich der Seiten, die mit keinem anpassbaren Bereich der Anwendung in Verbindung stehen. Da es ggf. Inhalte ausgeblendet, die für Administratoren nützlich sein könnten, solte im Allgemeinen benutzerdefinierte Hilfe auf Pro-Entitätsgrundlage angewendet werden.

Kontextbezogene Abfragezeichenfolgenparameter

Wenn Organization.GlobalAppendUrlParametersEnabledtrue ist, werden die folgenden Abfragezeichenfolgenparameterwerte an die benutzerdefinierten Hilfe URL angefügt.

Parameter	Beschreibung
entrypoint	Der Typ der Seite, von der aus die Hilfe geöffnet wurde. Mögliche Werte lauten form und hierarchychart. Dieser Parameter ist nicht vorhanden, wenn die Hilfe aus einer Listenansicht geöffnet wird.
formid	Der GUID-Wert für das Formular oder das Hierarchiendiagramm, aus dem die Hilfe geöffnet wurde.
typename	Der logische Name der Entität, aus der die Hilfe geöffnet wurde .
userlcid	Die Sprachcode-ID, die vom aktuellen Benutzer verwendet wird.Gültige Gebietsschema-ID-Werte finden Sie unter Gebietsschema-ID-Diagramm (LCID).

Zugreifen auf Abfragezeichenfolgenwerte

Das folgende HTML bietet ein Beispiel, wie Sie auf diese Abfragezeichenfolgenwerte mit JavaScript zugreifen können. Auf dieser Seite wird eine Tabelle angezeigt, die die Werte für diese Parameter anzeigt, wenn sie übergeben werden.

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

Verwendung von Webressourcen, um Hilfeinhalte bereitzustellen

Das Verwenden von HTML-Webressourcen als Hilfeinhalt hat den Vorteil, dass sie in einer Lösung für alle benutzerdefinierten Entitäten zusammen eingeschlossen werden können, die sie beschreiben. Es ist auch möglich, JavaScript in diesen Seiten zu verwenden, um auf Dynamics 365-Metadaten und Daten zuzugreifen, um dynamische Inhalte bereitzustellen, die die aktuellen Felder in einem Formular wiedergeben, oder um Informationen zu den Berechtigungen abzurufen, die dem Benutzer zugewiesen sind.

Die Organization.GlobalHelpUrl und EntityMetadata.EntityHelpUrl-Felder sind einfache Zeichenfolgenwerte ohne Formatierungen, die eines gültiges Protokoll erfordern. Dadurch können relative Pfadbeschreibungen zur URL verwendet werden, die eine Webressource darstellen, sodass die Referenz zur Webressource funktionieren kann, ohne geändert werden zu müssen, wenn eine Lösung verwendet wird, um den Hilfeinhalt von einer Organisation zu einer anderen zu verschieben. Auf eine bestimmte Webressource kann mithilfe eines verwandten URL so verwiesen werden:

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

Wichtig

Wenn ein Benutzer mehr als einer Organisation auf einem Server angehört, wird dieser Pfad immer auf die Standardorganisation des Benutzers verweisen. Wenn der Benutzer die standardmäßige Organisation nicht verwendet und die erwartete Webressource nicht in der Standardorganisation des Benutzers enthalten ist, tritt ein "File not Found"-Fehler auf, selbst wenn die Webressource in der Organisation enthalten ist, in welcher der Benutzer derzeit arbeitet. Wenn eine Webressource mit demselben Namen in der Standardorganisation vorhanden ist, wird die Webressource für diese Organisation angezeigt wird und ist für die aktuelle Organisation möglicherweise nicht korrekt.

Wenn dies Probleme für Benutzer in der Organisation hervorruft, können die URL-Werte für die Einstellungen aktualisiert werden, um die Basisorganisation-URL zu verwandten URL für die Webressource in der Organisation voranzustellen.

Siehe auch

EntityMetadata
Anpassen des CRM-Systems: Anpassen der Hilfe
Anpassen der Microsoft Dynamics 365-Anwendungen
Webressourcen für Microsoft Dynamics 365
Webressourcen der Webseite (HTML)

Microsoft Dynamics 365

© 2017 Microsoft. Alle Rechte vorbehalten. Copyright