Usar qualificadores em Ajuda integrada

  • Versão de lançamento: Xanadu
  • Atualizado 1 de ago. de 2024
  • 2 min. de leitura
  • O administrador da ajuda integrada pode usar qualificadores para personalizar o conteúdo de uma página comum na instância.

    Antes de Iniciar

    Função necessária: opened_help_admin

    Por Que e Quando Desempenhar Esta Tarefa

    A página home.do é aberta para cada módulo de página inicial e para muitos módulos de painel. Os parâmetros de consulta especificados no URL definem qual página inicial abrir.

    Imagine que sua organização deseja fornecer instruções específicas para a página inicial de ANS. Você pode escrever conteúdo de ajuda incorporado personalizado e usar um qualificador para atingir esse objetivo. Crie o qualificador e associe-o ao conteúdo de ajuda integrada personalizado que você escrever.

    Procedimento

    1. Para obter as informações do qualificador, abra o módulo em uma nova janela do navegador e copie o parâmetro de consulta.
      Observe que o parâmetro de consulta usa sublinhados entre as palavras em vez de hífens ou hifens.
      Mostra um parâmetro de consulta na URL e o tipo de link do módulo

      Você também pode selecionar o parâmetro de consulta no campo Argumentos no tipo de link do módulo. Para ver o tipo de link do módulo, clique no ícone de lápis ao lado do módulo no navegador de aplicações e clique na guia Tipo de link.

    2. Navegar até Ajuda integrada > Qualificadores de Ajudae, em seguida, clique em Novo.
    3. Preencha o formulário.
      Tabela 1. Formulário de qualificador de ajuda integrada
      Campo Descrição
      Caminho Entre na página para exibir o conteúdo de ajuda incorporado. Não inclua .do. Por exemplo, para a página inicial do ANS, insira home.
      Parâmetros de consulta

      Insira os parâmetros de consulta ou o argumento de link usando o formato id=query_parameters.

      Aviso:
      Se o parâmetro de consulta contiver mais de uma palavra, use sublinhados entre as palavras em vez de hífens ou hifens. Se você usar hífens ou hifens, o sistema usará somente a primeira palavra no parâmetro e ignorará o restante.
      Fragmento Insira o # <string> no final do URL.
      Isso raramente é encontrado no URL de uma página na instância. Se você quiser ajuda personalizada para uma página que termina com #<string> , coloque-o neste campo.
      Nota:
      A prática comprovada é incluir pelo menos um parâmetro de consulta. Caso contrário, a ajuda personalizada será exibida para cada página do home.do. Você pode usar o parâmetro de consulta, o fragmento ou ambos.
      Qualificador

      Insira o qualificador a ser usado, por exemplo, sla_homepage. Registre o qualificador a ser usado no registro de conteúdo de ajuda integrada.

      Aviso:
      Se o parâmetro de consulta contiver mais de uma palavra, use sublinhados entre as palavras em vez de hífens ou hifens. Se você usar hífens ou hifens, o sistema usará somente a primeira palavra no parâmetro e ignorará o restante.
    4. Clique em Enviar.
    5. Siga as etapas em Adicionar conteúdo Ajuda integrada personalizado para criar o conteúdo e incluir as seguintes informações.
      • Nome e página: a página para a qual você criou o qualificador, por exemplo, página inicial.
      • Qualificador: o qualificador que você inseriu, por exemplo, sla_homepage.
      Nota:
      Você também pode copiar um tópico de ajuda incorporado existente e inserir o qualificador no registro copiado.
    6. Teste o qualificador abrindo a página para a qual você adicionou o conteúdo e abrindo o painel de ajuda.
      Nota:
      Se você adicionou uma função ao conteúdo de ajuda integrada, certifique-se de estar conectado como um usuário com a função ou represente um usuário com essa função.