---
sourceDocument: Interface do usuário da Now Platform Yokohama
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/pt-BR/yokohama/platform-user-interface

 Release :

    - yokohama

ft:locale :

    - pt-BR

ft:publication_title :

    - Interface do usuário da Now Platform Yokohama

ft:clusterId :

    - platux

bundleId :

    - platux

workflow :

    - Platform


---

# Ajuda integrada planejamento

# Ajuda integrada planejamento {#ariaid-title1}

* Versão de lançamento: Yokohama
* 
* Atualizado 30 de jan. de 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 3 min. de leitura

Antes de escrever a ajuda integrada personalizada, planeje o conteúdo e anote as informações usadas no formulário da Ajuda integrada. O planejamento cuidadoso garante que o tópico apareça para a página e a função corretas.

Cada página de IU pode exibir ajuda integrada, especificada no Página conforme mostrado no exemplo a seguir.  
Figura 1. Tópico de ajuda incorporado para a página inicial do Catálogo de serviços

Ao planejar tópicos de ajuda incorporados, considere como os campos a seguir são usados e anote os valores necessários para seus tópicos personalizados.

Página
:   Identifique e anote o nome da página de IU que é encontrado no URL quando a página é exibida como mostrado. Se o nome da página começar com um cifrão, como mid_server_user, inclua o cifrão no nome da página. Antes de escrever um tópico de ajuda incorporado para a página, pesquise o nome da página para localizar um arquivo que você pode copiar.

Modificador
:
    * Normal o conteúdo aparece para qualquer usuário com a função apropriada que navega até a página.
    * Configuração O conteúdo aparece quando a página é acessada a partir de um link na Configuração assistida.

    {#embedded-help-planning__ul_umb_yz1_vy}

    Muitos tópicos de ajuda incorporados no sistema base são para Configuração assistida. Você pode copiar Configuração e altere o. Modificador para Normal para fornecer ajuda rapidamente a todos os usuários.

Qualificador
:   Identifique as páginas para as quais você deseja ajuda personalizada que são usadas em muitas aplicações.Por exemplo, o. início.do A página é aberta para todos os módulos da Página inicial e para muitos módulos do Painel. O administrador da ajuda integrada pode usar qualificadores para personalizar o conteúdo de uma página comum na instância.

Função
:   Especifique a função de nível mais baixo para fornecer acesso a este tópico de ajuda incorporado. Todas as funções que contêm a função também veem o conteúdo, a menos que exista outro tópico direcionado para a função para a mesma página.

    Por exemplo, se você adicionar conteúdo de ajuda incorporado à função itil que descreve seu processo de negócios para inserir incidentes, a função itil_admin também verá o conteúdo. Se você escrever um tópico diferente com a função itil_admin, o itil_admin verá esse conteúdo em vez do conteúdo itil.

Produto
:   Escreva conteúdo somente para Empresa tópico. Você pode copiar um Expresso e altere este campo para Empresa se apropriado.

Versão
:   O conteúdo do sistema de base é normalmente especificado para a versão atual do software. Se você estiver editando o conteúdo de uma aplicação personalizada ou para fornecer informações relevantes para o processo de negócios da sua organização, selecione Todos .

Domínio
:   Se sua organização usar separação de domínio e personalizar o conteúdo de ajuda, especifique o domínio ao qual o conteúdo se aplica.

ServiceNow Ajuda
:   Se a caixa de seleção estiver marcada, este campo indica um tópico do sistema de base. Você não pode editar um tópico do sistema de base, mas pode criar uma cópia para adicionar conteúdo personalizado.

Conteúdo
:   Você pode usar as ferramentas de formatação para formatar o conteúdo. A lista a seguir descreve as limitações.

    * Não é possível incluir imagens no conteúdo de ajuda incorporado.
    * Para incorporar o vídeo, você deve codificar as informações do vídeo no código-fonte \> . \> exibir. O conteúdo de vídeo do YouTube e do Vimeo é compatível.
    * Para adicionar um link de informações relacionadas, você deve usar um URL completo, não um URL relativo.
    * A prática recomendada é não usar a ferramenta Realçar texto, pois a cor pode tornar o texto ilegível, dependendo do tema selecionado pelo usuário.
    * 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.
    {#embedded-help-planning__ul_ksm_t3d_yy}
* **[Use qualificadores em Ajuda integrada](https://servicenow-prod.fluidtopics.net/xjq9rOjNHBba3EqFCMIKjA)**   
  O administrador da ajuda integrada pode usar qualificadores para personalizar o conteúdo de uma página comum na instância.
* **[Ajuda integrada funções](https://servicenow-prod.fluidtopics.net/yd8cdvKMTvtlIvcZQd0R7w)**   
  O conteúdo da ajuda integrada pode ser direcionado a usuários com uma função especificada que acessam a página de IU. Todas as funções que contêm a função também veem o conteúdo, a menos que exista outro tópico direcionado para a função para a mesma página.
* **[Ajuda integrada internacionalização](https://servicenow-prod.fluidtopics.net/asyBR5vSoNPm0o7giRcYWQ)**   
  A internacionalização da ajuda integrada permite que você localize seu conteúdo de ajuda integrada em uma variedade de idiomas para atender às necessidades globais do usuário. Você pode escrever seu conteúdo de ajuda incorporado em um idioma de sua escolha e decidir quais idiomas exibir.

