api: UI Builder

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

    • Die API Die API stellt Methoden bereit, die Sie bei der Entwicklung von Client-Skripts in UI Builder verwenden können.

    Diese API ist Clientskripts zugänglich, auch als Seitenskripts bezeichnet. Client-Skripts werden als Reaktion auf etwas ausgeführt, das auf einer Seite passiert, z. B.:
    • Anwenderinteraktionsereignisse/-Aktionen, z. B. Klicken auf eine Schaltfläche.
    • Lebenszyklusereignisse, z. B. die Ausführung eines Datenbrokers, wurden gestartet.
    Diese Skripts müssen nichts an das Framework zurückgeben und können als asynchrone Funktion geschrieben werden.
    Diese API ist auch für geskriptete Eigenschaftswerte verfügbar. Diese Skripts werden immer dann ausgeführt, wenn die Framework-Laufzeit einen Wert berechnen muss, z. B.:
    • Übergabe an eine Komponenteneigenschaft.
    • Sichtbarkeit der Komponente wird bestimmt.
    • Ausgabe eines Ereignisses mit einer Nutzlast.
    Diese Skripts können nicht als asynchrone Funktion geschrieben werden. Sie können auch keine Nebenwirkungsmethoden für das api-Objekt aufrufen, z. B. api.Emit() , api.setState() , Und api.Daten.<data_resource_id>.*() .

    Das api-Objekt enthält sowohl konfigurationsabhängige als auch konfigurationsunabhängige Eigenschaften, auf die Sie im Kontext der zugehörigen Seite oder Komponente zugreifen können. Sie können die Eigenschaften innerhalb dieses Objekts nicht direkt ändern. Änderungen können nur über die verfügbaren Methoden vorgenommen werden.

    api: api.context.props.<page_property_name>

    Seiteneigenschaften können in konfiguriert werden UI Builder. Die Konfigurationswerte hängen vom Kontext ab, in dem die Seite verwendet wird.

    Tabelle : 1. Feld
    Name Typ Beschreibung
    <page_property_name> Beliebig Verfügbare Werte hängen von der Client-Skriptimplementierung ab.

    Um auf diese Eigenschaften zuzugreifen, verwenden Sie Folgendes: api.context.props.<page_property_name> .

    Zum Beispiel: 
    // A record page with property table could be accessed with
function isActivityStreamVisible({api}) {
  return api.context.props.table === 'incident';
}
    Hinweis:
    Diese Eigenschaftswerte sind schreibgeschützt. Das Mutation geschachtelter Objektwerte aus Skripts wird nicht unterstützt.

    api: api.context.session.<session_property>

    Kontextsitzungseigenschaften, die dem aktuellen Anwender zugeordnet sind.

    Tabelle : 2. Verfügbare Sitzungseigenschaften
    Name Typ Beschreibung
    Ist LoggedIn Boolean Kennzeichnung, die angibt, ob der aktuelle Anwender beim System angemeldet ist.
    Mögliche Werte:
    • Wahr: Der aktuelle Anwender ist bei angemeldet
    • Falsch: Der aktuelle Anwender ist nicht angemeldet.
    Eigenschaften.awaEnabled Zeichenfolge Die Systemeigenschaft „Glide.Awa.enabled“, die angibt, ob die automatische Zuweisung für Arbeitselemente für die erweiterte Arbeitszuweisung (AWA) für den aktuellen Anwender aktiviert ist.
    Mögliche Werte:
    • Wahr: AWA ist für den Anwender aktiviert.
    • Falsch: AWA ist für den Anwender nicht aktiviert.

    Weitere Informationen finden Sie unter Mit der erweiterten Arbeitszuweisung installierte Komponenten .
    Eigenschaften.VergessenMe.Wert Zeichenfolge Die Eigenschaft „Glide.ui.Forgetme“, die angibt, ob entfernt werden soll Merken Sie Sich Aktivieren Sie das Kontrollkästchen auf der Anmeldeseite, um zu verhindern, dass Anmeldeinformationen zwischengespeichert werden.
    Mögliche Werte:
    • Wahr: Entfernen Sie Merken Sie Sich Kontrollkästchen.
    • Falsch: Zeigen Sie an Merken Sie Sich Kontrollkästchen.

    Weitere Informationen finden Sie unter Entfernen Sie „mich speichern“ .
    properties.sessionTimeLeft.value Zeichenfolge

    Zahl, die zu Zeichenfolge erzwungen wurde

    		 Die Systemeigenschaft glide.ui.session_timeleft, die die verbleibende Zeit vor der Zeitüberschreitung der aktuellen Sitzung bestimmt. Verwenden Sie diese Eigenschaft, um den Anwender aufzufordern, die aktuelle Sitzung zu erweitern, bevor eine Zeitüberschreitung eintritt.

    Einheit: Minuten
    properties.sessionTimeout.value Zeichenfolge

    Zahl, die zu Zeichenfolge erzwungen wurde

    		 Die Systemeigenschaft glide.ui.session_timeout, die den Zeitüberschreitungswert der ersten Sitzung bestimmt.

    Einheit: Minuten: Werte, die größer als 1440 Minuten sind, werden als ein Tag behandelt.

    Weitere Informationen finden Sie unter Zeitüberschreitung bei Sitzungsaktivität

    Eigenschaften.Nachverfolgungaktiviert.Wert Zeichenfolge Die Systemeigenschaft „Glide.uxbuilder.Tracking.enabled“, die angibt, ob das Laden und die Instanziierung der Web Analytics-Bibliothek für aktiviert/deaktiviert werden soll UI Builder Basierte Anwendungen.
    Mögliche Werte:
    • Wahr: Für den Anwender aktiviert.
    • Falsch: Für den Anwender deaktiviert.
    Anwender.Avatar Zeichenfolge URL des Avatars des aktuellen Anwenders.
    User.dateFormat Zeichenfolge Standarddatumsformat.
    Anwender.Domäne Zeichenfolge Domänenpfad für den aktuellen Anwender.
    Anwender.Vorname Zeichenfolge Vorname des aktuellen Anwenders.
    Anwender.vollständiger Name Zeichenfolge Vor- und Nachname des aktuellen Anwenders.
    user.initials Zeichenfolge Initialen des aktuellen Anwenders.
    Anwender.Sprache Zeichenfolge Primäre Sprache, die vom aktuellen Anwender gesprochen wird.
    Anwender.Einstellungen Array von Objekten Name-Wert-Paare, die die Anwendereinstellungen beschreiben. Diese Anwendereinstellungen werden als Datensätze in der Tabelle „Anwendereinstellungen“ [sys_user_preferences] gespeichert und jedes Mal aktualisiert, wenn der Anwender seine Einstellungen ändert.

    Weitere Informationen finden Sie unter Exploring user administration.
    Anwender.Rollen Array Kommagetrennte Liste der Rollen, die dem aktuellen Anwender zugewiesen sind.
    Hinweis:
    Wenn dem Anwender keine Rollen zugewiesen sind, gibt diese Kontextsitzungseigenschaft null und kein leeres Array zurück.
    Anwender.sys_ID Zeichenfolge SYS_ID des Anwenders in der Anwendertabelle [sys_user].
    Anwender.Zeitformat Zeichenfolge Standardzeitformat, das für den Anwender verwendet werden soll.
    Anwender.Zeitzone Zeichenfolge Zeitzone des aktuellen Anwenders.
    User.timeZoneOffset Zeichenfolge Zeitzonen-Offset des aktuellen Anwenders.

    api: api.Data.<data_resource_id>.Lifecycle.lastFetchSucceeded

    Boolesche Kennzeichnung, die angibt, ob der letzte Abrufversuch für die angegebene Datenressourceninstanz erfolgreich abgeschlossen wurde.

    Wenn der Wert „wahr“ ist, wurde der letzte Abrufversuch für die Instanz der Datenressource erfolgreich abgeschlossen. Andernfalls „falsch“.

    Tabelle : 3. Feld
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.

    api – api.Data.<data_resource_id>.addErrorMessage (Objektnutzlast)

    Zeigt die angegebene Fehlermeldung oben im aktuellen Formular an.

    Tabelle : 4. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das die anzuzeigende Fehlermeldung beschreibt.
    "payload": {
  "message": "String"
}
    Nutzlast.Nachricht Zeichenfolge Fehlermeldung, die angezeigt werden soll.
    Tabelle : 5. Ergebnisse
    Typ Beschreibung
    Keine 

    api.data.gform.addErrorMessage({message: 'Error message'});

    api: api.Data.<data_resource_id>.addInfoMessage (Objektnutzlast)

    Zeigt die angegebene Informationsnachricht oben im aktuellen Formular an.

    Tabelle : 6. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das die anzuzeigende Informationsnachricht beschreibt.
    "payload": {
  "message": "String"
}
    Nutzlast.Nachricht Zeichenfolge Anzuzeigende Informationsnachricht.
    Tabelle : 7. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.addInfoMessage({message: 'Test message'});

    api – api.Data.<data_resource_id>.addOption (Objektnutzlast)

    Fügt dem angegebenen Auswahltypfeld eine Option hinzu.

    Tabelle : 8. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das den zu aktualisierenden Feldwert beschreibt.
    "payload": {
  "choiceIndex": "String",
  "choiceLabel": "String",
  "choiceValue": "String",
  "fieldName": "String"
}
    payload.choiceIndex Zeichenfolge Optional. Index in die Auswahlliste, in der die Option eingefügt werden soll.

    Standard: Ende der Auswahlliste.
    payload.choiceLabel Zeichenfolge Bezeichnung der Option, die dem angegebenen Feld hinzugefügt werden soll.
    payload.choiceValue Zeichenfolge Wert der Option, die dem angegebenen Feld hinzugefügt werden soll.
    Payload.fieldName Zeichenfolge Name des Formularfelds für Auswahltyp, dem die angegebene Option hinzugefügt werden soll.
    Tabelle : 9. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.addOption({fieldName: 'priority', choiceLabel: 'Extremely High', choiceValue: '10'});

    api – api.Data.<data_resource_id>.addWarningMessage (Objektnutzlast)

    Zeigt die angegebene Warnmeldung oben im aktuellen Formular an.

    Tabelle : 10. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das die anzuzeigende Warnmeldung beschreibt.
    "payload": {
  "message": "String"
}
    Nutzlast.Nachricht Zeichenfolge Anzuzeigende Warnmeldung.
    Tabelle : 11. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.addWarningMessage({message: 'Test message'});

    api – api.Data.<data_resource_id>.ClearMessage()

    Entfernt alle Informations- und Fehlermeldungen oben im aktuellen Formular.

    Tabelle : 12. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Tabelle : 13. Ausgabe
    Typ Beschreibung
    Keine 

    api.data.gform.clearMessage();

    api – api.Data.<data_resource_id>.ClearOptions (Objektnutzlast)

    Löscht alle Optionen aus dem angegebenen Auswahltypfeld.

    Tabelle : 14. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das das Auswahltypfeld beschreibt, dessen Optionen gelöscht werden sollen.
    "payload": {
  "fieldName": "String"
}
    Payload.fieldName Zeichenfolge Name des Auswahltypfelds, dessen Optionen gelöscht werden sollen.
    Tabelle : 15. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.clearOptions({fieldName: 'priority'});

    api – api.Data.<data_resource_id>.executeUiAction (Objektnutzlast)

    Führt die angegebene UI-Aktion aus.

    Tabelle : 16. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Beschreibung der auszuführenden UI-Aktion.
    "payload": {
  "actionSysId": "String"
}
    Payload.actionSysId Zeichenfolge SYS_ID der auszuführenden UI-Aktion.

    Tabelle: UI-Aktion [sys_ui_action]
    Tabelle : 17. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    api.data.gform.executeUiAction({actionSysId: '60615ff90f730010ac7de6f8c4767e9a'});

    api – api.Data.<data_resource_id>.execute(Object inputValues)

    Löst einen Ausführungsvorgang für die angegebene Datenressource aus.

    Diese Methode ist nur verfügbar, wenn die Datenressource einer der folgenden Typen ist:
    • Zusammenfassung
    • GraphQL
    • REST
    • Skriptlet
    • Umwandeln
    Hinweis:
    Diese Methode wird nur verfügbar gemacht, wenn die mutates_server_dataFeld ist auf festgelegt Wahr Im entsprechenden Datenressource-Datensatz (Tabelle „sys_ux_Data_Broker_*“). Sie ist unter zugänglich api.Daten.<data_resource_Id>.REFRESH() .
    Tabelle : 18. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    inputValues Objekt Objekt, das an die angegebene Datenressource übergeben werden soll. Dieses Objekt muss den Eingabeparametern der Datenressource entsprechen.
    Tabelle : 19. Rückgaben
    Typ Beschreibung
    Keine

    Dieses Codebeispiel zeigt ein Seitenskript, das aufgerufen wird, wenn Übermitteln Auf die Schaltfläche auf der Seite geklickt. Die Seite wird konfiguriert, wenn eine Serverdatenressource einen neuen Datensatz erstellt.

    function handler({api}) {
  if (api.state.movieYear === 2020) {
    // The data resource used in this case specifies two input parameters: name and year
    api.data.create_movie_record.execute({
      name: api.state.movieName,
      year: api.state.movieYear
    });
  }
}

    api – api.Data.<data_resource_id>.hideFieldMessage (Objektnutzlast)

    Blendet die älteste Nachricht neben dem angegebenen Feld aus oder löscht alle dem Feld zugeordneten Nachrichten.

    Tabelle : 20. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das die auszublendende Feldnachricht beschreibt.
    "payload": {
  "clearAll": Boolean,
  "fieldName": "String"
}
    Payload.CLEARALL Boolean Optional. Kennzeichnung, die angibt, ob alle Nachrichten gelöscht werden sollen, die dem angegebenen Formularfeld zugeordnet sind.
    Gültige Werte:
    • Wahr: Löschen Sie alle Nachrichten, die dem angegebenen Feld zugeordnet sind.
    • Falsch: Löschen Sie nicht alle Nachrichten, die dem angegebenen Feld zugeordnet sind.

    Standardwert: false
    Payload.fieldName Zeichenfolge Name des Formularfelds, für das die älteste Nachricht ausgeblendet oder alle zugehörigen Nachrichten gelöscht werden sollen.
    Tabelle : 21. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.hideFieldMessage({fieldName: 'short_description'});

    api – api.Data.<data_resource_id>.hideRelatedList (Objektnutzlast)

    Blendet die angegebene zugehörige Liste im aktuellen Formular aus.

    Tabelle : 22. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das die auszublendende zugehörige Liste beschreibt.
    "payload": {
  "listTableName ": "String"
}
    Payload.listTabellenname Zeichenfolge Name der zugehörigen Liste, die ausgeblendet werden soll. Wenn die auszublendende Liste über eine Beziehung erfolgt, geben Sie die sys_ID der Liste anstelle des Namens an.

    Tabelle: Zugehörige Liste [sys_ui_related_list]
    Tabelle : 23. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    api.data.gform.hideRelatedList({listTableName:'incident.parent_incident'});

    api – api.Data.<data_resource_id>.hideRelatedLists()

    Blendet alle zugehörigen Listen im aktuellen Formular aus.

    Tabelle : 24. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Tabelle : 25. Ausgabe
    Typ Beschreibung
    Keine 

    api.data.gform.hideRelatedLists();

    api – api.Data.<data_resource_id>.refresh()

    Löst einen Aktualisierungsvorgang für die angegebene Instanz der nicht mutierenden Datenressource aus.

    Rufen Sie diese Methode auf, wenn sich die zugrunde liegenden Daten ändern, die von der Datenressource abgerufen werden. Eine Datenressource wird als nicht mutierend betrachtet, wenn der mutates_server_dataFeld im Datensatz ist auf „falsch“ festgelegt.

    Diese Methode ist asynchron und gibt ein internes Ereignis aus, um die Aktualisierung der angegebenen Datenressourceninstanz auszulösen. Die UI Builder Ermöglicht Ihnen das Auslösen von Clientskripts als Antwort auf Lebenszyklusereignisse von Datenressourcen, z. B. DATA_FETCH_SUCCESSFUL und DATA_FETCH_FAILED. Weitere Informationen zu diesen Ereignissen finden Sie unter Ereigniszuordnung .

    Diese Methode ist nur verfügbar, wenn die Datenressource einer der folgenden Typen ist:
    • Zusammenfassung
    • GraphQL
    • REST
    • Skriptlet
    • Umwandeln
    Hinweis:
    Diese Methode wird nur verfügbar gemacht, wenn die mutates_server_dataFeld ist auf festgelegt Falsch Im entsprechenden Datenressource-Datensatz (Tabelle „sys_ux_Data_Broker_*“).
    Tabelle : 26. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Tabelle : 27. Ausgabe
    Typ Beschreibung
    Keine

    Dieses Codebeispiel zeigt ein Seitenskript, das aufgerufen wird, wenn ein Dropdown-Element auf einer Seite ausgewählt wird. Die Seite ist mit zwei Serverdatenressourcen konfiguriert, die Probleme- und Incident-Tabellen abfragen.

    function handler({api, event}) {
  const value = event.payload.value[0];
  if (value === 'problem')
    api.data.problem_list_1.refresh();
  else if(value === 'incident')
    api.data.incident_list_1.refresh();
}

    api – api.Data.<data_resource_id>.reload()

    Lädt das aktuelle Formular mit derselben Tabelle und derselben sys_ID neu

    Tabelle : 28. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Tabelle : 29. Ausgabe
    Typ Beschreibung
    Keine 

    api.data.gform.reload();

    api – api.Data.<data_resource_id>.removeOption (Objektnutzlast)

    Entfernt eine Option aus dem angegebenen Auswahltypfeld.

    Tabelle : 30. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das das zu aktualisierende Auswahltypfeld beschreibt.
    "payload": {
  "choiceValue": "String",
  "fieldName": "String"
}
    payload.choiceValue Zeichenfolge Wert der Option, die aus dem angegebenen Auswahltypfeld entfernt werden soll.
    Payload.fieldName Zeichenfolge Name des Auswahltypformularfelds, aus dem der angegebene Wert entfernt werden soll.
    Tabelle : 31. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.removeOption({fieldName: 'priority', choiceValue: '1'});

    api – api.Data.<data_resource_id>.Save()

    Löst die Formularübermittlung mit aus Speichern UI-Aktion.

    Tabelle : 32. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Tabelle : 33. Ausgabe
    Typ Beschreibung
    Keine 

    api.data.gform.save();

    api – api.Data.<data_resource_id>.setPflichtPflichtfeld(Objekt-Nutzlast)

    Legt fest, ob das angegebene Formularfeld obligatorisch ist.

    Tabelle : 34. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das das Feld beschreibt, dessen obligatorische Informationen aktualisiert werden sollen.
    "payload": {
  "fieldName": "String",
  "mandatory": Boolean
}
    Payload.fieldName Zeichenfolge Name des Formularfelds, dessen Pflichtwert festgelegt werden soll.
    Nutzlast.obligatorisch Boolean Kennzeichnung, die angibt, dass das angegebene Formularfeld obligatorisch ist, d. h. das Formular kann nicht gespeichert werden, ohne dass dieses Feld einen gültigen Wert enthält.
    Gültige Werte:
    • Wahr: Feld ist ein Pflichtfeld.
    • Falsch: Feld ist optional.
    Tabelle : 35. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.setMandatory({fieldName: 'short_description', mandatory: false});

    api – api.Data.<data_resource_id>.setReadOnly (Objektnutzlast)

    Legt die Lese-/Schreibfähigkeiten des angegebenen Formularfelds fest.

    Tabelle : 36. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das das Feld beschreibt, dessen Lesbarkeitsinformationen aktualisiert werden sollen.
    "payload": {
  "fieldName": "String",
  "readonly": Boolean
}
    Payload.fieldName Zeichenfolge Name des Formularfelds, dessen Lesbarkeit festgelegt werden soll.
    Nutzlast.schreibgeschützt Boolean Kennzeichnung, die die Lese-/Schreibfähigkeiten des angegebenen Formularfelds angibt.
    Gültige Werte:
    • Wahr: Feld ist schreibgeschützt.
    • Falsch: Feld ist „Lese-/Schreibzugriff“.
    Tabelle : 37. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.setReadOnly({fieldName: 'short_description', readonly: false});

    api: api.Data.<data_resource_id>.setValue (Objektnutzlast)

    Aktualisiert ein angegebenes GlideForm-Feld mit dem angegebenen Wert. Optional können Sie den Anzeigewert auch mit demselben angegebenen Wert aktualisieren.

    Nur der Wert im Formular wird aktualisiert. Der Wert wird nicht in der Datenbank gespeichert.

    Tabelle : 38. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das das Feld beschreibt, dessen Wert aktualisiert werden soll.
    "payload": {
  "displayValue": "String",
  "fieldName": "String",
  "value": "String"
}
    Nutzlast.Anzeigewert Zeichenfolge Optional. Name des zu aktualisierenden Anzeigewerts. Wenn leer gelassen, wird der Anzeigewert nicht geändert.
    Payload.fieldName Zeichenfolge Name des zu aktualisierenden Formularfelds.
    Nutzlast.Wert Zeichenfolge Wert, mit dem das Feld aktualisiert werden soll.
    Tabelle : 39. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.setValue({fieldName: 'short_description', value: 'short description'});

    api – api.Data.<data_resource_id>.setVisible (Objektnutzlast)

    Legt die Sichtbarkeit des angegebenen Formularfelds fest.

    Tabelle : 40. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das das Feld beschreibt, für das die Sichtbarkeit festgelegt werden soll.
    "payload": {
  "fieldName": "String",
  "visibility": Boolean
}
    Payload.fieldName Zeichenfolge Name des Formularfelds, dessen Sichtbarkeit festgelegt werden soll.
    Nutzlast.Sichtbarkeit Boolean Kennzeichnung, die angibt, ob das zugeordnete Feld im aktuellen Formular sichtbar ist.
    Gültige Werte:
    • Wahr: Feld wird im Formular angezeigt.
    • Falsch: Feld wird im Formular nicht angezeigt.
    Tabelle : 41. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.setVisible({fieldName: 'short_description', visibility: false});

    api – api.Data.<data_resource_id>.showFieldMessage (Objektnutzlast)

    Zeigt die angegebene Nachricht neben dem angegebenen Feld an.

    Tabelle : 42. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das die anzuzeigende Feldnachricht beschreibt.
    "payload": {
  "fieldName": "String",
  "message": "String",
  "type": "String"
    Payload.fieldName Zeichenfolge Name des Felds, neben dem die Nachricht angezeigt werden soll.
    Nutzlast.Nachricht Zeichenfolge Meldung, die angezeigt werden soll.
    Payload.type Zeichenfolge Optional. Typ der anzuzeigenden Nachricht.
    Gültige Werte:
    • Fehler
    • Info
    • Warnung

    Standard: Info
    Tabelle : 43. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.showFieldMessage({fieldName: 'short_description', message: 'Error message', type: 'error'});

    api – api.Data.<data_resource_id>.showRelatedList (Objektnutzlast)

    Zeigt die angegebene zugehörige Liste im aktuellen Formular an.

    Tabelle : 44. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das die anzuzeigende zugehörige Liste beschreibt.
    "payload": {
  "listTableName ": "String"
}
    Payload.listTabellenname Zeichenfolge Name der zugehörigen Liste, die angezeigt werden soll. Wenn die anzuzeigende Liste über eine Beziehung erfolgt, geben Sie die sys_ID der Liste anstelle des Namens an.

    Tabelle: Zugehörige Liste [sys_ui_related_list]
    Tabelle : 45. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt, wie diese Methode aufgerufen wird.

    api.data.gform.showRelatedList({listTableName:'incident.parent_incident'});

    api – api.Data.<data_resource_id>.showRelatedLists()

    Zeigt alle zugehörigen Listen an, die dem aktuellen Formular zugeordnet sind.

    Tabelle : 46. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Tabelle : 47. Ausgabe
    Typ Beschreibung
    Keine 

    api.data.gform.showRelatedLists();

    api – api.Data.<data_resource_id>.submit()

    Löst die Formularübermittlung mit der angegebenen UI-Aktion aus.

    Tabelle : 48. Parameter
    Name Typ Beschreibung
    Data_resource_ID Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource.

    In den meisten Fällen können Sie die Aktion „Formular-Controller CTRL_RECORD#SAVE_FORM“ verwenden. Wenn die Datensatzseite über die Komponente „Datensatzseiten-Registerkarten“ verfügt, muss die Datenressource für diese Methode auf GlideForm (g_Form) basieren.

    Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in hinzufügen UI Builder.
    Nutzlast Objekt Objekt, das die UI-Aktion beschreibt, die zum Senden des aktuellen Formulars verwendet werden soll.
    "payload": {
  "submitActionName": "String"
}
    Payload.submitActionName Zeichenfolge Name der UI-Aktion, die zum übermitteln des aktuellen Formulars ausgeführt werden soll.
    Tabelle : 49. Rückgaben
    Typ Beschreibung
    Keine 

    api.data.gform.submit({submitActionName:'sysverb_ws_save'});

    api – api.Emit(Zeichenfolge eventName, Objektnutzlast)

    Gibt ein Ereignis mit dem angegebenen Namen und der angegebenen Nutzlast aus.

    Der ausgegebene Ereignisname muss Teil der Liste der gesendeten Ereignisse der zugehörigen Seitendefinition sein, die in der Tabelle „UX-Macroponent-Definition“ [sys_ux_macroponent] gespeichert ist. Beliebig api.Emit Anruf, der Ereignisse sendet, die nicht in dieser Tabelle deklariert sind, werden ignoriert.

    Weitere Informationen zu Ereignissen finden Sie unter Arbeiten Sie mit Ereignissen .

    Tabelle : 50. Parameter
    Name Typ Beschreibung
    eventName Zeichenfolge Name des auszugebenden Ereignisses. Dieser Name sollte den Benennungsrichtlinien der UI Framework-Aktion entsprechen:
    • Muss ein oberer Schlangenbuchstaben sein, z. B. ITEM_CHANGED. Alle Buchstaben in Großbuchstaben und alle Leerzeichen wurden durch Unterstriche ersetzt.
    • Muss veraltet sein, z. B. BUTTON_CLICKED oder USER_SELECTED.

    Weitere Informationen zu diesen Aktionsbenennungsrichtlinien finden Sie unter https://developer.servicenow.com/dev.do#!/reference/now-experience/sandiego/ui-framework/main-concepts/dispatching-actions.
    Nutzlast Objekt Optional. Objekt, das die Daten enthält, die mit dem ausgegebenen Ereignis gesendet werden sollen. Dieses Objekt ist Freiform und kann alle Daten enthalten, die für die Entität, die die Daten empfängt, erforderlich sind.
    Hinweis:
    Nutzlasten des primitiven Typs Arbeit, können jedoch zu inkonsistentem Verhalten führen.
    Tabelle : 51. Rückgaben
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt das Ausgeben eines Ereignisses namens NOW_UXF_PAGE#ADD_NOTIFICATIONSMit zugehörigem itemsNutzlast.

    function handler({api}) { 
  api.emit('NOW_UXF_PAGE#ADD_NOTIFICATIONS', { 
    items: [
      { 
        id: 'alert1', 
        status: 'positive', 
        icon: 'check-circle-outline', 
        content: 'Here is some information!', 
        textLinkProps: { 
          label: 'More info',
          href: 'https://www.servicenow.com' 
        }, 
      action: {type: 'acknowledge'} 
      } 
    ] 
  }); 
}

    api – setState(String stateParam, beliebiger Wert)

    Legt den Wert des angegebenen Client-Statusparameters fest.

    Verwenden Sie Client-Statusparameter, um einen freigegebenen Status auf einer Seite beizubehalten. Der freigegebene Status kann dann als Werte an Eigenschaften von Komponenten übergeben werden, die auf der Seite verwendet werden. Sie können auch in mehreren Seitenskripts auf clientstatus zugreifen und diese aktualisieren. Ein häufiger Anwendungsfall besteht darin, die von Anwendern in mehreren Formularsteuerelementen auf einer Seite eingegebenen Werte nachzuverfolgen. Wenn das Formular übermittelt wird, kann ein Client-Skript alle in den Client-Statusparametern gespeicherten Werte verwenden, um einen neuen Datensatz mit einem Daten-Broker zu erstellen. Eine Seite kann einen oder mehrere Client-Statusparameter haben, die Sie für eine Seite über UI Builder deklarieren können. Sie können dann einen Client-Statusparameter an eine oder mehrere Komponenten binden, um den Client-Statusparameter freizugeben oder entsprechend zu handeln.

    api.setState() Aufrufe werden asynchron ausgeführt und aktualisieren die UI nicht unbedingt sofort. Ob der festzulegende Wert von abhängt currentValueDes Client-Statusparameters oder einer der im api-Objekt bereitgestellten Eigenschaften sollten Sie diese Variante von verwenden api.setState() Methode zur Vermeidung der Verwendung veralteter Werte.

    Tabelle : 52. Parameter
    Name Typ Beschreibung
    StateParm Zeichenfolge Name des zu aktualisierenden Clientstatusparameters. Dieser Name muss in den Clientstatusparametern der zugehörigen Seite deklariert werden.

    Weitere Informationen zum Deklardieren von Client-Statusparametern finden Sie unter Arbeiten Sie mit Client-Statusparametern .
    Wert Beliebig – muss mit der Deklaration des Client-Statusparameters identisch sein. Wert, auf den der angegebene Client-Statusparameter festgelegt werden soll.
    Tabelle : 53. Rückgaben
    Typ Beschreibung
    Keine

    Dieses Beispiel zeigt ein Skript, das ausgeführt werden könnte, um den Statusparameter des E-Mail-Clients zu aktualisieren, wenn ein Eingabewert für eine Now-input-Komponente festgelegt ist.

    function handler({api, event}) {
    api.setState('email', event.payload.value);
}

    api – setState(Zeichenfolge stateParam, Funktion callbackFn)

    Legt den Wert des angegebenen Client-Statusparameters auf den Wert fest, der von der angegebenen Rückruffunktion zurückgegeben wird.

    Die Rückruffunktion wird mit einem Objekt aufgerufen, das zwei Eigenschaften hat: currentValueUnd api. Die Funktion darf niemals mutieren currentValueEigenschaft oder apiObjekt direkt.

    Verwenden Sie Client-Statusparameter, um einen freigegebenen Status auf einer Seite beizubehalten. Der freigegebene Status kann dann als Werte an Eigenschaften von Komponenten übergeben werden, die auf der Seite verwendet werden. Sie können auch in mehreren Seitenskripts auf clientstatus zugreifen und diese aktualisieren. Ein häufiger Anwendungsfall besteht darin, die von Anwendern in mehreren Formularsteuerelementen auf einer Seite eingegebenen Werte nachzuverfolgen. Wenn das Formular übermittelt wird, kann ein Client-Skript alle in den Client-Statusparametern gespeicherten Werte verwenden, um einen neuen Datensatz mit einem Daten-Broker zu erstellen. Eine Seite kann einen oder mehrere Client-Statusparameter haben, die Sie für eine Seite über UI Builder deklarieren können. Sie können dann einen Client-Statusparameter an eine oder mehrere Komponenten binden, um den Client-Statusparameter freizugeben oder entsprechend zu handeln.

    api.setState() Aufrufe werden asynchron ausgeführt und aktualisieren die UI nicht unbedingt sofort. Ob der festzulegende Wert von abhängt currentValueDes Client-Statusparameters oder einer der im api-Objekt bereitgestellten Eigenschaften sollten Sie diese Variante von verwenden api.setState() Methode zur Vermeidung der Verwendung veralteter Werte.

    Tabelle : 54. Parameter
    Name Typ Beschreibung
    StateParm Zeichenfolge Name des zu aktualisierenden Clientstatusparameters. Dieser Name muss in den Clientstatusparametern der zugehörigen Seite deklariert werden.

    Weitere Informationen zum Deklardieren von Client-Statusparametern finden Sie unter Arbeiten Sie mit Client-Statusparametern .
    CallbackFn Funktion Rückruffunktion, die ausgeführt werden soll, um den Wert zu erhalten.
    Tabelle : 55. Rückgaben
    Typ Beschreibung
    Keine

    Dieses Beispiel zeigt die Verwendung api.setState Um Anwender bei einer Seite anzumelden.

    function handler({api, event}) {
  const {name, value} = event.payload;
  if (name === 'username' || name === 'password') {
    // Update the loginParameters state object with the username/password value
    api.setState('loginParameters', ({currentValue}) => {
      return {
        ...currentValue,
        [name]: value
      };
    });
  }
}

    api: api.State.<client_state_parameter_name>

    Aktueller Wert des angegebenen Client-Statusparameters.

    Tabelle : 56. Feld
    Name Typ Beschreibung
    <client_state_parameter_name> Beliebig. Die verfügbaren Client-Statusparameter sind von der Seitenkonfiguration abhängig. Name des Client-Statusparameters. Verfügbare clientstatus hängen von der Client-Skriptimplementierung ab.

    Um auf die verfügbaren clientstatus zuzugreifen, verwenden Sie Folgendes: api.Status.<client_state_name> .

    Zum Beispiel: 
    function showRelatedLists({api}) { 
  return !api.state.isCustomListSelected; 
}
    Hinweis:
    Diese Eigenschaftswerte sind schreibgeschützt. Verwenden Sie , um einen Client-Statusparameter zu aktualisieren api.setState() . Das Mutation geschachtelter Objektwerte aus Skripts wird nicht unterstützt.