GlideSPUtil : Global

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 2 Minuten Lesedauer
  • Die GlideSPUtil -API bietet Dienstprogrammmethoden zum Ausführen gängiger Back-End-Funktionen, die Serviceportalunterstützen.

    Verfügbare Dienstprogrammmethoden:
    • Lösen Sie Variablen auf, die in der Tabelle „Dynamische Seitenvariablen“ [sp_page_title_variable] angegeben sind, die einer angegebenen Seite Serviceportal zugeordnet sind, die sich in der Tabelle „Seite“ [sp_page] befindet.
    • Andere Methoden

    Weitere Informationen finden Sie unter Serviceportal-Seiten.

    GlideSPUtil: GlideSPUtil()

    Instanziiert ein GlideSPUtil-Objekt.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie ein GlideSPUtil-Objekt instanziiert wird, bevor eine der zugehörigen Methoden aufgerufen wird.

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

    Berücksichtigt den „id“-Abfrageparameter, um die Portalseite (pageGR) zu identifizieren, und verwendet die Abfragezeichenfolge der aktuellen Transaktion, um getHumanReadableUrl(GlideRecord pageGR, String queryString) aufzurufen und gibt das endgültige visuell lesbare Element zurück.

    Tabelle : 2. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 3. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Visuell lesbare URL für den angegebenen Datensatz Serviceportal, wobei die Variablen durch den Inhalt der Zeichenfolgenzuordnung queryParams ersetzt werden.

    Das folgende Codebeispiel zeigt die Verwendung von.

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

    Ausgabe:

    GlideSPUtil – getHumanReadableUrl(GlideRecord pageGR, Zeichenfolge queryParams)

    Konvertiert den übergebenen Zeichenfolgenparameter queryParms in eine Zeichenfolgenzuordnung, löst dann die Variablen in der Zeichenfolge „Von Menschen lesbare URL-Struktur“ auf, die im sp_page-Datensatz angegeben ist, und gibt den endgültigen visuell lesbaren Teil der URL zurück.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    pageGR GlideRecord GlideRecord-Objekt des Datensatzes in der Seitentabelle [sp_page], für das die URL-Variablen aufgelöst werden sollen.
    AbfrageZeichenfolge Zeichenfolge Abfragezeichenfolge.
    Tabelle : 5. Rückgaben
    Typ Beschreibung
    Zeichenfolge Visuell lesbare URL für den angegebenen Datensatz Serviceportal, wobei die Variablen durch den Inhalt der Zeichenfolgenzuordnung queryParams ersetzt werden.

    Das folgende Codebeispiel zeigt die Verwendung von.

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

    Ausgabe:

    GlideSPUtil – getHumanReadableUrl(GlideRecord pageGR, StringMap queryParams)

    Löst die Variablen im Feld „Von Menschen lesbare URL-Struktur“ des übergebenen Vorlagenseitenobjekts Serviceportal auf und gibt eine URL zurück, die die angegebenen Abfrageparameter und die aufgelösten für Menschen lesbaren Parameter enthält.

    Mit visuell lesbaren Schlüsselwörtern in einer URL können Sie:
    • Ermöglichen Sie Ihren Kunden, den Zweck der URL besser zu verstehen, wenn sie nicht im Kontext der zugehörigen Seite enthalten ist.
    • Stellen Sie Suchmaschinen Stichwörter bereit, um die Seite besser finden zu können.

    Anstatt nur eine URL zu haben, die nicht erkennbare Schlüssel-Wert-Paare enthält, wie folgt:

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

    Sie können der URL den Elementnamen hinzufügen, damit der Zweck der URL leichter verständlich ist:

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

    Bevor Sie diese Methode verwenden können, müssen Sie die dynamischen Seitenvariablen definieren, die für jede der Serviceportal -Vorlagen verfügbar sind, für die Sie dynamische Inhalte in die URL aufnehmen möchten. Einzelheiten zum Hinzufügen dieser Variablen finden Sie unter Add human readable keywords to page URLs.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    pageGR GlideRecord GlideRecord-Objekt der VorlagenseiteServiceportal, für die die dynamischen URL-Variablen aufgelöst werden sollen.

    Tabelle: Seite [sp_page]

    queryParams StingMap URL-Abfrageparameter zum Abrufen der gewünschten Seite Serviceportal.
    Zum Beispiel:
    {
      "id": "sc_cat_item",
      "sys_id": "ec80c13297968d1021983d1e6253af32",
      "sysparm_catgory": "1e80c15697969f1032083d1e6253be15"
    }
    Tabelle : 7. Rückgaben
    Typ Beschreibung
    Zeichenfolge URL, die die aufgelösten visuell lesbaren Elemente für die dynamischen Variablen enthält, die auf der Vorlagenseite Serviceportal angegeben sind.

    Wenn die definierte dynamische Variable beispielsweise %item_nameist, enthält die URL den Namen des vom Anwender ausgewählten Elements, z. B. „apple-iphone-13“, und alle angegebenen Abfrageparameter:

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

    Das folgende Codebeispiel zeigt, wie Sie einen bestimmten KB-Artikel abrufen und getHumanReaadableUrl() aufrufen, um die zugehörigen dynamischen Variablen anzuwenden.

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