Adicionar conteúdo Ajuda integrada personalizado

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 3 min. de leitura
  • Você pode criar um novo tópico de ajuda integrada personalizado, por exemplo, se tiver uma aplicação personalizada e quiser fornecer ajuda aos usuários.

    Antes de Iniciar

    Função necessária: opened_help_admin ou admin

    Por Que e Quando Desempenhar Esta Tarefa

    Ao escrever conteúdo para os usuários, considere as seguintes limitações.
    • Não é possível incluir imagens no conteúdo de ajuda incorporado.
    • Para incorporar vídeo, você deve codificar as informações do vídeo na exibição do código de origem <<>>. O conteúdo de vídeo do YouTube e do Vimeo são compatíveis.
    • Para adicionar um link de informações relacionadas, você deve usar uma URL completa, não uma URL relativa.
    • A prática recomendada é não usar a ferramenta realçar texto, pois a cor pode tornar o texto ilegível, dependendo do tema que o usuário selecionou.
    • Todas as mudanças feitas na ajuda integrada não são implantadas automaticamente em outra instância.
    • As mudanças na tabela de ajuda integrada não são capturadas em conjuntos de atualizações, update_sync=false é definido intencionalmente.
    Nota:
    Os registros de ajuda integrada também são usados para criar conteúdo para o Central de ajuda em um espaço configurável. Para obter mais informações, consulte Criar conteúdo Central de ajuda para espaços configuráveis.

    Procedimento

    1. Navegar até Tudo > Ajuda integrada > Conteúdo da Ajuda.
    2. Clique em Nova.
    3. Preencha o formulário.
      Campo Descrição
      Nome Insira o nome do tópico de ajuda integrada. Um nome típico é o título da página à qual ele se aplica.
      Página Insira a página de IU para a qual este conteúdo fornece ajuda, sem a extensão de arquivo .do.

      Nome da página na URL

      Nota:
      Se você estiver usando o registro de ajuda integrada para exibir no Central de ajuda, conforme descrito em Criar conteúdo Central de ajuda para espaços configuráveis, insira o mesmo valor nos campos Nome e Página, substituindo os espaços por sublinhados no campo Página.
      Modificador Selecione o modificador, normalmente Normal.
      • O conteúdonormal aparece para qualquer usuário com a função apropriada que navegue até a página.
      • O conteúdode configuração aparece quando a página é acessada a partir de um link na Configuração assistida.
      Função Selecione a função para a qual o tópico foi escrito.

      Todas as funções que contêm a função também veem o conteúdo, a menos que outro tópico direcionado à função exista na mesma página. Para obter mais informações, consulte Ajuda integrada funções

      Ativo Marque a caixa de seleção para fazer este conteúdo aparecer. Desmarque a caixa de seleção para impedir que o conteúdo fique disponível, por exemplo, para que alguém o revise antes que ele seja acessado na página de IU.
      Produto Enterprise é o padrão e não deve ser alterado.
      Qualificador O qualificador que fornece ajuda integrada personalizada para uma página de IU comum.

      Por exemplo, a página home.do é aberta para cada módulo de página inicial e para muitos módulos de painel. Crie o qualificador antes de inseri-lo neste registro de ajuda integrada.

      Nota:
      Os IDs dinâmicos são compatíveis com os parâmetros de rota do Qualificador da Ajuda integrada. Por exemplo, adicionar $dynamic_value$ no campo de fragmento disponibiliza seu conteúdo para o mesmo URL, mesmo quando o valor muda. Isso pode acontecer ao selecionar diferentes idiomas para a mesma página.
      Versão Selecione uma versão, se for diferente da versão atual da sua instância. Para fornecer conteúdo para uma aplicação personalizada ou informações relevantes ao processo de negócios da sua organização, selecione Todos.
      Ordem Altere a função padrão, se necessário. A ordem é padronizada com base na função selecionada. Para obter mais informações sobre números de prioridade de pedido padrão, consulte Ajuda integrada funções.
      Domínio Especifique o domínio para o qual este conteúdo é usado, se aplicável.

      Este campo aparecerá no formulário se o administrador tiver configurado o formulário para exibi-lo.

    4. No campo Conteúdo, insira o texto usando as ferramentas de formatação HTML conforme necessário.
      Se você adicionar um link, insira o URL completo da página da Web. Uma prática recomendada é selecionar Nova janela (_blank) como o Destino.
      Nota:
      Não adicione imagens a um tópico de ajuda incorporado. As imagens são removidas da seção de conteúdo quando o registro é salvo.

      Para adicionar um vídeo incorporado, consulte Incorporar conteúdo de vídeo em tópicos de ajuda.

    5. Opcional: Para adicionar outra linha abaixo de tabelas, vídeos ou links relacionados, clique no ícone de nova linha ().
    6. Clique em Enviar.