SPSEOUtilsSNC – Global

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 3 Minuten Lesedauer

    • Die API SPSEOUtilsSNC ist eine globale Skripteinbindung, die Dienstprogrammmethoden bereitstellt, die visuell lesbare URLs für eine bestimmte Seite oder für die aktuelle Seite basierend auf der Transaktionsanforderung zurückgeben.

    Darüber hinaus bietet diese API weitere Dienstprogrammmethoden, mit denen Sie Informationen abrufen können, die zum Aufrufen anderer visuell lesbarer URL-Methoden erforderlich sind.

    SPSEOUtilsSNC – getHumanReadableUrlForCurrentRequest()

    Gibt die visuell lesbare URL für den aktuellen Datensatz Serviceportal zurück.

    Diese Methode repliziert die Parameter in der verschlüsselten URL der aktuellen Seite, z. B. den Parameter id und die Abfrageparameter, wenn diese visuell lesbare URL erstellt wird.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Visuell lesbare URL für den aktuellen Datensatz Serviceportal.

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird. In diesem Beispiel verwendet der aktuelle Serviceportal -Datensatz die verschlüsselte URL<instance-url> /sp?id=kb_article&sys_id=471ee81eff6002009b20fffffffffffff34 und ist so konfiguriert, dass die Kurzbeschreibung eines KB-Artikels angezeigt wird, in dem die Navigation in Windows erläutert wird. Die zurückgegebene visuell lesbare URL für diese verschlüsselte URL lautet „get-around-in-windows“.

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

    Ausgabe:

    getting-around-in-windows

    SPSEOUtilsSNC – getHumanReadableUrl(GlideRecord pageGR, String queryString)

    Gibt die visuell lesbare URL für einen angegebenen Datensatz in der Seitentabelle [sp_page ] zurück. Verwendet die übergebenen Abfrageparameter, um alle dynamischen Seitenvariablen aufzulösen, die für die URL erforderlich sind.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    pageGR GlideRecord GlideRecord-Objekt des Datensatzes in der Seitentabelle [sp_page], für den die visuell lesbare URL zurückgegeben werden soll.

    Verwenden Sie die Methode SPSEOUtilsSNC – getPageRecordWithPageRoute(GlideRecord pageId, String portalId, Boolean PreventReRoute), um den gewünschten sp_page-GlideRecord zu erhalten.
    queryString Zeichenfolge Abfragezeichenfolge, die zum Auflösen von Parametern verwendet werden soll, die möglicherweise von der URL übergeben werden müssen.

    Beispiel: ?id=kb_article&sys_id=471ee81eff6002009b20fffffffffffff34
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Visuell lesbare URL für den angegebenen Datensatz Serviceportal. Die URL-Variablen werden anhand des Inhalts des übergebenen Parameters queryString aufgelöst.

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird, um die visuell lesbare URL zu erhalten.

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

    Ausgabe:

    "getting-around-in-windows"

    SPSEOUtilsSNC – getPageRecordWithPageRoute(GlideRecord pageId, String portalId, Boolean PreventReRoute)

    Gibt den GlideRecord aus der Seitentabelle [sp_page] zurück, deren ID-Feld mit dem übergebenen ID-Parameter (pageId) übereinstimmt. Rufen Sie diese Methode auf, bevor Sie die getHumanReadableUrl()- Methode aufrufen, um den gewünschten sp_pages-GlideRecord zu erhalten.

    Sie können auch anfordern, dass die Methode die Informationen der Seitenroutenzuordnungen verwendet, um den GlideRecord der letzten Serviceportal Seite zurückzugeben, die der übergebenen Serviceportal Seiten-ID zugeordnet ist. Weitere Informationen zu Seiten- Routenzuordnungen finden Sie unter Verweise auf Seiten-IDs umleiten.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    pageId Zeichenfolge ID des zurückzugebenden Seitendatensatzes [sp_page]. Befindet sich im Feld id der Seitentabelle [sp_page].
    portalId Zeichenfolge Sys_id des zugeordneten Service Portal-Datensatzes [sp_portal]. Erforderlich, um die entsprechenden Anmelde- oder 404-Seiten zurückzugeben, falls der Datensatz, der dem übergebenen Parameter pageId zugeordnet ist, nicht zugänglich oder nicht verfügbar ist.

    Verwenden Sie die Methode SPSEOUtilsSNC – getPortalId(), um die gewünschte ID Serviceportal ] zu erhalten.
    VerhindernReRoute Boolean Kennzeichnung, die angibt, ob Seitenroutenzuordnungen verwendet werden sollen, um den GlideRecord für die letzte sp_page zurückzugeben, in die die übergebene Seiten-ID aufgelöst wird, anstelle des entsprechenden sp_page-Datensatzes.
    Mögliche Werte:
    • true: Verwenden Sie die Seitenroutenzuordnungen, um den letzten sp_page-Datensatz zurückzugeben, in den die übergebene Seiten-ID aufgelöst wird.
    • false: Gibt den sp_page-Datensatz zurück, mit dem die übergebene Seiten-ID übereinstimmt.
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    GlideRecord Datensatz, der der Abfrageanforderung für den sp_page-Datensatz entspricht.

    Das folgende Codebeispiel zeigt, wie diese Methode vor dem Aufruf der getHumanReadableUrl()- Methode aufgerufen wird.

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

    Gibt die sys_id des Portals zurück, das basierend auf dem Portalsuffix in der Anforderungs-URL geladen wird. Rufen Sie diese Methode auf, bevor Sie die Methode getPageRecordWithPageRoute() aufrufen, um die gewünschte Serviceportal sys_id zu erhalten.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Sys_id des angeforderten Serviceportal basierend auf dem Portalsuffix der Anforderungs-URL.

    Das folgende Codebeispiel zeigt, wie diese Methode für eine URL wie aufgerufen wird<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);

    Ausgabe:

    81b75d3147032100ba13a5554ee4902b