UI-Richtlinie API – ServiceNow Fluent

  • Freigeben Version: Zurich
  • Aktualisiert 19. Dezember 2025
  • 7 Minuten Lesedauer

    • Die UI-Richtlinien-API definiert Anwenderoberflächenrichtlinien (UI) [ sys_ui_Policy ], die das Verhalten von Informationen in einem Formular dynamisch ändern und anwenderdefinierte Prozess-Flows für Aufgaben steuern.

    UI-Richtlinien können Felder obligatorisch, schreibgeschützt, sichtbar, ausgeblendet oder gelöscht machen, wenn bestimmte Bedingungen erfüllt sind. Sie können auch Client-Skripts verwenden, um alle diese Aktionen auszuführen. Verwenden Sie für kürzere Ladezeiten jedoch nach Möglichkeit UI-Richtlinien.

    Allgemeine Informationen zu UI-Richtlinien finden Sie unter Using UI policies.

    UiPolice Objekt

    Erstellen Sie eine UI-Richtlinie sys_ui_Policy Dient zum Konfigurieren des Formularverhaltens.

    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. Die Tabelle des zu ändernden Formulars.
    shortDescription Zeichenfolge Erforderlich. Eine Beschreibung der Richtlinie und ihres Zwecks.
    aktiv Boolean Kennzeichnung, die angibt, ob die Richtlinie auf das Formular angewendet wird.

    Standardwert: wahr
    global Boolean

    Kennzeichnung, die angibt, ob für welche Formularansichten die Richtlinie gilt. Bei „wahr“ gilt die Richtlinie für alle Ansichten der Tabelle. Bei „falsch“ ist die Richtlinie spezifisch für die mit angegebene Formularansicht Ansicht Eigenschaft.

    Standardwert: wahr
    onLoad Boolean Kennzeichnung, die angibt, wann die Richtlinie ausgeführt wird. Bei „wahr“ wird die Richtlinie jedes Mal ausgeführt, wenn ein Formular geladen wird, wenn die Bedingungen erfüllt sind.

    Standardwert: wahr
    Umkehren IfFalse Boolean Kennzeichnung, die angibt, ob das Richtlinienverhalten umgekehrt werden soll, wenn die Bedingung als „falsch“ ausgewertet wird. Bei „wahr“ wird die Richtlinienaktion rückgängig gemacht, wenn die Bedingungen ihrer Richtlinie als „falsch“ ausgewertet werden.

    Standardwert: wahr
    Übernahme Boolean Kennzeichnung, die angibt, ob Tabellen, die die aktuelle Tabelle erweitern, die Richtlinie erben. Bei „wahr“ übernehmen erweiterte Tabellen die Richtlinie.

    Wenn eine untergeordnete Tabelle über eine geerbte Richtlinie aus ihrer übergeordneten Tabelle verfügt, wird die Richtlinie für die untergeordnete Tabelle zuerst ausgeführt. Dieses Ereignis ist unabhängig von der Reihenfolge der Richtlinien „wahr“.

    Standardwert: false
    IsolateScript Boolean Kennzeichnung, die angibt, ob Skripts im isolierten Bereich ausgeführt werden sollen. Bei „wahr“ wird das Skript im isolierten Bereich ausgeführt. Diese Eigenschaft gilt nur, wenn Skripts ausführen Ist auf „wahr“ festgelegt.

    Standardwert: false
    Bedingungen Zeichenfolge Eine Filterabfrage, die die Felder und Werte angibt, die „wahr“ sein müssen, damit Anwender auf das Objekt zugreifen können. Weitere Informationen finden Sie unter Operators available for filters and queries. Um Bedingungen mithilfe eines Skripts festzulegen, verwenden Sie stattdessen ein Client-Skript.

    Bedingungen werden nur erneut überprüft, wenn ein Anwender ein Feld in einem Formular manuell ändert. Wenn die Änderung durch eine UI-Aktion, eine Kontextmenüaktion oder über den Listeneditor vorgenommen wird, wird sie nicht ausgewertet.
    Skripts ausführen Boolean Kennzeichnung, die angibt, ob erweitertes Verhalten sowohl für die Bedingungen „wahr“ als auch „falsch“ geskriptet werden kann. Bei „wahr“ werden Skripts definiert, die mit definiert sind Skriptwahr , Skriptfalsch , UiType , Und IsolateScript Eigenschaften werden ausgeführt, falls zutreffend.

    Standardwert: false
    Skriptwahr Zeichenfolge Clientseitiges Skript, das ausgeführt wird, wenn die Bedingungen der Richtlinie erfüllt sind. Diese Eigenschaft ist erforderlich, wenn Skripts ausführen Eigenschaft ist auf „wahr“ festgelegt.

    Format: Funktion onCondition() {}

    Standard: Funktion onCondition() {\n\n}

    Skriptfalsch Zeichenfolge Clientseitiges Skript, das ausgeführt wird, wenn die Bedingungen der Richtlinie und des nicht erfüllt sind Umkehren IfFalse Eigenschaft ist auf „wahr“ festgelegt. Diese Eigenschaft ist erforderlich, wenn Skripts ausführen Eigenschaft ist auf „wahr“ festgelegt.

    Format: Funktion onCondition() {}

    Standard: Funktion onCondition() {\n\n}

    UiType Zeichenfolge Der Typ der Anwenderoberfläche, für die die Richtlinie gilt. Diese Eigenschaft ist erforderlich, wenn Skripts ausführen Eigenschaft ist auf „wahr“ festgelegt.
    Gültige Werte:
    • Desktop: Die Richtlinie gilt für Desktop-Schnittstellen.
    • Mobile-or-Serviceportal: Die Richtlinie gilt für mobile und ServiceportalSchnittstellen.
    • Alle: Die Richtlinie gilt für alle Schnittstellen.

    Standard: Desktop
    actions Array Eine Liste von Feldaktionen, die angewendet werden sollen, wenn die Bedingungen erfüllt sind. Weitere Informationen finden Sie unter Aktionen Array.
    RelatedListActions Array Eine Liste von Sichtbarkeitssteuerungen für zugehörige Listen. Weitere Informationen finden Sie unter RelatedListActions Array.
    Beschreibung Zeichenfolge Zusätzliche Informationen zur Richtlinie.
    modelId Zeichenfolge Die sys_ID der übergeordneten UI-Richtlinie, für die die Richtlinie gilt, wenn diese Richtlinie geerbt wird. Diese Eigenschaft funktioniert in Verbindung mit Model_table Eigenschaft.
    modelTable Zeichenfolge Der Name der übergeordneten Tabelle, für die die Richtlinie gilt, wenn eine UI-Richtlinie von einer übergeordneten Tabelle geerbt wird. Diese Eigenschaft funktioniert in Verbindung mit Model_ID Eigenschaft.
    Reihenfolge Nummer Die Ausführungsreihenfolge, in der Richtlinien angewendet werden, wenn mehr als eine Richtlinie den Bedingungen entspricht.

    Für geerbte UI-Richtlinien werden die Richtlinien der erweiterten Tabelle zuerst ausgeführt. Dann werden die Basistabellenrichtlinien ausgeführt.

    Standard: 100
    SetValues Zeichenfolge (Veraltet) die Feldwerte, die mit einem codierten Zeichenfolgenformat festgelegt werden sollen. Verwenden Sie stattdessen UI-Richtlinienaktionen [sys_ui_Policy_action].
    Ansicht Referenz oder Zeichenfolge Erforderlich. Der Variablenbezeichner oder Name der zutreffenden UI-Ansicht [sys_ui_View] oder der Standardansicht.

    Informationen zum Definieren einer UI-Ansicht finden Sie unter Datensatz-API – ServiceNow Fluent.

    Dient zur Verwendung der Standardansicht ( Default_View ), müssen Sie Folgendes importieren:
    import { default_view } from '@servicenow/sdk/core'
    		 
    import { UiPolicy } from '@servicenow/sdk/core';

export const securityIncidentPolicy = UiPolicy({
  $id: Now.ID['security_incident_policy'],
  table: 'incident',
  shortDescription: 'Lock critical fields for security incidents',
  active: true,
  onLoad: true,
  conditions: 'category="security"',
  actions: [
    {
      field: 'security_notes',
      mandatory: true,
      visible: true
    },
    {
      field: 'caller_id',
      readOnly: true  // Lock caller field when category is security
    },
    {
      field: 'assignment_group',
      readOnly: true  // Lock assignment group when category is security
    },
    {
      field: 'priority',
      readOnly: true  // Lock priority when category is security
    }
  ],
  relatedListActions: [
    {
      // Using plain GUID for system relationships 
      list: 'b9edf0ca0a0a0b010035de2d6b579a03', // Attachments
      visible: false
    },
    {
      // Using table.field format for reference fields
      list: 'x_snc_17sepapp1_expenseitem.expensereport', // Example reference field
      visible: true
    }
  ]
})

    Aktionen Array

    Konfigurieren Sie die Aktionen [sys_ui_Policy_action], die die UI-Richtlinie für Felder ausführt.

    Verwenden Sie Aktionen Array in UiPolice Objekt. Aktionen werden in der Reihenfolge verarbeitet, in der sie im Array angezeigt werden. Mindestens einer der Sichtbar , Schreibgeschützt , Obligatorisch , Oder Gelöscht Eigenschaften müssen für jede Aktion im Array angegeben werden.

    Tabelle : 2. Eigenschaften
    Name Typ Beschreibung
    field Zeichenfolge Erforderlich. Der Name des Felds, für das die Aktion gilt.
    Hinweis:
    Wenn das angegebene Feld im Formular nicht gefunden wird, führt die UI-Richtlinie die Aktion für die Variable mit demselben Namen aus.
    Sichtbar Boolescher Wert oder Zeichenfolge Eine Option zum Steuern der Sichtbarkeit des Felds.
    Gültige Werte:
    • Wahr: Das Feld ist sichtbar.
    • Falsch: Das Feld ist ausgeblendet.
    • „Ignorieren“: Das Feld wurde nicht geändert.

    Standard: Ignorieren
    Monatlich Boolescher Wert oder Zeichenfolge Eine Option zum Steuern des Zugriffs zum Bearbeiten des Felds.
    Gültige Werte:
    • Wahr: Das Feld ist schreibgeschützt.
    • Falsch: Das Feld kann bearbeitet werden.
    • „Ignorieren“: Das Feld wurde nicht geändert.

    Standard: Ignorieren
    Obligatorisch Boolescher Wert oder Zeichenfolge Eine Option, um zu steuern, ob das Feld erforderlich ist.
    Gültige Werte:
    • Wahr: Das Feld ist erforderlich.
    • Falsch: Das Feld ist optional.
    • „Ignorieren“: Das Feld wurde nicht geändert.

    Standard: Ignorieren
    Gelöscht Boolean Kennzeichnung, die angibt, ob das Feld gelöscht werden soll, wenn die Bedingungen der Richtlinie erfüllt sind.

    Standardwert: false
    Tabelle Zeichenfolge Die Tabelle, für die die Aktion gilt, die die in der Richtlinie angegebene Tabelle überschreibt. Wenn leer, gilt die in der Richtlinie angegebene Tabelle.
    Wert Zeichenfolge Der Wert, auf den das Feld festgelegt werden soll, wenn die Richtlinienbedingungen erfüllt sind.
    FieldMessage Zeichenfolge Eine Nachricht, die über das Feld angezeigt werden soll, wenn die Richtlinienbedingungen erfüllt sind.
    FieldMessageType Zeichenfolge Ein Nachrichtentyp, der bestimmt, wie die Feldnachricht angezeigt wird.
    Gültige Werte:
    • Fehler
    • Info
    • Warnung
    • Keine

    Standard: keiner
    WertAktion Zeichenfolge Eine Aktion, die für den Feldwert ausgeführt werden soll.
    Gültige Werte:
    • Legen Sie_Wert fest
    • Clear_value
    • Ignorieren

    Standard: Ignorieren

    		 
    actions: [
        {
            field: 'assignment_group',
            mandatory: true,
            value: 'Critical Response Team', // Set default value
            fieldMessage: 'This incident requires immediate attention from the Critical Response Team',
            fieldMessageType: 'error' // Show as error message
        },
        {
            field: 'urgency',
            value: '1', // Set to High urgency
            fieldMessage: 'Urgency has been automatically set to High',
            fieldMessageType: 'info'
        },
        {
            field: 'impact',
            value: '1', // Set to High impact
            fieldMessage: 'Impact has been automatically set to High',
            fieldMessageType: 'warning'
        }
    ]

    RelatedListActions Array

    Konfigurieren Sie die Sichtbarkeit zugehöriger Listen [sys_ui_Policy_rl_action] in einem Formular für eine UI-Richtlinie.

    Verwenden Sie RelatedListActions Array in UiPolice Objekt. Aktionen der zugehörigen Liste werden in der Reihenfolge verarbeitet, in der sie im Array angezeigt werden. Entweder Liste Oder Sichtbar Eigenschaft muss für jede zugehörige Listenaktion im Array angegeben werden.

    Tabelle : 3. Eigenschaften
    Name Typ Beschreibung
    Liste Zeichenfolge Ein Verweis auf eine zugehörige Liste im Formular. Wenn leer, gilt die Aktion für alle zugehörigen Listen. Diese Eigenschaft ist erforderlich, wenn Sichtbar Eigenschaft ist nicht festgelegt.
    Format:
    • sys_ID: Die sys_ID für die Liste. Verwenden Sie dieses Format für anwenderdefinierte Abfragen, Anhänge und systemdefinierte zugehörige Listen.
    • Tabelle.Feld: Die Tabelle und der Feldname, die der Liste zugeordnet sind, z. B. „incident.caller_id' . Verwenden Sie dieses Format für Referenzfeldbasierte Beziehungen.
    Sichtbar Boolescher Wert oder Zeichenfolge Eine Option zum Steuern der Sichtbarkeit der zugehörigen Liste. Diese Eigenschaft ist erforderlich, wenn Liste Eigenschaft ist nicht festgelegt.
    Gültige Werte:
    • Wahr: Die zugehörige Liste ist sichtbar.
    • Falsch: Die zugehörige Liste ist ausgeblendet.
    • „Ignorieren“: Die zugehörige Liste wurde nicht geändert.

    Standard: Ignorieren

    		 
     relatedListActions: [
    {
      // Using plain GUID for system relationships 
      list: 'b9edf0ca0a0a0b010035de2d6b579a03', // Attachments
      visible: false
    },
    {
      // Using table.field format for reference fields
      list: 'x_snc_17sepapp1_expenseitem.expensereport', // Example reference field
      visible: true
    }
  ]