SpUtil – Client

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 6 Minuten Lesedauer

    • Die SpUtil Die API stellt Dienstprogrammmethoden zur Ausführung allgemeiner Funktionen in bereit ServiceportalWidget-Client-Skript.

    Diese Funktionen umfassen:

    Weitere Informationen zu Widgets finden Sie unter Serviceportal-Widgets .

    SpUtil – addErrorMessage(Zeichenfolgennachricht)

    Zeigt eine Benachrichtigungsfehlermeldung an.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Nachricht Zeichenfolge Anzuzeigende Fehlermeldung.
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    Ungültig 
    spUtil.addErrorMessage("There has been an error processing your request")

    SpUtil – addInfoMessage(Zeichenfolgennachricht)

    Zeigt eine Benachrichtigungsinformationsnachricht an.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Nachricht Zeichenfolge Anzuzeigende Nachricht.
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Ungültig 
    spUtil.addInfoMessage("Your order has been placed")

    SpUtil – addTrivialMessage(Zeichenfolgennachricht)

    Zeigt eine geringfügige Benachrichtigungsnachricht an.

    Geringfügige Nachrichten werden nach kurzer Zeit ausgeblendet.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Nachricht Zeichenfolge Anzuzeigende Nachricht.
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Ungültig 
    spUtil.addTrivialMessage("Thanks for your order")

    SpUtil – createUid()

    Erstellen Sie ein Eindeutiger Bezeichner .

    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Zeichenfolge Eine eindeutige 32-Zeichen-ID.

    SpUtil – GET(Zeichenfolgen-Widget-ID-Objektdaten)

    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.
    Daten Objekt Optional. Name/Wert-Paare von Parametern, die an das Widget-Modell übergeben werden sollen.
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Objekt Modell des eingebetteten Widgets.

    Ohne Daten übergeben.

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

    Mit Daten übergeben.

    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. Rückgaben
    Typ Beschreibung
    Objekt Alle Header, die für API-Aufrufe verwendet werden sollen.

    SpUtil – getHost()

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

    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Rückgaben
    Typ Beschreibung
    Zeichenfolge Beispielsweise die vollständige Hostdomäne hi.servicenow.com

    SpUtil – getPreference(Zeichenfolgeneinstellung, Funktionsrückruf)

    Führt den Rückruf mit Anwendervoreinstellungsantwort durch Übergabe des Einstellungsnamens aus.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    Einstellung Zeichenfolge Name der Einstellung.
    Rückruf Funktion Definieren Sie die Rückruffunktion.
    Tabelle : 16. Rückgaben
    Typ Beschreibung
    Ungültig

    SpUtil – getUrl()

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

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 18. Rückgaben
    Typ Beschreibung
    Zeichenfolge Aktuelle Serviceportal-URL.

    SpUtil – Format (Zeichenfolgenvorlage, Objektdaten)

    Formatiert eine Zeichenfolge, die Variablen enthält.

    Verwenden Sie diese Methode als Alternative zur Zeichenfolgenverkettung.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    Vorlage Zeichenfolge Zeichenfolgenvorlage, die Werte für die Variablenersetzung enthält.
    Daten Objekt Objekt, das die Werte für die in der Vorlagenzeichenfolge definierten Variablen enthält.
    Tabelle : 20. Rückgaben
    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. Rückgaben
    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(Zeichenfolgenattribute)

    Analysiert die kommagetrennten Attribute innerhalb einer angegebenen Zeichenfolge.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    attributes Zeichenfolge Zeichenfolge mit kommagetrennten Attributen, z. B. Attribute Feld eines Wörterbuchdatensatzes.
    Tabelle : 24. Rückgaben
    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(Objekt $scope, Zeichenfolgentabelle, Zeichenfolgenfilter, Funktionsrückruf)

    Überwacht auf Aktualisierungen an einer Tabelle oder einem Filter und gibt den Wert aus der Rückruffunktion zurück.

    Ermöglicht einem Widget-Entwickler, in Echtzeit auf Tabellenaktualisierungen zu reagieren. Beispiel: Durch Record Watch() , Das Widget „einfache Liste“ kann auf Änderungen an seiner Datentabelle achten. Wenn Datensätze hinzugefügt, entfernt oder aktualisiert werden, wird das Widget automatisch aktualisiert.

    Hinweis:
    Beim Übergeben von $Umfang Argument in Record Watch() Funktion, einfügen $Umfang In die Parameter Ihrer Client-Skriptfunktion.
    Tabelle : 25. Parameter
    Name Typ Beschreibung
    $scope Objekt Umfang des Datenobjekts, das von der Rückruffunktion aktualisiert wurde.
    table Zeichenfolge Beobachtete Tabelle.
    Filter Zeichenfolge Nach zu überwachenden Feldern filtern.
    Rückruf Funktion Optional. Parameter zum Definieren der Rückruffunktion.
    Tabelle : 26. Rückgaben
    Typ Beschreibung
    Versprechen 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 den aktuellen Optionen Und Daten Mit der Serverantwort.

    Wird Aufgerufen SpUtil.refresh() Ähnelt dem Anruf Server.REFRESH() . Wenn Sie jedoch anrufen SpUtil.refresh() , Sie können das Objekt $scope definieren.

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

    SpUtil – scrollTo (Zeichenfolgenauswahl, Zahlenzeit)

    Scrollt über einen angegebenen Zeitraum zum Element mit der angegebenen Auswahl.

    Tabelle : 29. Parameter
    Name Typ Beschreibung
    Auswahl Zeichenfolge Auswahl, zu der gescrollt werden soll.
    Zeitreihendiagramm Nummer Zeit, die benötigt wurde, um zur angegebenen Auswahl zu scrollen.

    Einheit: Millisekunden
    Tabelle : 30. Rückgaben
    Typ Beschreibung
    Ungültig

    SpUtil – setBreadCrumb(Objekt $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. Rückgaben
    Typ Beschreibung
    Ungültig

    SpUtil – setPreference(Zeichenfolgenpräf, Zeichenfolgenwert)

    Legt eine Anwendereinstellung fest.

    Tabelle : 33. Parameter
    Name Typ Beschreibung
    präf Zeichenfolge Einstellungsname
    Wert Zeichenfolge Einstellungswert
    Tabelle : 34. Rückgaben
    Typ Beschreibung
    Ungültig

    SpUtil – setSearchPage(Zeichenfolge searchPage)

    Aktualisiert die Suchseite.

    Tabelle : 35. Parameter
    Name Typ Beschreibung
    SearchPage Zeichenfolge Name der Suchseite.
    Tabelle : 36. Rückgaben
    Typ Beschreibung
    Ungültig

    SpUtil – Update(Object $scope)

    Aktualisiert das Datenobjekt auf dem Server innerhalb eines bestimmten Bereichs.

    Diese Methode ist ähnlich wie Server.Update() , Enthält aber einen $scope-Parameter, der den zu übergebenden Bereich definiert.

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

    Das folgende Beispiel enthält ein P1-Widget, das nach Änderungen am Statusfeld überwacht und einen Filter verwendet, um alle aktiven P1s zu überwachen und die Rückruffunktion bestimmen zu lassen, ob die Daten aktualisiert werden sollen. Die data.changesEigenschaft enthält ein Array aller aktualisierten Felder. 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);
   }
});