Compartir a través de


Agregue el contenido personalizado de ayuda

 

Publicado: enero de 2017

Se aplica a: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Con Microsoft Dynamics 365 (en línea y local), los administradores pueden configurar qué página del contenido de la ayuda aparecerá en toda la organización o para entidades específicas. Las organizaciones que tienen un sistema muy personalizado, especialmente las que usan entidades personalizadas, encontrarán que el contenido de ayuda de la aplicación es de uso limitado. Los administradores pueden configurar el sistema para reemplazar el contenido predeterminado de ayuda especificando una URL para que se abra en su lugar. La página que se abrirá puede ser una página estática en un sitio de SharePoint, una página web de Internet, o una aplicación de ayuda personalizada creada con recursos web e incluida con una solución.

Los desarrolladores deben entender las opciones disponibles y qué información contextual se puede pasar con la URL para que puedan crear páginas para mostrar contenido adecuado. También puede encontrar más información en el tema Personalizar el sistema CRM: Personalización de la experiencia de la Ayuda.

En este tema

Opciones de ayuda personalizadas

Parámetros de cadena de consulta contextual

Use recursos web para ofrecer contenido de la ayuda

Opciones de ayuda personalizadas

El comportamiento de ayuda personalizada depende de los datos almacenados en la entidad de Organization y las definiciones de EntityMetadata para cada entidad como se describe en la siguiente tabla.

Valor del sistema o la entidad

Datos

Tipo

Descripción

Configuración del sistema: Use ayuda personalizada para entidades personalizables

Organization.GlobalHelpUrlEnabled

Booleano

Indica si hay ayuda personalizada habilitada para la organización.

Configuración del sistema: Dirección URL de Ayuda personalizada global

Organization.GlobalHelpUrl

Cadena

Dirección URL de la ayuda global de la organización.

Configuración del sistema: Anexar los parámetros a la URL

Organization.GlobalAppendUrlParametersEnabled

Booleano

Indica si los parámetros de cadena de consulta con la información de contexto se anexan a la ayuda URL.Más información:Parámetros de cadena de consulta contextual

Valor de entidad: Usar ayuda personalizada

EntityMetadata.EntityHelpUrlEnabled

Booleano

Indica si hay ayuda personalizada habilitada para la entidad.

Valor de entidad: URL de ayuda

EntityMetadata.EntityHelpUrl

Cadena

La página personalizada de ayuda que se mostrará para esta entidad.

Combinación de valores aplicados controla qué tema de ayuda se mostrará. Las opciones se describen en la tabla siguiente.

Organization.GlobalHelpUrlEnabled

Organization.GlobalHelpUrl

EntityMetadata.EntityHelpUrlEnabled

EntityMetadata.EntityHelpUrl

Comportamiento

false

N/A

N/A

N/A

Se abre la página de Ayuda predeterminada

verdadero

No

false

N/A

Se abre la página de Ayuda predeterminada

verdadero

No

verdadero

No

Se abre la página de Ayuda predeterminada

verdadero

No

verdadero

Se abre la página de Ayuda de la entidad

verdadero

verdadero

Se abre la página de Ayuda de la entidad

verdadero

verdadero

No

Se abre la página de la dirección URL global

verdadero

false

N/A

Se abre la página de la dirección URL global

Nota

Cuando se habilita la ayuda global, la página personalizada aparecerá siempre se use cualquier botón de ayuda en la aplicación, incluidas las páginas no relacionadas con ningún área personalizable de la aplicación. Puesto que esto oculta contenido que puede tener valor para los directores, la ayuda personalizada normalmente se debe a aplicar a cada entidad individualmente.

Parámetros de cadena de consulta contextual

Cuando Organization.GlobalAppendUrlParametersEnabled es true, los siguientes valores de parámetros de cadena de consulta se pueden anexar a la ayuda personalizada URL.

Parámetro

Descripción

entrypoint

El tipo de página desde la que se abrió la ayuda. Los valores posibles son form y hierarchychart. Este parámetro no se incluye si la ayuda se abre desde una vista de lista.

formid

El valor GUID del formulario o el gráfico de la jerarquía del que se abrió la ayuda.

typename

El nombre lógico de la entidad de la que se abrió el contenido de la ayuda.

userlcid

Identificador del código de idioma que usa el usuario actual.Los valores de identificadores de configuración regional válidos pueden encontrarse en la tabla de identificadores de configuración regional (LCID).

Acceso a valores de cadena de consulta

El siguiente HTML proporciona un ejemplo que muestra cómo tener acceso a estos valores de cadena de consulta con JavaScript. Esta página mostrará una tabla que muestra los valores de estos parámetros si se pasan.

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

Use recursos web para ofrecer contenido de la ayuda

El uso de recursos web HTML como contenido de la ayuda tiene la ventaja de que se puede incluir conjuntamente en una solución para las entidades personalizadas que describen. También es posible usar JavaScript en estas páginas para tener acceso a los datos y los metadatos de Dynamics 365 para proporcionar contenido dinámico que pueda reflejar los campos actuales en un formulario u obtener información acerca de los privilegios asignados al usuario.

Los campos Organization.GlobalHelpUrl y EntityMetadata.EntityHelpUrl son valores de cadena simples sin ningún formato requiera un protocolo válido. Esto permite el uso de descripciones de ruta relativa de la URL que representa un recurso web para que la referencia al recurso web pueda funcionar sin modificar cuando se usa una solución para mover el contenido de la ayuda de una organización a otra. Puede hacerse referencia a un recurso web específico mediante una URL relativa como ésta:

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

Importante

Cuando un usuario pertenece a más de una organización en un servidor, esta ruta se referirá siempre a la organización predeterminada. Si el usuario no está usando la organización predeterminada y el recurso web esperado no está incluido en la organización predeterminada del usuario, aparecerá el error "Archivo no encontrado" incluso si el recurso web aparece en la organización en la que está trabajando el usuario en ese momento. Si un recurso web con el mismo nombre existe en la organización predeterminada, se mostrará el recurso web de esa organización y puede no ser correcto para la organización actual.

Si esto ocasiona problemas a los usuarios de la organización, los valores de URL para la configuración pueden actualizarse para anexar la URL de la organización base a la URL relativa para el recurso web de la organización.

Ver también

EntityMetadata
Personalización del sistema CRM: Personalización de la experiencia de la Ayuda
Personalizar aplicaciones de Microsoft Dynamics 365
Recursos web para Microsoft Dynamics 365
Recursos web de página web (HTML)

Microsoft Dynamics 365

© 2017 Microsoft. Todos los derechos reservados. Copyright