SPSEOUtilsSNC - Global

A API SPSEOUtilsSNC é uma inclusão de script global que fornece métodos de utilitário que retornam URLs legíveis para uma página específica ou para a página atual, com base na solicitação de transação.

Além disso, esta API fornece outros métodos de utilitário que você pode usar para obter informações necessárias para chamar outros métodos de URL legíveis.

SPSEOUtilsSNC – getHumanReadableUrlForCurrentRequest()

Retorna o URL legível do registro Portal de serviços atual.

Este método replica os parâmetros no URL criptografado da página atual, como o parâmetro id e os parâmetros de consulta, ao criar este URL legível.

Tabela 1. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 2. Retorna

Tipo	Descrição
Cadeia de caracteres	URL legível do registro Portal de serviços atual.

O exemplo de código a seguir mostra como chamar este método. Neste exemplo, o registro Portal de serviços atual usa o URL criptografado de<instance-url> /sp?id=kb_article&sys_id=471ee81eff6002009b20ffffffffff34 e está configurado para mostrar a descrição resumida de um artigo da base de conhecimento que aborda a navegação no Windows. A URL legível retornada para esta URL criptografada é "get-a-volta-no-windows".

// In a script include
function() {
  var util = new global.SPSEOUtilsSNC()
  var hrUrl = util.getHumanReadableUrlForCurrentRequest();
}

Saída:

getting-around-in-windows

SPSEOUtilsSNC - getHumanReadableUrl(GlideRecord pageGR, String queryString)

Retorna o URL legível de um registro especificado na tabela Página [sp_page]. Usa os parâmetros de consulta passados para resolver quaisquer variáveis de página dinâmica exigidas pelo URL.

Tabela 3. Parâmetros

Nome	Tipo	Descrição
pageGR	GlideRecord	Objeto GlideRecord do registro na tabela Página [sp_page] para a qual o URL legível será retornado. Use o método SPSEOUtilsSNC - getPageRecordWithPageRoute(GlideRecord pageId, Cadeia de caracteres portalId, Booliano preventReRoute) para obter o GlideRecord sp_page desejado.
cadeia de caracteres de consulta	Cadeia de caracteres	Cadeia de caracteres de consulta a ser usada para resolver quaisquer parâmetros que possam precisar ser passados pelo URL. Por exemplo: ?id=kb_article&sys_id=471ee81eff6002009b20ffffffffff34

Tabela 4. Retorna

Tipo	Descrição
Cadeia de caracteres	URL legível para o registro Portal de serviços especificado. As variáveis de URL são resolvidas usando o conteúdo do parâmetro queryString passado.

O exemplo de código a seguir mostra como chamar este método para obter o URL legível.

function() { 
  var util = new global.SPSEOUtilsSNC();
  var portalId = util.getPortalId();
  var pageGR = util.getPageRecordWithPageRoute(
    'kb_article', portalId, false); 
  var queryString = "?id=kb_article&sys_id=471ee81eff6002009b20ffffffffff34"; 
  var hrUrl = util.getHumanReadableUrl(pageGR, queryString);

Saída:

"getting-around-in-windows"

SPSEOUtilsSNC - getPageRecordWithPageRoute(GlideRecord pageId, Cadeia de caracteres portalId, Booliano preventReRoute)

Retorna o GlideRecord da tabela Páginas [sp_page] cujo campo ID corresponde ao parâmetro ID passado (pageId). Chame este método antes de chamar o método getHumanReadableUrl() para obter o GlideRecord de sp_pages desejado.

Você também pode solicitar que o método use as informações dos mapas de rota da página para retornar o GlideRecord da página Portal de serviços final associada ao ID de página Portal de serviços passado. Para obter informações adicionais sobre mapas de rota de página, consulte Redirecionar uma referência para um ID de página.

Tabela 5. Parâmetros

Nome	Tipo	Descrição
pageId	Cadeia de caracteres	ID do registro de páginas [sp_page] a retornar. Localizado no campo id ] da tabela Páginas [sp_page].
ID do portal	Cadeia de caracteres	Sys_id do registro do Portal de serviços [sp_portal] associado. Necessário para retornar o login apropriado ou páginas 404 caso o registro associado ao parâmetro pageId passado não esteja acessível ou esteja indisponível. Use o método SPSEOUtilsSNC – getPortalId() para obter o ID Portal de serviços desejado.
preventReRoute	Booliano	Sinalizador que indica se mapas de rota de página devem ser usados para retornar o GlideRecord da última sp_page para a qual o ID de página passado é resolvido, em vez do registro sp_page correspondente. Valores possíveis: verdadeiro: use os mapas de rota de página para retornar o último registro sp_page para o qual o ID de página passado é resolvido. falso: retorna o registro sp_page ao qual o ID de página passado corresponde.

Tabela 6. Retorna

Tipo	Descrição
GlideRecord	Registro que corresponde à solicitação de consulta do registro sp_page.

O exemplo de código a seguir mostra como chamar este método antes de chamar o método getHumanReadableUrl().

function() { 
  var util = new global.SPSEOUtilsSNC();
  var portalId = util.getPortalId();
  var pageGR = util.getPageRecordWithPageRoute(
    'kb_article', portalId, false); 
  var queryString = "?id=kb_article&sys_id=471ee81eff6002009b20ffffffffff34"; 
  var hrUrl = util.getHumanReadableUrl(pageGR, queryString);

SPSEOUtilsSNC – getPortalId()

Retorna o sys_id do portal que está sendo carregado com base no sufixo do portal no URL da solicitação. Chame este método antes de chamar o método getPageRecordWithPageRoute() para obter o Portal de serviços sys_id desejado.

Tabela 7. Parâmetros

Nome	Tipo	Descrição
Nenhum

Tabela 8. Retorna

Tipo	Descrição
Cadeia de caracteres	Sys_id do solicitado Portal de serviços com base no sufixo do portal do URL da solicitação.

O exemplo de código a seguir mostra como chamar este método para uma URL como<instance-url> /sp?id=index.

function() { 
  var util = new global.SPSEOUtilsSNC();
  var portalId = util.getPortalId();
  var pageGR = util.getPageRecordWithPageRoute(
    'kb_article', portalId, false); 
  var queryString = "?id=kb_article&sys_id=471ee81eff6002009b20ffffffffff34"; 
  var hrUrl = util.getHumanReadableUrl(pageGR, queryString);

Saída:

81b75d3147032100ba13a5554ee4902b