Adicionar conteúdo de ajuda personalizado

Artigo
07/06/2017

Publicado: novembro de 2016

Aplicável a: Dynamics CRM 2015

Com o Atualização do Microsoft Dynamics CRM 2015 e Microsoft Dynamics CRM Online 2015, os administradores podem configurar qual página de conteúdo de ajuda será exibida em toda organização ou para entidades específicas. As organizações com um sistema altamente personalizado, especialmente para aqueles que usam entidades personalizadas, acharão que o conteúdo de ajuda é de uso limitado. Os administradores podem configurar o sistema para substituir o conteúdo da ajuda padrão especificando uma URL para abrir. A página para abrir pode ser uma página estática no site do SharePoint, uma página da Web na Internet ou um aplicativo de ajuda personalizado criado com recursos da Web e incluído em uma solução.

Os desenvolvedores precisam compreender as informações disponíveis e quais informações contextuais podem ser transmitidas com a URL para que possam criar páginas para exibir o conteúdo adequado. É possível encontrar mais informações no tópico Personalizar o seu sistema do CRM: personalizar a experiência da ajuda.

Neste tópico

Opções de ajuda personalizadas

Parâmetros da cadeia de caracteres de consulta contextuais

Use os recursos da Web para fornecer conteúdo da ajuda

Opções de ajuda personalizadas

O comportamento de ajuda personalizado depende dos dados armazenados na entidade Organization e nas definições EntityMetadata para cada entidade como descrito na tabela a seguir.

Configuração do sistema ou entidade	Dados	Tipo	Descrição
Configuração de sistema: Use a ajuda personalizada para entidades personalizáveis	Organization.GlobalHelpUrlEnabled	Booliano	Indica se a ajuda personalizada está habilitada para a organização.
Configuração de sistema: URL de ajuda personalizada global	Organization.GlobalHelpUrl	Cadeia de caracteres	A URL de ajuda global para a organização.
Configuração de sistema: Parâmetros Acrescentar para a URL	Organization.GlobalAppendUrlParametersEnabled	Booliano	Indica se os parâmetros da cadeia de caracteres de consulta com informação de contexto são acrescentados na URL de ajuda.Para obter mais informações:Parâmetros da cadeia de caracteres de consulta contextuais
Configuração da entidade: Use a ajuda personalizada	EntityMetadata.EntityHelpUrlEnabled	Booliano	Indica se a ajuda personalizada está habilitada para a entidade.
Configuração da entidade: URL da ajuda	EntityMetadata.EntityHelpUrl	Cadeia de caracteres	A página de ajuda personalizada para exibir essa entidade.

A combinação desses configurações aplicadas controla qual tópico de ajuda será exibido. As opções são descritas na tabela a seguir.

Organization.GlobalHelpUrlEnabled	Organization.GlobalHelpUrl	EntityMetadata.EntityHelpUrlEnabled	EntityMetadata.EntityHelpUrl	Comportamento
false	N/D	N/D	N/D	Página de ajuda padrão abre
verdadeiro	Não	false	N/D	Página de ajuda padrão abre
verdadeiro	Não	verdadeiro	Não	Página de ajuda padrão abre
verdadeiro	Não	verdadeiro	Sim	Página de ajuda da entidade abre
verdadeiro	Sim	verdadeiro	Sim	Página de ajuda da entidade abre
verdadeiro	Sim	verdadeiro	Não	Página da URL global abre
verdadeiro	Sim	false	N/D	Página da URL global abre

Observação

Quando a ajuda global é habilitada, a página personalizada aparecerá sempre que o botão de ajuda no aplicativo for usado, incluindo páginas não relacionadas a qualquer área personalizável do aplicativo. Como isso oculta o conteúdo que pode ser valiosa para administradores, geralmente a ajuda personalizada deve ser aplicada com base na entidade.

Parâmetros da cadeia de caracteres de consulta contextuais

Quando o Organization.GlobalAppendUrlParametersEnabled é true, os seguintes valores de parâmetro da cadeia de caracteres de consulta podem ser acrescentados a URL de ajuda personalizada.

Parâmetro	Descrição
entrypoint	O tipo de página da ajuda foi aberta. Os valores possíveis são form e hierarchychart. Esse parâmetro não está incluído se a ajuda for aberta em uma exibição de lista.
formid	O valor GUID do formulário ou gráfico da hierarquia que a ajuda foi aberta.
typename	O nome lógico da entidade que o conteúdo de ajuda foi aberto.
userlcid	Identificador do código de idioma usado pelo usuário atual.Os valores de ID de localidade válidos podem ser encontrados em Gráfico de LCID (ID de localidade).

Acessando valores de cadeia de caracteres de consulta

O HTML a seguir mostra um exemplo de como acessar esses valores da cadeia de caracteres de consulta usando o JavaScript. Essa página exibirá uma tabela mostrando os valores desses parâmetros se forem transmitidos.

<!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 os recursos da Web para fornecer conteúdo da ajuda

Usar recursos da Web HTML como conteúdo de ajuda tem a vantagem de ser incluído em uma solução para todas as entidades personalizadas que descreverem. Também é possível usar o JavaScript nessas páginas para acessar os dados e metadados do Dynamics 365 para fornecer o conteúdo dinâmico que pode refletir os campos atuais em um formulário ou obter informações sobre os privilégios atribuídos ao usuário.

Os campos Organization.GlobalHelpUrl e EntityMetadata.EntityHelpUrl são valores de cadeia de caracteres simples sem formatação para exigir um protocolo válido. Isso permite o uso de descrições de caminho relativo para a URL representando um recurso da Web para que a referência do recurso da Web pode funcionar sem ser alterada quando uma solução é usada para mover o conteúdo de ajuda de uma organização para outra. Um recurso da Web específico pode ser referenciado usando uma URL relativa como:

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

Importante

Quando um usuário pertence a mais de uma organização em um servidor, esse caminho sempre se referirá à organização padrão do usuário. Se o usuário não estiver usando a organização padrão e o recurso da Web esperado não estiver incluído na organização padrão do usuário, um erro “Arquivo Não Encontrado” será exibido, mesmo que o recurso da Web ocorra na organização em que o usuário trabalha. Se um recurso da Web com o mesmo nome já existe na organização padrão, o recurso da Web da organização será exibido e a pode não estar correto para a organização atual.

Se isso causa problemas para os usuários da organização, os valores da URL para as configurações podem ser atualizadas para anexar a URL da organização base para a URL relativa do recurso Web na organização.

Confira Também

EntityMetadata
Personalizar o seu sistema do CRM: personalizar a experiência da ajuda
Guia de desenvolvedores para personalização do Microsoft Dynamics CRM 2015
Recursos da Web do Microsoft Dynamics CRM 2015
Recursos da Web de página da Web (HTML)

Compartilhar via

Adicionar conteúdo de ajuda personalizado

Neste tópico

Opções de ajuda personalizadas

Parâmetros da cadeia de caracteres de consulta contextuais

Acessando valores de cadeia de caracteres de consulta

Use os recursos da Web para fornecer conteúdo da ajuda

Confira Também

Recursos adicionais