Eigenschafts-API – ServiceNow Fluent

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 3 Minuten Lesedauer

    • Die Eigenschaften-API enthält Objekte, die Systemeigenschaften definieren [sys_properties].

    Eigenschaftsobjekt

    Fügen Sie Systemeigenschaften [sys_properties] hinzu, um Aspekte einer Anwendung zu konfigurieren.

    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.
    Name Zeichenfolge Erforderlich. Der Name der Eigenschaft, beginnend mit dem Anwendungsbereich im folgenden Format:<scope> .<name> .
    Wert Beliebig Ein Wert für die Eigenschaft. Der Wert muss den richtigen Datentyp aufweisen.

    Alle Eigenschaftswerte werden als Zeichenfolgen gespeichert. Wenn Sie Eigenschaften mit der Methode gs.getProperty() abrufen, behandeln Sie die Ergebnisse als Zeichenfolgen. Beispielsweise gibt eine Wahr|Falsch-Eigenschaft „true“ oder „false“ (Zeichenfolgen) zurück, nicht das boolesche Äquivalent.
    type Zeichenfolge Ein Datentyp für den Eigenschaftswert.

    Gültige Werte: Zeichenfolge, Ganzzahl, boolescher Wert, Auswahlliste, Farbe, Datumsformat, Bild, Passwort, Passwort2, kurze Zeichenfolge, Zeitformat, Zeitzone, hochgeladenes Bild
    Beschreibung Zeichenfolge Beschreibung der Funktion der Eigenschaft.
    Auswahlmöglichkeiten Array Eine durch Kommas getrennte Liste von Auswahlwerten. Diese Eigenschaft gilt nur, wenn die Eigenschaft „ type “ auf „auswahlliste“ festgelegtist.

    Wenn Sie eine andere Auswahlbezeichnung und einen anderen Wert benötigen, trennen Sie die Bezeichnung durch ein Gleichheitszeichen (=). Beispiel: ['Blau=0000FF', 'Rot=FF0000', 'Grün=00FF00'] zeigt Blau, Rotund Grün in der Liste an und speichert den entsprechenden Hex-Wert im Feld „Eigenschaftswert“.
    Rollen Objekt Die Variablenbezeichner von Rollenobjekten oder die Namen von Rollen, die Lese- oder Schreibzugriff auf die Eigenschaft haben. Weitere Informationen finden Sie unter Rollen-API – ServiceNow Fluent.
    roles: {
   read: [activity_admin, 'app_user'],
   write: [admin]
}
    Ignorieren Sie den Cache Boolean Kennzeichnung, die angibt, ob eine Cacheleerung durchgeführt 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 den Wert einer Systemeigenschaft ä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 Leistungskosten, die durch das Leeren aller Caches und das Abrufen neuer Eigenschaftswerte verursacht werden. Im Allgemeinen sollten Sie diese Eigenschaft nur auf „ true “ festlegen, wenn Sie eine Systemeigenschaft haben, die sich häufiger als einmal im Monat ändert und der Eigenschaftswert nur in der Tabelle „Systemeigenschaften“ [sys_properties] gespeichert ist.
    • „falsch“: Das System leert alle serverseitigen Caches und ruft den aktuellen Eigenschaftswert aus der -Datenbank ab. Legen Sie diese Eigenschaft auf „false “ fest, damit alle Caches den aktuellen Eigenschaftswert erhalten.

    Standardwert: false
    istprivat Boolean Kennzeichnung, die angibt, ob die Eigenschaft vom Import über Update-Sätze ausgeschlossen werden soll.

    Indem Sie Systemeigenschaften privat halten, können Sie verhindern, dass Einstellungen in einer Instanz Werte in einer anderen Instanz überschreiben. Beispielsweise möchten Sie möglicherweise 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

    		 
    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 Rollen, auf die verwiesen wird, werden mithilfe des Rollenobjekts definiert:
    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', 
   contains_roles: [managerRole] 
})