Client-Skript-API – ServiceNow Fluent

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 3 Minuten Lesedauer

    • Die Clientskript-API definiert clientseitige Skripts [sys_script_Client], die JavaScript auf dem Client (Webbrowser) ausführen, wenn clientbasierte Ereignisse auftreten, z. B. wenn ein Formular geladen wird, nach der Formularübermittlung oder wenn ein Feld den Wert ändert.

    Allgemeine Informationen zu Client-Skripts finden Sie unter Client scripts.

    ClientScript-Objekt

    Erstellen Sie ein Clientskript [sys_script_Client], um Formulare, Formularfelder und Feldwerte zu konfigurieren, während der Anwender das Formular verwendet.

    Tabelle : 1. Eigenschaften
    Name Typ Beschreibung
    $ID Zeichenfolge oder Zahl Erforderlich. Eine eindeutige ID für das Metadatenobjekt. Wenn Sie die Anwendung erstellen, wird diese ID in eine eindeutige sys_ID gehasht Weitere Informationen finden Sie unter ServiceNow Fluent Sprachkonstrukte.

    Format: Now.ID['Zeichenfolge' oder Zahl]

    table Zeichenfolge Erforderlich. Der Name der Tabelle, in der das Client-Skript ausgeführt wird.
    Name Zeichenfolge Erforderlich. Der Name des Client-Skripts.
    aktiv Boolean Kennzeichnung, die angibt, ob das Client-Skript aktiviert ist.
    Gültige Werte:
    • Wahr: Das Skript ist aktiviert.
    • Falsch: Das Skript ist nicht aktiviert.

    Standardwert: wahr
    AnwendungErweitert Boolean Kennzeichnung, die angibt, ob das Clientskript für Tabellen gilt, die aus der angegebenen Tabelle erweitert wurden.
    Gültige Werte:
    • Wahr: Das Skript gilt für erweiterte Tabellen.
    • Falsch: Das Skript gilt nicht für erweiterte Tabellen.

    Standardwert: false
    UiType Zeichenfolge Die Anwenderoberfläche, für die das Client-Skript gilt.
    Gültige Werte:
    • desktop
    • Mobile_oder_Service_Portal
    • alle

    Standard: Desktop
    Beschreibung Zeichenfolge Eine Beschreibung der Funktionalität und des Zwecks des Client-Skripts.
    Nachrichten Zeichenfolge Textzeichenfolgen, die für das Client-Skript als lokalisierte Nachrichten mit verfügbar sind Getmessage(„[message]“) . Weitere Informationen finden Sie unter Übersetzen Sie eine Client-Skriptnachricht .
    IsolateScript Boolean Kennzeichnung, die angibt, ob das Skript im strikten Modus ausgeführt wird, wobei der Zugriff auf direktes DOM, jQuery, Prototyp und das Fensterobjekt deaktiviert ist.
    Gültige Werte:
    • Wahr: Isolieren Sie das Skript, und führen Sie es nicht im strikten Modus aus.
    • Falsch: Führen Sie das Skript im strikten Modus aus.

    Standardwert: false
    Skript Skript Ein clientseitiges Skript, das im Browser ausgeführt wird. Diese Eigenschaft unterstützt Inline-JavaScript oder einen Verweis auf eine andere Datei in der Anwendung, die ein Skript enthält.
    Format:
    • Informationen zur Verwendung von Textinhalten aus einer anderen Datei finden Sie in einer Datei in der Anwendung im folgenden Format: Now.include('path/to/file') . Weitere Informationen finden Sie unter ServiceNow Fluent Sprachkonstrukte.
    • Um ein Inline-Skript bereitzustellen, verwenden Sie Zeichenfolgenliterale oder Vorlagenliterale für mehrere Codezeilen: „Skript“ oder „Skript“ .
    global Boolean Kennzeichnung, die angibt, für welche Ansichten der Tabelle das Client-Skript ausgeführt wird.
    Gültige Werte:
    • Wahr: Das Skript wird für alle Ansichten ausgeführt.
    • Falsch: Das Skript wird nur für die angegebenen Ansichten ausgeführt.

    Standardwert: wahr
    Ansicht Zeichenfolge Die Ansichten der Tabelle, in der das Client-Skript ausgeführt wird. Diese Eigenschaft gilt nur, wenn Global Eigenschaft ist auf „falsch“ festgelegt.
    Typ Zeichenfolge Der Typ des Client-Skripts, das definiert, wann es ausgeführt wird. Weitere Informationen zu den unterstützten Typen finden Sie unter Client scripts.
    Gültige Werte:
    • OnCellEdit: Wird ausgeführt, wenn der Listeneditor einen Zellenwert ändert.
    • OnChange: Wird ausgeführt, wenn sich ein bestimmter Feldwert im Formular ändert.
    • ONLOAD: Wird ausgeführt, wenn das System das Formular zuerst rendert und bevor Anwender Daten eingeben können. In der Regel nehmen Client-Skripts des Typs onLoad() clientseitige Änderungen am aktuellen Formular vor oder legen standardmäßige Datensatzwerte fest.
    • OnSubmit: Wird ausgeführt, wenn ein Formular übermittelt wird. In der Regel validieren Client-Skripts des Typs onSubmit() Angaben im Formular und stellen sicher, dass die übermittelten Daten Sinn ergeben. Ein Client-Skript des Typs onSubmit() kann die Übermittlung eines Formulars abbrechen, wenn „false“ als Wert zurückgegeben wird.
    Ausstehend Zeichenfolge Ein Feld in der Tabelle, für das das Client-Skript gilt. Diese Eigenschaft gilt nur, wenn Typ Eigenschaft ist auf onChange oder onCellEdit festgelegt.
    $Meta Objekt Metadaten für die Anwendungsmetadaten.
    Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird.
    $meta: {
      installMethod: 'String'
}
    Gültige Werte für InstallMethod :
    • Demo: Gibt die Anwendungsmetadaten an aus Metadaten/unload.demo Verzeichnis, das mit der Anwendung installiert werden soll, wenn Demodaten laden Option ist ausgewählt.
    • Erste Installation: Gibt die Anwendungsmetadaten an aus Metadaten/Entladen Verzeichnis, das nur bei der ersten Installation einer Anwendung auf einer Instanz installiert werden soll.
    		 
    import { ClientScript } from '@servicenow/sdk/core'

export const cs = ClientScript({
   $id: Now.ID['my_scripts'], 
   name: 'my_scripts',
   table: 'incident',
   active: true, 
   appliesExtended: false, 
   global: true,
   uiType: 'all', 
   messages: '', 
   isolateScript: false, 
   type: 'onLoad',
   script: Now.include('../client/client-script.js'),
})
    Das Client-Skript ist in definiert Client-script.js Datei, auf die verwiesen wird von Skript Eigenschaft. Zum Beispiel:
    function onLoad() { 
    const x = 'util' g_form.addInfoMessage(x) 
}