spUtil : Client

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 6 Minuten Lesedauer

    • Die spUtil- API stellt Dienstprogrammmethoden zum Ausführen allgemeiner Funktionen in einem Widget-Client-Skript Serviceportal bereit.

    Diese Funktionen umfassen:

    Weitere Informationen zu Widgets finden Sie unter Serviceportal-Widgets.

    spUtil – addErrorMessage(String message)

    Zeigt eine Benachrichtigungsfehlermeldung an.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Nachricht Zeichenfolge Fehlermeldung, die angezeigt werden soll.
    Tabelle : 2. Ergebnisse
    Typ Beschreibung
    void 
    spUtil.addErrorMessage("There has been an error processing your request")

    spUtil – addInfoMessage(String message)

    Zeigt eine Benachrichtigungsinfonachricht an.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Nachricht Zeichenfolge Meldung, die angezeigt werden soll.
    Tabelle : 4. Ergebnisse
    Typ Beschreibung
    void 
    spUtil.addInfoMessage("Your order has been placed")

    spUtil – addTrivialMessage(String message)

    Zeigt eine belanglose Benachrichtigungsmeldung an.

    Belanglose Meldungen werden nach kurzer Zeit ausgeblendet.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Nachricht Zeichenfolge Meldung, die angezeigt werden soll.
    Tabelle : 6. Ergebnisse
    Typ Beschreibung
    void 
    spUtil.addTrivialMessage("Thanks for your order")

    spUtil - createUid ( )

    Erstellen Sie einen eindeutigen Bezeichner.

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Eine eindeutige ID mit 32 Zeichen.

    spUtil – get(String widgetId Object data)

    Bettet ein Widget-Modell in ein Widget-Client-Skript ein.

    Die Rückruffunktion gibt das vollständige Widget-Modell zurück. Weitere Informationen zu Widgets finden Sie unter Serviceportal-Widgets.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    widgetId Zeichenfolge Widget-ID oder sys_id des einzubettenden Widgets.
    data Objekt Optional. Name/Wert-Paare von Parametern, die an das Widget-Modell übergeben werden sollen.
    Tabelle : 10. Ergebnisse
    Typ Beschreibung
    Objekt Modell des eingebetteten Widgets.

    Ohne übergebene Daten.

    spUtil.get("widget-cool-clock").then(function(response) {
  c.coolClock = response;
});

    Mit übergebenen Daten.

    spUtil.get('pps-list-modal', {title: c.data.editAllocations, 
  table: 'resource_allocation', 
  queryString: 'GROUPBYuser^resource_plan=' + c.data.sysId, 
  view: 'resource_portal_allocations' }).then(function(response) {
    var formModal = response;
    c.allocationListModal = response;
  });

    spUtil - getHeaders ( )

    Ruft alle Header ab, die für API-Aufrufe verwendet werden sollen.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 12. Ergebnisse
    Typ Beschreibung
    Objekt Alle für API-Aufrufe zu verwendenden Header.

    spUtil - getHost ( )

    Gibt die vollständige Hostdomäne zurück.

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Zum Beispiel die komplette Host-Domain hi.servicenow.com

    spUtil - getPreference (String-Voreinstellung, Funktionsrückruf)

    Führt den Rückruf mit der Antwort auf die Anwendereinstellung aus, indem der Einstellungsname übergeben wird.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    Voreinstellung Zeichenfolge Name der Einstellung.
    Rückruf Funktion Definieren Sie die Rückruffunktion.
    Tabelle : 16. Ergebnisse
    Typ Beschreibung
    void

    spUtil - getURL ( )

    Gibt die aktuellen Serviceportal-URL-Informationen zurück.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 18. Ergebnisse
    Typ Beschreibung
    Zeichenfolge URL des aktuellen Serviceportals.

    spUtil – format(String template, Object data)

    Formatiert eine Zeichenfolge, die Variablen enthält.

    Verwenden Sie diese Methode als Alternative zur Zeichenfolgenverkettung.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    template Zeichenfolge Zeichenfolgenvorlage, die Werte für die Variablenersetzung enthält.
    Daten Objekt Objekt mit den Werten für die in der Vorlagenzeichenfolge definierten Variablen.
    Tabelle : 20. Ergebnisse
    Typ Beschreibung
    Zeichenfolge Zeichenfolge, die die Variablenwerte anstelle der Variablennomenklatur enthält. 
    spUtil.format('An error ocurred: {error} when loading {widget}', {error: '404', widget: 'sp-widget'})

    Ausgabe:

    'An error occurred: 404 when loading sp-widget'

    spUtil - isMobile ( )

    Überprüft, ob der aktuelle Client ein Mobilgerät ist.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 22. Ergebnisse
    Typ Beschreibung
    Boolean Kennzeichnung, die angibt, ob der aktuelle Client ein Mobilgerät ist.
    Gültige Werte:
    • „wahr“: Der aktuelle Client ist ein Mobilgerät.
    • „falsch“: Der aktuelle Client ist kein Mobilgerät.

    spUtil - parseAttributes (String-Attribute)

    Analysiert die durch Kommas getrennten Attribute innerhalb einer angegebenen Zeichenfolge.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    attributes Zeichenfolge Zeichenfolge, die durch Kommas getrennte Attribute enthält, wie z. B. das Attribute-Feld eines Dictionarysatzes.
    Tabelle : 24. Ergebnisse
    Typ Beschreibung
    Array Array von Objekten mit den analysierten Attributen. 
    function getRefQualElements() {
  var refQualElements = [];
  if (field && field.attributes && field.attributes.indexOf('ref_qual_elements') > -1) {
    var attributes = spUtil.parseAttributes(field.attributes);
    refQualElements = attributes['ref_qual_elements'].split(';');
  }
  return refQualElements;
}

    spUtil – recordWatch(Object $scope, String table, String filter, Function callback)

    Sucht nach Aktualisierungen für eine Tabelle oder einen Filter und gibt den Wert der Rückruffunktion zurück.

    Ermöglicht einem Widget-Entwickler, in Echtzeit auf Tabellenaktualisierungen zu reagieren. Zum Beispiel kann das Widget „Einfache Liste“ mit recordWatch() Änderungen an seiner Datentabelle überwachen. Wenn Datensätze hinzugefügt, entfernt oder aktualisiert werden, wird das Widget automatisch aktualisiert.

    Hinweis:
    Wenn Sie das Argument „ $scope “ an die Funktion „recordWatch()“ übergeben, fügen Sie „ $scope “ in die Parameter Ihrer Client-Skriptfunktion ein.
    Tabelle : 25. Parameter
    Name Typ Beschreibung
    $scope Objekt Umfang des Datenobjekts, das von der Rückruffunktion aktualisiert wird.
    Tabelle Zeichenfolge Beobachtete Tabelle.
    filter Zeichenfolge Filter für zu beobachtende Felder.
    callback Funktion Optional. Parameter zum Definieren der Rückruffunktion.
    Tabelle : 26. Ergebnisse
    Typ Beschreibung
    Zusage Rückgabewert der Rückruffunktion. 
    //A simple recordWatch function.
spUtil.recordWatch($scope, "live_profile", "sys_id=" + liveProfileId);

//In a widget client script
function(spUtil, $scope) {
  /* widget controller */
  var c =this;

  // Registers a listener on the incident table with the filter active=true, 
  // meaning that whenever something changes on that table with that filter, 
  // the callback function is executed.    
  // The callback function takes a single parameter 'response', which contains 
  // the property 'data'. The 'data' property contains information about the changed record. 
  spUtil.recordWatch($scope, "incident", "active=true", function(response) {
        
    // Returns the data inserted or updated on the table 
    console.log(response.data);   
    
    });
}

    spUtil – refresh(Object $scope)

    Ruft den Server auf und ersetzt die aktuellen Optionen und Daten durch die Serverantwort.

    Das Aufrufen von spUtil.refresh() ähnelt dem Aufrufen von server.refresh(). Wenn Sie allerdings spUtil.refresh() aufrufen, können Sie das Objekt „$scope“ definieren.

    Tabelle : 27. Parameter
    Name Typ Beschreibung
    $scope Objekt Für das Update definierter Bereich.
    Tabelle : 28. Ergebnisse
    Typ Beschreibung
    Objekt Aktualisierte Optionen und Datenobjekte.

    spUtil - scrollTo (String-Selektor, Nummer Zeit)

    Scrollt zu dem Element mit der angegebenen Auswahl über einen angegebenen Zeitraum.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    selector Zeichenfolge Auswahl, zu der gescrollt werden soll.
    Zeitreihendiagramm Nummer Zeit, die zum Scrollen zur angegebenen Auswahl benötigt wird.

    Einheit: Millisekunden
    Tabelle : 30. Ergebnisse
    Typ Beschreibung
    void

    spUtil - setBreadCrumb(Object $scope, Array Breadcrumbs)

    Aktualisiert die Header-Breadcrumbs.

    Tabelle : 31. Parameter
    Name Typ Beschreibung
    $scope Objekt Für die Tabelle definierter Bereich.
    Breadcrumbs Array Bedingungen, die zum Erstellen des Breadcrumb-Filters verwendet werden.
    Tabelle : 32. Ergebnisse
    Typ Beschreibung
    void

    spUtil – setPreference(Zeichenfolgenvoreinstellung, Zeichenfolgenwert)

    Legt eine Anwendereinstellung fest.

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    Voreinstellung Zeichenfolge Einstellungsname
    Wert Zeichenfolge Einstellungswert
    Tabelle : 34. Ergebnisse
    Typ Beschreibung
    void

    spUtil - setSearchPage (String searchPage)

    Aktualisiert die Suchseite.

    Tabelle : 35. Parameter
    Name Typ Beschreibung
    Suchseite Zeichenfolge Name der Suchseite.
    Tabelle : 36. Ergebnisse
    Typ Beschreibung
    void

    spUtil – update(Object $scope)

    Aktualisiert das Datenobjekt auf dem Server innerhalb eines bestimmten Bereichs.

    Diese Methode ähnelt server.update(), enthält jedoch einen Parameter „$scope“, der den zu übergebenden Bereich definiert.

    Tabelle : 37. Parameter
    Name Typ Beschreibung
    $scope Objekt Für das Update definierter Bereich.
    Tabelle : 38. Ergebnisse
    Typ Beschreibung
    Objekt Aktualisiertes Datenobjekt.

    Das folgende Beispiel enthält ein P1-Widget, das nach Änderungen am Statusfeld sucht und einen Filter verwendet, um alle aktiven P1s zu überwachen und die Rückruffunktion bestimmen zu lassen, ob die Daten aktualisiert werden sollen. Die Eigenschaft data.changes enthält ein Array von beliebigen aktualisierten Feldern. Wenn sich der Status eines Felds geändert hat, werden die Daten im Widget aktualisiert.

    var q = "priority=1^active=true^EQ";
spUtil.recordWatch($scope, "incident", q, function(event, data) {
   if (data.changes.includes("state")) { // only update if state was updated.
      spUtil.update($scope);
   }
});