Isenção de responsabilidade: Este artigo foi gerado usando tradução automática.

Mapeamento de URL

  • Atualizado em Dec 6, 2024
  • Publicado em Nov 25, 2024
  • 6 minuto(s) lido(s)
  • Pradeep Srinivasan
  • Manoharan Soundarraj
 Prev Next

Planos compatíveis com widget da base de conhecimento

Professional
Business
Enterprise



O recurso Mapeamento de URL no widget da base de conhecimento permite que você personalize a exibição de artigos e categorias específicos com base nas páginas que seus usuários finais visitam. Essa funcionalidade não apenas aprimora a experiência do usuário, direcionando-os para conteúdo relevante, mas também permite ocultar o widget da base de conhecimento em determinados URLs ou fornecer uma barra de pesquisa com espaços reservados personalizados, orientando os usuários sobre o que pesquisar.

Usando o mapeamento de URL

Para configurar o mapeamento de URL, execute ações específicas no widget da base de conhecimento para URLs designadas.

Ações

Há quatro ações que você pode executar com o mapeamento de URL:

  1. Mostrar artigo: Exibe um único artigo na URL especificada.

  2. Mostrar lista de artigos: Lista os artigos selecionados na seção Recomendado no widget da Base de conhecimento no URL especificado.

  3. Mostrar resultados da pesquisa: Permite que você defina um termo de pesquisa específico para consultar sua base de conhecimento, retornando resultados de pesquisa relevantes na URL especificada.

  4. Ocultar widget: Impede que o ícone do widget da Base de Dados de Conhecimento apareça no URL especificado.

Você pode encontrar essas ações na guia Mapeamento de URL ou ao editar um mapeamento existente.

NOTA

Para que o Mapeamento de URL funcione, o widget da base de conhecimento deve estar instalado em seu site ou aplicativo. Para mais informações, leia o artigo sobre Installing the Knowledge base widget.

Parâmetros de URL

Ao configurar o URL do widget da Base de conhecimento, você pode incluir três tipos de parâmetros:

  1. Incluir caminho: /thisis/a/path

  2. Incluir consulta: ?animal=bear

  3. Incluir hash: #inbox

Você também pode ativar a alternância Is Regex para incorporar expressões regulares em suas configurações de URL.

Adicionando mapeamento de URL ao seu widget

Para integrar o widget desejado ao seu site da base de conhecimento, siga estas etapas:

  1. Navegue até a guia Mapeamento de URL no Widget () no Knowledge base portal.

  2. Clique em Novo mapeamento de URL e especifique o seguinte:

    • Nome - O nome do mapeamento de URL só será mostrado no registro de mapeamento de URL no Document360

    • Estrutura de URL  - Selecione o tipo de parâmetro de URL desejado (Caminho de inclusão/Consulta de inclusão/Hash de inclusão). Você deve ativar pelo menos um parâmetro de URL

    • Digite o URL no qual você deseja que o artigo/categoria seja exibido ou que a ação ocorra.

      NOTA

      Seu nome de domínio não está incluído no caminho da URL. Por exemplo, https://document360.com/ebook/rapid-guide-to-launch-your-knowledge-base/, seu caminho de URL seria /ebook/rapid-guide-to-launch-your-knowledge-base/

    • Ação - Selecione a ação desejada.

    • Selecionar espaço de trabalho - Selecione a versão desejada (se você tiver várias versões).

    • Idioma para - Selecione o idioma desejado (se você tiver vários idiomas).

    • Artigo a ser mostrado - Na barra de pesquisa, selecione os artigos/categorias que deseja mostrar na documentação da base de conhecimento.

    NOTA

    As categorias de pasta não estão disponíveis para seleção. Somente os tipos de categoria de página e índice estão disponíveis para seleção.

  3. Clique em Criar.

1_URLmapping.gifDepois que um usuário final acessar o caminho de URL especificado e abrir o widget da Base de conhecimento, ele verá o artigo/categoria mapeado. Essas informações permanecem consistentes à medida que navegam entre as guias do widget da Base de conhecimento na mesma versão e idioma.

Editando o mapeamento de URL

Para modificar um mapeamento de URL existente:

  1. Navegue até Widget () no Knowledge base portal.

  2. Passe o mouse sobre o widget da base de conhecimento desejado e clique no ícone Editar ().

    Na guia Mapeamento de URL , você pode encontrar a lista de mapeamento de URL disponível.

  3. Passe o mouse sobre o mapeamento de URL desejado e clique no ícone Editar ().

    A folha Atualizar mapeamento de URL será exibida.

  4. Atualize as informações desejadas e clique em Atualizar.

2_urlmapping_edit.gif  

Excluindo o mapeamento de URL

Você pode excluir um mapeamento de URL definido.

3_urlmapping_delete.png

  1. Navegue até Widget () no Knowledge base portal.

  2. Passe o mouse sobre o widget da base de conhecimento desejado e clique no ícone Editar ().

  3. Na guia Mapeamento de URL , você pode encontrar a lista de mapeamento de URL disponível.

  4. Passe o mouse sobre o mapeamento de URL desejado e clique no ícone Excluir ().

  5. Clique em Sim no prompt de confirmação Excluir .

Configurações de mapeamento de URL

Você pode definir o comportamento do widget da base de conhecimento para URLs que não têm mapeamento configurado. Definir esse comportamento pode melhorar a experiência do usuário e a acessibilidade à documentação.

4_urlmapping_settings.png

  1. Navegue até Widget () no Knowledge base portal > Configurar e conectar.

  2. Na seção Definir controles , expanda a seção Configurações de mapeamento de URL .

  3. Selecione a opção desejada:

    • Navegue até a página de ajuda/base de conhecimento: selecione esta opção para exibir o artigo/categoria na guia Ajuda da página ou Base de conhecimento no Widget.

    • Não faça nenhuma alteração na configuração existente: Selecione esta opção para exibir o último artigo/categoria aberto no Widget.

  4. Clique em Salvar.

Correspondência básica de URL

Entender a correspondência de URL é crucial para um mapeamento de URL eficaz. Um regex de uso geral para corresponder URLs típicos tem esta aparência:

^https?://?[a-zA-Z0-9.-]+/[a-zA-Z0-9/._-]*??[a-zA-Z0-9=&._-]*?#[a-zA-Z0-9_-]*?$

Explicação dos componentes

  • ^https?://?: Corresponde ao protocolo (por exemplo, http:// ou https://). O ? torna o protocolo opcional.

    NOTA

    Certifique-se de adicionar uma barra invertida (\) antes de cada barra (/) ao testar seu URL no https://regex101.com.

  • [a-zA-Z0-9.-]+: Corresponde ao nome de domínio, incluindo letras, números, pontos (.) e hífens (-).

  • /[a-zA-Z0-9/._-]*?: Corresponde ao caminho após o domínio, permitindo barras, caracteres alfanuméricos, pontos, sublinhados e hífens.

  • ?[a-zA-Z0-9=&._-]*?: Corresponde a parâmetros de consulta opcionais (por exemplo, ?key=value), tornando esta parte opcional.

  • #[a-zA-Z0-9_-]*?: Corresponde ao fragmento (por exemplo, #section), que também é opcional.

Exemplos de mapeamento de URL usando Regex

Mapeando URLs com caminhos específicos

Para mapear um padrão de URL como /users/{id}, use:

^/users/[0-9]+$

Isso captura um ID do usuário dinamicamente.

Exemplos de correspondências

  • /users/123

  • /users/456

Mapeando URLs com parâmetros de consulta

Para URLs como /search?q={query}, o regex seria:

^/search?q=[a-zA-Z0-9]+$

Exemplos de correspondências

  • /search?q=apple

  • /search?q=123abc

Mapeando URLs com parâmetros opcionais

Para um padrão de URL como /products/{category}/{id}, em que category é opcional:

^/products/[a-zA-Z]+?/[0-9]+$

Exemplos de correspondências

  • /products/123

  • /products/electronics/123

Mapeando URLs com curinga ou vários caminhos

Para /blog/*:

^/blog/.*?$

Exemplos de correspondências

  • /blog

  • /blog/how-to-code

  • /blog/2021/10

Mapeamento de URLs com subdomínios
Para URLs de subdomínio:

^https?://?[a-zA-Z0-9-]+.example.com$

Exemplos de correspondências

  • http://blog.example.com

  • https://shop.example.com

Combinando vários componentes

Para lidar com mapeamentos de URL mais complexos, você pode combinar os vários componentes conforme necessário. O regex abrangente que corresponde a um URL com um protocolo, domínio, caminho, parâmetros de consulta e fragmento opcionais tem esta aparência:

^https?://?[a-zA-Z0-9.-]+/[a-zA-Z0-9/._-]*??[a-zA-Z0-9=&._-]*?#[a-zA-Z0-9_-]*?$

Perguntas frequentes

Como posso remover a ajuda da página e a barra de pesquisa do widget quando o mapeamento de URL para um único artigo está configurado?

Para remover a Ajuda da página e a barra de pesquisa do widget quando o mapeamento de URL para um único artigo estiver configurado:

  1. Navegue até Widget () no portal da base de conhecimento.

  2. Passe o mouse sobre o widget desejado e clique no ícone Editar ().

  3. Cole o código fornecido na guia CSS personalizado :

    li#page-help-tab {
    display: none;
}

.article-header .article-back-icon {
    display: none;
}

.search-container {
    display: none !Important;
}

  4. Cole o código fornecido na guia JavaScript personalizado :

    setTimeout(function() { $('.search-container').hide();}, 2000);
setTimeout(function() { $("#knowledge-base-tab").click();}, 2000);

  5. Clique em Salvar.

Isso ocultará a guia Ajuda da página e a barra de pesquisa no widget no site da base de conhecimento quando o mapeamento de URL para um único artigo estiver configurado.

Como posso ver as atualizações imediatamente no widget da base de conhecimento depois de adicionar ou atualizar um mapa de URL?

As atualizações são armazenadas em cache no servidor por motivos de desempenho e serão atualizadas automaticamente a cada 15 minutos. No entanto, se você precisar ver as alterações imediatamente, poderá limpar o cache do aplicativo.

Artigos relacionados