Adicionar palavras-chave legíveis a URLs de página

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 4 min. de leitura
  • Adicione palavras-chave legíveis aos URLs das páginas do portal para melhorar a otimização do mecanismo de pesquisa (SEO) e as taxas de cliques e ajudar os usuários a entender o que esperar na página.

    Antes de Iniciar

    Função necessária: sp_admin ou administrador

    Por Que e Quando Desempenhar Esta Tarefa

    Palavras-chave legíveis são adicionadas a URLs no seguinte formato:

    https://<instance> /<portal suffix> /<guest language> /<keywords> ?id=<page id> e<page parameters>

    As palavras-chave podem ser preenchidas usando conteúdo estático ou variáveis de página dinâmicas e podem incluir uma única barra (/). As variáveis de página dinâmica carregam palavras-chave que são baseadas em dados em um registro. Os parâmetros de página no URL especificam qual registro usar. Nos exemplos a seguir, a categoria e a descrição resumida de um artigo de conhecimento e a categoria e o nome de um item do catálogo são adicionados como palavras-chave:

    • https://<instance> /kb/en/faq/what-is-a-cookie?id=kb_article_view&sysparm_article=KB0000007
    • https://<instance> /sp/es/hardware/developer-laptop-mac?id=sc_cat_item&sys_id=774906834fbb4200086eeed18110c737
    Nota:
    Para desativar URLs legíveis para uma instância, adicione a propriedade glide.service_portal.enable_human_readable_urls à tabela Propriedades do sistema [sys_properties] e defina o valor como falso.

    Procedimento

    1. Navegar até Tudo > Portal de serviços > Páginas.
    2. Selecione uma página.
    3. Opcional: Use palavras-chave dinâmicas com base no conteúdo da página adicionando uma variável de página dinâmica à página.
      1. Selecione a guia da lista relacionada Variáveis de página dinâmica.
      2. Selecione Novo.
      3. No formulário, preencha os campos.
        Tabela 1. Formulário de variáveis de página dinâmica
        Campo Descrição
        Nome A variável que carrega palavras-chave no URL da página a partir dos dados do registro. O nome da variável deve começar com % e não pode conter espaços. Por exemplo, %short_descr.
        Ordem A ordem de prioridade da mais baixa para a mais alta quando várias variáveis de página dinâmica com o mesmo nome têm parâmetros de consulta de URL diferentes.
        Página A página que usa a variável de página dinâmica para incluir palavras-chave no URL.
        Parâmetro de consulta de URL O parâmetro no URL da página que determina qual registro é exibido.
        Coluna da tabela relevante A coluna na tabela especificada que inclui os valores do parâmetro de consulta de URL. O valor padrão é SYS ID.
        Tabela A tabela que inclui os registros usados para preencher as palavras-chave no URL e a coluna com os valores do parâmetro de consulta do URL.
        Campo de tabela Um campo de registros na tabela especificada que preenche as palavras-chave no URL.
        Condição da consulta Condições que filtram os registros na tabela. Um registro deve atender às condições de consulta para que a variável seja aplicada.

        Este exemplo mostra os valores de uma variável que faz referência à descrição resumida de um artigo da base de conhecimento identificado por seu número para um fluxo de trabalho publicado.

        Tabela 2. Variável de página dinâmica
        Campo Valor
        Nome %short_descr
        Página kb_article_view
        Ordem 100
        Parâmetro de consulta de URL sysparm_article
        Coluna da tabela relevante Número
        Tabela Conhecimento[kb_knowledge]
        Campo de tabela Descrição resumida
        Condição da consulta [Fluxo de trabalho][é][Publicado]
    4. Selecione Enviar.
    5. No campo Estrutura de URL legível do registro da página, especifique as palavras-chave a serem preenchidas no URL da página usando conteúdo estático, variáveis de página dinâmicas ou uma combinação.

      As palavras-chave podem incluir caracteres alfanuméricos, hifens (-), uma barra (/) e sinais de porcentagem (%) para variáveis.

      Estrutura de URL legível Valor de exemplo
      Conteúdo estático perguntas frequentes/o que é um cookie
      Variáveis de página dinâmica %category/%short_descr
      Conteúdo estático e variável de página dinâmica faq/%short_descr

      As palavras-chave são formatadas automaticamente para usar somente letras minúsculas, substituir espaços por hifens e remover caracteres especiais não permitidos adicionados por variáveis de página dinâmica. Se as palavras-chave no URL excederem 75 caracteres, elas serão truncadas para serem menores ou iguais a 75 caracteres.

    6. Selecione Atualizar.

    Resultado

    Se os usuários acessarem a página usando o URL sem palavras-chave legíveis, o URL da página será atualizado de uma das seguintes maneiras:

    • No carregamento da página inicial por um usuário convidado, a página é redirecionada para o URL legível.
    • No carregamento da página inicial por um usuário autenticado, o URL é atualizado para incluir as palavras-chave legíveis sem redirecionamento.
    • Nos carregamentos de página subsequentes para todos os usuários, o URL é atualizado para incluir as palavras-chave legíveis sem redirecionamento.

    Página de artigo de conhecimento com palavras-chave legíveis no URL

    Neste exemplo, a página kb_article_view exibe o artigo de conhecimento KB0000007. O registro do artigo de conhecimento tem os seguintes campos e valores:

    • A categoria é Perguntas frequentes
    • A descrição resumida é O que é um cookie?

    A página foi configurada para adicionar palavras-chave com base nesses valores de campo ao URL usando variáveis de página dinâmicas, como %category/%short_descr. O ponto de interrogação na descrição resumida não é um caractere permitido nas palavras-chave da URL, portanto, ele é removido automaticamente da URL. O ponto de interrogação que está no URL é o parâmetro de consulta sempre incluído antes do ID da página.

    O URL exibido no navegador aparece como: http://<instance> .com/kb/en/faq/what-is-a-cookie?id=kb_article_view&sysparm_article=KB0000007 .

    O que Fazer Depois

    Para páginas que têm URLs canônicos, você deve incluir as palavras-chave legíveis no URL canônico. Na inclusão de script SEO que retorna URLs canônicos para páginas, use um dos métodos getHumanReadableUrl na classe SPSEOUtilsSNC para retornar as palavras-chave legíveis em URLs de página e incluí-las nos URLs canônicos.

    Para obter mais informações sobre como incluir palavras-chave legíveis em URLs canônicos, consulte os seguintes recursos: