SPSEOUtilsSNC - Global

L’API SPSEOUtilsSNC est un script include global qui fournit des méthodes utilitaires qui renvoient des URL lisibles par l’homme pour une page spécifique, ou pour la page actuelle, en fonction de la demande de transaction.

En outre, cette API fournit d’autres méthodes utilitaires que vous pouvez utiliser pour obtenir les informations nécessaires pour appeler d’autres méthodes d’URL lisibles par l’homme.

SPSEOUtilsSNC : getHumanReadableUrlForCurrentRequest()

Renvoie l’URL explicite de l’enregistrement actuel Portail de services .

Cette méthode réplique les paramètres de l’URL cryptique de la page actuelle, tels que le paramètre et les id paramètres de requête, lors de la création de cette URL explicite.

Tableau 1. Paramètres

Nom	Type	Description
Aucun

Tableau 2. Renvoie

Type	Description
Chaîne	URL explicite de l’enregistrement actuel Portail de services .

L’exemple de code suivant montre comment appeler cette méthode. Dans cet exemple, l’enregistrement actuel Portail de services utilise l’URL chiffrée <instance-url>/sp ?id=kb_article&sys_id=471ee81eff6002009b20ffffffffff34 et est configuré pour afficher la brève description d’un article de la base de connaissances qui traite de la navigation dans Windows. L’URL explicite renvoyée pour cette URL cryptique est « getting-around-in-windows ».

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

Sortie :

getting-around-in-windows

SPSEOUtilsSNC : getHumanReadableUrl(GlideRecord, pageGR, String, QueryString)

Renvoie l’URL explicite d’un enregistrement spécifié dans la table Page [sp_page ]. Utilise les paramètres de requête transmis pour résoudre toutes les variables de page dynamiques requises par l’URL.

Tableau 3. Paramètres

Nom	Type	Description
pageGR (en anglais seulement)	GlideRecord	Objet GlideRecord de l’enregistrement dans la table Page [sp_page] dont l’URL explicite doit être renvoyée. Utilisez la SPSEOUtilsSNC : getPageRecordWithPageRoute(GlideRecord pageId, String portalId, booléen preventReRoute) méthode pour obtenir le sp_page GlideRecord souhaité.
Querystring	Chaîne	Chaîne de requête à utiliser pour résoudre tous les paramètres devant être transmis par l’URL. Par exemple : ?id=kb_article&sys_id=471ee81eff6002009b20ffffffff34

Tableau 4. Renvoie

Type	Description
Chaîne	URL explicite de l’enregistrement spécifié Portail de services . Les variables URL sont résolues à l’aide du contenu du paramètre transmis queryString .

L’exemple de code suivant montre comment appeler cette méthode pour obtenir l’URL explicite.

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);

Sortie :

"getting-around-in-windows"

SPSEOUtilsSNC : getPageRecordWithPageRoute(GlideRecord pageId, String portalId, booléen preventReRoute)

Renvoie le GlideRecord de la table Pages [sp_page] dont le champ ID correspond au paramètre ID passé (pageId). Appelez cette méthode avant d’appeler la méthode getHumanReadableUrl() pour obtenir le sp_pages GlideRecord souhaité.

Vous pouvez également demander à la méthode d’utiliser les informations des mappages de routage des pages pour renvoyer le GlideRecord de la page finale Portail de services associée à l’ID de page transmis Portail de services . Pour plus d’informations sur les cartes d’acheminement des pages, voir Rediriger une référence vers un ID de page.

Tableau 5. Paramètres

Nom	Type	Description
pageId	Chaîne	ID de l’enregistrement Pages [sp_page] à renvoyer. Situé dans le id champ de la table Pages [sp_page].
ID portail	Chaîne	Sys_id de l’enregistrement du portail de services associé [sp_portal]. Nécessaire pour renvoyer la connexion appropriée ou les pages 404 au cas où l’enregistrement associé au paramètre transmis pageId n’est pas accessible ou indisponible. Utilisez la SPSEOUtilsSNC : getPortalId() méthode pour obtenir l’ID souhaité Portail de services .
preventReRoute	Booléen	Marqueur indiquant s’il faut utiliser des mappages d’acheminement des pages pour retourner le GlideRecord pour la dernière sp_page à laquelle l’ID de page transmis se résout, au lieu de l’enregistrement de sp_page correspondant. Valeurs possibles : true : utiliser les mappages d’acheminement des pages pour renvoyer le dernier enregistrement de sp_page auquel l’ID de page transmis se résout. false : renvoie l’enregistrement de sp_page auquel correspond l’ID de page transmis.

Tableau 6. Renvoie

Type	Description
GlideRecord	Enregistrement qui correspond à la demande de requête pour l’enregistrement sp_page.

L’exemple de code suivant montre comment appeler cette méthode avant d’appeler la méthode 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()

Renvoie la sys_id du portail en cours de chargement en fonction du suffixe du portail dans l’URL de la demande. Appelez cette méthode avant d’appeler la méthode getPageRecordWithPageRoute() pour obtenir le sys_id souhaité Portail de services .

Tableau 7. Paramètres

Nom	Type	Description
Aucun

Tableau 8. Renvoie

Type	Description
Chaîne	Sys_id de la demande Portail de services en fonction du suffixe du portail de l’URL de la demande.

L’exemple de code suivant montre comment appeler cette méthode pour une URL telle que <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);

Sortie :

81b75d3147032100ba13a5554ee4902b