GlideSPUtil - Global

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 3 min. de leitura
  • A API GlideSPUtil fornece métodos de utilitário para executar funções de back-end comuns que oferecem suporte a um Portal de serviços.

    Métodos de utilitário disponíveis:
    • Resolva as variáveis especificadas na tabela Variáveis de página dinâmica [sp_page_title_variable] associadas a uma página Portal de serviços especificada localizada na tabela Página [sp_page].
    • Outros métodos

    Para obter informações adicionais, consulte Páginas do Portal de serviços.

    GlideSPUtil - GlideSPUtil()

    Instancia um objeto GlideSPUtil.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum(a)

    O exemplo de código a seguir mostra como instanciar um objeto GlideSPUtil antes de chamar qualquer um dos métodos associados.

    function() {
      var spUtil = new GlideSPUtil();
      var pageGR = spUtil.getPageRecordWithPageRoute('kb_article', '81b75d3147032100ba13a5554ee4902b', false);
      var queryParams = RP.getParameters();
      var hrUrl = spUtil.getHumanReadableUrl(pageGR, queryParams);
    }

    GlideSPUtil – getHumanReadableUrl()

    Considera o parâmetro de consulta 'id' para identificar a página do portal (pageGR) e usa a cadeia de caracteres de consulta da transação atual para chamar getHumanReadableUrl (GlideRecord pageGR, String queryString) e retorna o legível final.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 3. Retorna
    Tipo Descrição
    Cadeia de caracteres URL legível para o registro Portal de serviços especificado com as variáveis substituídas pelo conteúdo do mapa de cadeia de caracteres queryParams.

    O exemplo de código a seguir mostra como.

    function() {
      var spUtil = new GlideSPUtil();
      var hrUrl = spUtil.getHumanReadableUrl();
    }

    Saída:

    GlideSPUtil – getHumanReadableUrl(GlideRecord pageGR, String queryParams)

    Converte o parâmetro de cadeia de caracteres queryParms passado em um mapa de cadeia de caracteres e, em seguida, resolve as variáveis na cadeia de caracteres "Estrutura de URL legível" fornecida no registro sp_page e retorna a parte legível final do URL.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    pageGR GlideRecord Objeto GlideRecord do registro na tabela Página [sp_page] na qual as variáveis de URL são resolvidas.
    consultaCadeia de caracteres Cadeia de caracteres Cadeia de caracteres de consulta.
    Tabela 5. Retornos
    Tipo Descrição
    Cadeia de caracteres URL legível para o registro Portal de serviços especificado com as variáveis substituídas pelo conteúdo do mapa de cadeia de caracteres queryParams.

    O exemplo de código a seguir mostra como.

    function() {
      var spUtil = new GlideSPUtil();
      var pageGR = spUtil.getPageRecordWithPageRoute('kb_article', '81b75d3147032100ba13a5554ee4902b', false);
      var queryString = GlideTransaction.get().getRequest().getQueryString();
      var hrUrl = spUtil.getHumanReadableUrl(pageGR, queryParams);
    }

    Saída:

    GlideSPUtil – getHumanReadableUrl(GlideRecord pageGR, StringMap queryParams)

    Resolve as variáveis no campo Estrutura de URL legível do objeto de página de modelo passado Portal de serviços e retorna um URL que contém os parâmetros de consulta especificados e os parâmetros legíveis resolvidos.

    Use palavras-chave legíveis em um URL para:
    • Permita que seus clientes entendam melhor a finalidade do URL quando ele não estiver no contexto da página associada.
    • Forneça palavras-chave aos mecanismos de pesquisa para localizar melhor a página.

    Por exemplo, em vez de ter apenas um URL que contém pares de chave-valor irreconhecíveis, como este:

    https://instance_name.servicenow.com/sp/en?id=sc_cat_item&sys_id=ec80c13297968d1021983d1e6253af32&sysparm_catgory=1e80c15697969f1032083d1e6253be15

    Você pode adicionar o nome do item ao URL para que seja mais fácil entender a finalidade do URL:

    https://instance_name.servicenow.com/sp/en/apple-iphone-13?id=sc_cat_item&sys_id=ec80c13297968d1021983d1e6253af32&sysparm_catgory=1e80c15697969f1032083d1e6253be15

    Antes de poder usar este método, você deve definir as variáveis de página dinâmica que estão disponíveis para cada um dos modelos Portal de serviços para os quais você deseja incluir conteúdo dinâmico no URL. Para obter detalhes sobre como adicionar essas variáveis, consulte Add human readable keywords to page URLs.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    pageGR GlideRecord Objeto GlideRecord da página de modeloPortal de serviços para a qual as variáveis de URL dinâmicas serão resolvidas.

    Tabela: página [sp_page]

    queryParams StingMap Parâmetros de consulta de URL a serem usados para obter a página Portal de serviços desejada.
    Por exemplo:
    {
      "id": "sc_cat_item",
      "sys_id": "ec80c13297968d1021983d1e6253af32",
      "sysparm_catgory": "1e80c15697969f1032083d1e6253be15"
    }
    Tabela 7. Retornos
    Tipo Descrição
    Cadeia de caracteres URL que contém os elementos legíveis resolvidos para as variáveis dinâmicas especificadas na página de modelo Portal de serviços.

    Por exemplo, se a variável dinâmica definida for %item_name, o URL conterá o nome do item que o usuário selecionou, como "apple-iphone-13", e todos os parâmetros de consulta especificados:

    https://instance_name.servicenow.com/sp/en/apple-iphone-13?id=sc_cat_item&sys_id=ec80c13297968d1021983d1e6253af32&sysparm_catgory=1e80c15697969f1032083d1e6253be15.

    O exemplo de código a seguir mostra como obter um artigo específico da base de conhecimento e chamar getHumanReaadableUrl() para aplicar as variáveis dinâmicas associadas.

    function() {
      var spUtil = new GlideSPUtil();
      var pageGR = spUtil.getPageRecordWithPageRoute('kb_article', '81b75d3147032100ba13a5554ee4902b', false);
      var queryParams = RP.getParameters();
      var hrUrl = spUtil.getHumanReadableUrl(pageGR, queryParams);
    }