Eigenschafts-API – ServiceNow Fluent

  • Freigeben Version: Zurich
  • Aktualisiert 31. Juli 2025
  • 3 Minuten Lesedauer
  • Die Eigenschafts-API definiert Systemeigenschaften [sys_properties], die das Instanzverhalten steuern.

    Allgemeine Informationen zu Systemeigenschaften finden Sie unter Add a system property.

    Eigenschaftsobjekt

    Fügen Sie eine Systemeigenschaft [sys_properties] zum Konfigurieren eines Aspekts einer Anwendung hinzu.

    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]

    Name Zeichenfolge Erforderlich. Der Name der Eigenschaft, die mit dem Anwendungsbereich beginnt, im folgenden Format: <scope>.<name> .
    Wert Beliebig Ein Wert für die Eigenschaft. Der Wert muss dem richtigen Datentyp entsprechen.

    Alle Eigenschaftswerte werden als Zeichenfolgen gespeichert. Beim Abrufen von Eigenschaften über gs.getProperty() Methode: Behandeln Sie die Ergebnisse als Zeichenfolgen. Beispielsweise gibt eine Wahr|Falsch-Eigenschaft „true“ oder „false“ (Zeichenfolgen) zurück, nicht das boolesche Äquivalent.

    Typ Zeichenfolge Ein Datentyp für den Eigenschaftswert.

    Gültige Werte: Zeichenfolge, Ganzzahl, boolescher Wert, Auswahlliste, Farbe, Date_Format, Bild, Passwort, Password2, short_string, Time_Format, Zeitzone, uploaded_image

    Beschreibung Zeichenfolge Eine Beschreibung der Funktion der Eigenschaft.
    Auswahlmöglichkeiten Array Eine kommagetrennte Liste von Auswahlwerten. Diese Eigenschaft gilt nur, wenn Typ Eigenschaft ist auf festgelegt Auswahlliste .

    Wenn Sie eine andere Auswahlbezeichnung und einen anderen Wert benötigen, verwenden Sie ein Gleichheitszeichen (=), um die Bezeichnung vom Wert zu trennen. Beispiel: ['Blau=0000FF', 'Rot=FF0000', 'Grün=00FF00'] Wird angezeigt Blau , Rot , Und Grün In der Liste und speichert den entsprechenden Hex-Wert im Feld „Eigenschaftswert“.

    Rollen Objekt Die Variablenbezeichner von Rolle Objekte oder Namen von Rollen, die Lese- oder Schreibzugriff auf die Eigenschaft haben. Zum Beispiel:
    roles: {
       read: [activity_admin, 'app_user'],
       write: [admin]
    }

    Weitere Informationen finden Sie unter Rollen-API – ServiceNow Fluent.

    IgnoreCache Boolean Kennzeichnung, die angibt, ob der Cache geleert werden soll, wenn der Wert der Eigenschaft festgelegt ist.

    Das System speichert Systemeigenschaftswerte in serverseitigen Caches, um zu vermeiden, dass die Datenbank nach Konfigurationseinstellungen abgefragt wird. Wenn Sie einen Systemeigenschaftswert ändern, leert das System den Cache für die Tabelle „Systemeigenschaften“ [sys_properties]. Verwenden Sie dieses Feld, um zu bestimmen, ob der Wert dieser Eigenschaft aus allen anderen serverseitigen Caches geleert werden soll.

    Gültige Werte:
    • Wahr: Das System ignoriert das Leeren einiger serverseitiger Caches. Daher wird nur der Cache für die Tabelle „Systemeigenschaften“ [sys_properties] geleert und der vorherige Eigenschaftswert in allen anderen Caches beibehalten. Diese Option vermeidet die Leistungskosten für das Leeren aller Caches und das Abrufen neuer Eigenschaftswerte. Im Allgemeinen sollten Sie diese Eigenschaft nur auf festlegen Wahr Wenn Sie über eine Systemeigenschaft verfügen, die sich häufiger als einmal pro Monat ändert, und der Eigenschaftswert nur in der Tabelle „Systemeigenschaften“ [sys_properties] gespeichert wird.
    • Falsch: Das System leert alle serverseitigen Caches und ruft den aktuellen Eigenschaftswert aus der Datenbank ab. Legen Sie diese Eigenschaft auf fest Falsch Damit alle Caches den aktuellen Eigenschaftswert haben.

    Standardwert: false

    IPrivate Boolean Kennzeichnung, die angibt, ob die Eigenschaft vom Importieren über Update-Sätze ausgeschlossen werden soll.

    Wenn Sie Systemeigenschaften privat halten, können Sie verhindern, dass Einstellungen in einer Instanz Werte in einer anderen Instanz überschreiben. Beispielsweise möchten Sie nicht, dass eine Systemeigenschaft in einer Entwicklungsinstanz denselben Wert wie eine Produktionsinstanz verwendet.

    Gültige Werte:
    • Wahr: Die Eigenschaft ist nicht in Update-Sätzen enthalten.
    • Falsch: Die Eigenschaft ist in Update-Sätzen enthalten.

    Standardwert: false

    $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 { Property } from '@servicenow/sdk/core'
    
    Property({
       $id: Now.ID['1234'],
       name: 'x_snc_app.some.new.prop',
       type: 'string',
       value: 'hello',
       description: 'A new property',
       roles: {
          read: ['admin'],
          write: [adminRole, managerRole],
       },
       ignoreCache: false,
       isPrivate: false,
    })
    Die referenzierten Rollen werden mit definiert Rolle Objekt:
    import { Role } from "@servicenow/sdk/core";
    
    const managerRole = Role({ 
       $id: Now.ID['manager_role'], 
       name: 'x_snc_example.manager' 
    })
    
    const adminRole = Role({ 
       $id: Now.ID['admin_role'], 
       name: 'x_snc_example.admin', 
       containsRoles: [managerRole] 
    })