Client-Skript-API – ServiceNow Fluent

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 2 Minuten Lesedauer
  • Die Client Script API enthält Objekte, die Client-Skripts [sys_script_client] definieren, die JavaScript auf dem Client (Webbrowser) ausführen, wenn clientbasierte Ereignisse eintreten, z. B. beim Laden eines Formulars, nach der Formularübermittlung oder wenn ein Feld den Wert ändert.

    ClientScript-Objekt

    Erstellen Sie ein Client-Skript [sys_script_client], um Formulare, Formularfelder und Feldwerte zu konfigurieren, während der Benutzer das Formular verwendet.

    Tabelle : 1. Eigenschaften
    Name Typ Beschreibung
    $id Zeichenfolge oder Zahl Erforderlich. Eine eindeutige ID für das Metadatenobjekt, die im folgenden Format bereitgestellt wird: wobei<value> ist eine Zeichenfolge oder Zahl.
    $id: Now.ID[<value>]

    Wenn Sie die Anwendung erstellen, wird diese ID in eine eindeutige sys_ID gehasht.

    table Zeichenfolge Erforderlich. Der Name der Tabelle, für die 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

    anwenden_erweitert Boolean Kennzeichnung, die angibt, ob das Client-Skript 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

    ui_type Zeichenfolge Die Anwenderoberfläche, für die das Client-Skript gilt.

    Gültige Werte: „desktop“, „mobile_or_service_portal“, „all“.

    Standard: Desktop

    description Zeichenfolge Eine Beschreibung der Funktionalität und des Zwecks des Client-Skripts.
    Nachrichten Zeichenfolge Textzeichenfolgen, die für das Client-Skript als lokalisierte Nachrichten mithilfe von getmessage('[message]')verfügbar sind. Weitere Informationen finden Sie unter Client-Skript-Nachrichten übersetzen.
    isolieren_skript Boolean Kennzeichnung, die angibt, ob Skripts im strikten Modus mit deaktiviertem Zugriff auf direktes DOM, jQuery, Prototypen und das Fensterobjekt ausgeführt werden.
    Gültige Werte:
    • „wahr“: Skript isolieren und nicht im strikten Modus ausführen.
    • „falsch“: führt das Skript im strikten Modus aus.

    Standardwert: false

    Skript Skript Ein Inline-Skript, dem ein Skript- Tag im folgenden Format vorangestellt wird:
    script: script`gs.info('info')`,
    Hinweis:
    Das Importieren von Funktionen aus JavaScript-Modulen oder Drittanbieterbibliotheken wird in Client-Skripts nicht unterstützt.
    global Boolean Kennzeichnung, die angibt, in welchen 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, für die das Client-Skript ausgeführt wird. Diese Eigenschaft gilt nur, wenn die globale Eigenschaft auf „falsch“ festgelegt ist.
    Typ Zeichenfolge Der Typ des Client-Skripts, der definiert, wann es ausgeführt wird. Informationen zu den unterstützten Typen finden Sie unter Client scripts.

    Gültige Werte: onCellEdit, onChange, onLoad, onSubmit

    Feld Zeichenfolge Ein Feld in der Tabelle, auf das das Client-Skript anwendet. Diese Eigenschaft gilt nur, wenn die Typeigenschaft auf onChange oder onCellEdit festgelegt ist.
    import { ClientScript } from '@servicenow/sdk/core'
    
    export const cs = ClientScript({
       $id: Now.ID['my_scripts'], 
       name: 'my_scripts',
       table: 'incident',
       active: true, 
       applies_extended: false, 
       global: true,
       ui_type: 'all', 
       messages: '', 
       isolate_script: false, 
       type: 'onLoad',
       script: script`function onLoad() { const x = 'util' g_form.addInfoMessage(x) }`,
    })