api: UI Builder

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 21 Minuten Lesedauer

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

    Diese API wird für Client-Skripts verfügbar gemacht. Diese werden auch als Seitenskripts bezeichnet. Client-Skripts werden als Reaktion auf etwas auf einer Seite ausgeführt, z. B.:
    • Anwenderinteraktionsereignisse/-aktionen, z. B. Klicken auf eine Schaltfläche.
    • Lebenszyklus-Ereignisse, wie z. B. die Ausführung eines Daten-Brokers, 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.
    • Transparenz der Komponenten wird bestimmt.
    • Ausgeben eines Ereignisses mit einer Nutzlast
    Diese Skripts können nicht als asynchrone Funktion geschrieben werden. Sie können auch keine Nebeneffektmethoden für das API-Objekt aufrufen, z. B. api.emit(), api.setState()und api.data.<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 in diesem Objekt nicht direkt ändern. Änderungen können nur mit den verfügbaren Methoden vorgenommen werden.

    API: api.context.props.<page_property_name>

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

    Tabelle : 1. Feld
    Name Typ Beschreibung
    <page_property_name> Beliebig Die verfügbaren Werte hängen von der Clientskript-Implementierung 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 Ändern geschachtelter Objektwerte aus Skripts wird nicht unterstützt.

    API: api.context.session.<session_property>

    Eigenschaften der Kontextsitzung, die dem aktuellen Anwender zugeordnet sind.

    Tabelle : 2. Verfügbare Sitzungseigenschaften
    Name Typ Beschreibung
    istAngemeldet Boolean Kennzeichnung, die angibt, ob der aktuelle Anwender beim System angemeldet ist.
    Mögliche Werte:
    • wahr: Der aktuelle Anwender ist bei angemeldet
    • false: Der aktuelle Anwender ist nicht angemeldet.
    properties.awaAktiviert Zeichenfolge Die Systemeigenschaft glide.awa.enabled, die angibt, ob die automatische Zuweisung von Arbeitselementen für die erweiterte Arbeitszuweisung (AWA) für den aktuellen Benutzer 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.vergessen.Wert Zeichenfolge Die Eigenschaft „glide.ui.vergessen“, die angibt, ob das Kontrollkästchen „Anwendernamen speichern“ auf der Anmeldeseite entfernt werden soll, um zu verhindern, dass Anmeldeinformationen zwischengespeichert werden.
    Mögliche Werte:
    • wahr: Checkbox „Anwendernamen speichern“ entfernen.
    • false: Checkbox „ Anwendernamen speichern“ anzeigen.

    Weitere Informationen finden Sie unter „Anwendernamen speichern“ entfernen.
    properties.sessionTimeLeft.value Zeichenfolge

    Zahl zu Zeichenfolge gezwungen

    		 Die Systemeigenschaft glide.ui.session_timeleft, die die verbleibende Zeit bis zum Timeout der aktuellen Sitzung bestimmt. Verwenden Sie diese Eigenschaft, um den Anwender aufzufordern, die aktuelle Sitzung zu verlängern, bevor sie abläuft.

    Einheit: Minuten
    properties.sessionTimeout.value Zeichenfolge

    Zahl zu Zeichenfolge gezwungen

    		 Die Systemeigenschaft „glide.ui.session_timeout“, die den anfänglichen Wert für die Sitzungsüberschreitung bestimmt.

    Einheit: Minuten – Werte über 1440 Minuten werden als ein Tag behandelt.

    Weitere Informationen finden Sie unter Zeitüberschreitung bei Sitzungsaktivität
    properties.trackingAktiviert.wert Zeichenfolge Die Systemeigenschaft glide.uxbuilder.tracking.enabled, die angibt, ob das Laden und die Instanziierung der Webanalysebibliothek für UI Builder -basierte Anwendungen aktiviert/deaktiviert werden soll.
    Mögliche Werte:
    • true: Für den Anwender aktiviert.
    • false: Für den Anwender deaktiviert.
    user.avatar Zeichenfolge URL des Avatars des aktuellen Anwenders.
    user.dateFormat Zeichenfolge Standarddatumsformat.
    user.domain Zeichenfolge Domänenpfad für den aktuellen Anwender.
    user.firstName Zeichenfolge Vorname des aktuellen Anwenders.
    user.fullName Zeichenfolge Vor- und Nachname des aktuellen Anwenders.
    user.initials Zeichenfolge Initialen des aktuellen Anwenders.
    Benutzer.Sprache Zeichenfolge Primäre Sprache, die vom aktuellen Anwender gesprochen wird.
    user.preferences Array von Objekten Name-Wert-Paare, die die Anwendereinstellungen beschreiben. Diese Anwendereinstellungen werden als Datensätze in der Tabelle „Anwendereinstellungen“ [sys_user_preference] gespeichert und werden jedes Mal aktualisiert, wenn der Anwender seine Einstellungen ändert.

    Weitere Informationen finden Sie unter Exploring user administration.
    user.roles Array Kommagetrennte Liste der Rollen, die dem aktuellen Anwender zugewiesen sind.
    Hinweis:
    Wenn dem Benutzer keine Rollen zugewiesen sind, gibt diese Kontextsitzungseigenschaft anstelle eines leeren Arrays NULL zurück.
    user.sys_id Zeichenfolge Sys_id des Anwenders in der Tabelle „Anwender“ [sys_user].
    user.timeFormat Zeichenfolge Standardzeitformat, das für den Anwender verwendet werden soll.
    user.timeZone 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 Instanz der Datenressourcen erfolgreich abgeschlossen wurde.

    Wenn der Wert „wahr“ ist, wurde der letzte Abrufversuch für die Instanz der Datenressourcen erfolgreich abgeschlossen. andernfalls „false“.

    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.

    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das den zu aktualisierenden Feldwert beschreibt.
    "payload": {
  "choiceIndex": "String",
  "choiceLabel": "String",
  "choiceValue": "String",
  "fieldName": "String"
}
    payload.choiceIndex Zeichenfolge Optional. Index in der Auswahlliste, an dem 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.
    Nutzlast.Feldname Zeichenfolge Name des Auswahlformularfelds, 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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    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 aus dem oberen Bereich des aktuellen Formulars.

    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das das Auswahltypfeld beschreibt, dessen Optionen gelöscht werden sollen.
    "payload": {
  "fieldName": "String"
}
    Nutzlast.Feldname Zeichenfolge Name des Auswahlfelds, 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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Beschreibung der auszuführenden UI-Aktion.
    "payload": {
  "actionSysId": "String"
}
    Nutzlast.AktionsSysId 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 das Feld mutates_server_data im entsprechenden Datenressourcendatensatz (Tabelle „sys_ux_data_broker_*“) auf „wahr“ festgelegt ist. Es ist unter api.data zugänglich.<data_resource_Id> .refresh() .
    Tabelle : 18. Parameter
    Name Typ Beschreibung
    data_resource_id Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource. Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    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 Sie auf die Schaltfläche Absenden auf der Seite klicken. Die Seite wird mit einer Serverdatenressource konfiguriert, die 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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das die auszublendende Feldnachricht beschreibt.
    "payload": {
  "clearAll": Boolean,
  "fieldName": "String"
}
    payload.clearAll Boolean Optional. Kennzeichnung, die angibt, ob alle dem angegebenen Formularfeld zugeordneten Nachrichten gelöscht werden sollen.
    Gültige Werte:
    • „wahr“: Löscht alle Nachrichten, die dem angegebenen Feld zugeordnet sind.
    • „falsch“: Es werden nicht alle Nachrichten gelöscht, die dem angegebenen Feld zugeordnet sind.

    Standardwert: false
    Nutzlast.Feldname 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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das die zugehörige Liste beschreibt, die ausgeblendet werden soll.
    "payload": {
  "listTableName ": "String"
}
    payload.listTableName Zeichenfolge Name der zugehörigen Liste, der ausgeblendet werden soll. Wenn die auszublendende Liste durch eine Beziehung verbunden ist, 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> .blendenZugehörigeListen()

    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

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

    api.data.gform.hideRelatedLists();

    API: api.data.<data_resource_id> .aktualisieren ()

    Löst einen Aktualisierungsvorgang für die angegebene nicht mutierende Datenressourceninstanz aus.

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

    Diese Methode ist asynchron und gibt ein internes Ereignis aus, um die Aktualisierung der angegebenen Instanz der Datenressourcen auszulösen. Mit UI Builder können Sie Client-Skripts als Reaktion auf Lebenszyklus-Ereignisse für Datenressourcen wie DATA_FETCH_SUCCEEDED und DATA_FETCH_FAILED auslösen. 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 das Feld mutates_server_data im entsprechenden Datenressourcendatensatz (Tabelle „sys_ux_data_broker_*“) auf „false“ festgelegt ist.
    Tabelle : 26. Parameter
    Name Typ Beschreibung
    data_resource_id Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource. Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Tabelle : 27. Ausgabe
    Typ Beschreibung
    Keine

    Dieses Codebeispiel zeigt ein Seitenskript, das aufgerufen wird, wenn auf einer Seite ein Dropdownelement ausgewählt wird. Die Seite ist mit zwei Serverdatenressourcen konfiguriert, die Problem- 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> .erneut laden ()

    Lädt das aktuelle Formular mit derselben Tabelle und 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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    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.
    Nutzlast.Feldname Zeichenfolge Name des Formularfelds vom Typ „Auswahl“, 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> .speichern()

    Löst die Formularübermittlung mithilfe der UI-Aktion „ Speichern“ aus.

    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

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

    api.data.gform.save();

    API: api.data.<data_resource_id> .setMandtory(Objektnutzlast)

    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das das Feld beschreibt, dessen obligatorische Informationen aktualisiert werden sollen.
    "payload": {
  "fieldName": "String",
  "mandatory": Boolean
}
    Nutzlast.Feldname Zeichenfolge Name des Formularfelds, dessen obligatorischer Wert festgelegt werden soll.
    Nutzlast.obligatorisch Boolean Kennzeichnung, die angibt, dass das angegebene Formularfeld obligatorisch ist. Das Formular kann also 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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das das Feld beschreibt, dessen Lesbarkeitsinformationen aktualisiert werden sollen.
    "payload": {
  "fieldName": "String",
  "readonly": Boolean
}
    Nutzlast.Feldname 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 mit 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 auch den Anzeigewert mit dem gleichen 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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das das Feld beschreibt, dessen Wert aktualisiert werden soll.
    "payload": {
  "displayValue": "String",
  "fieldName": "String",
  "value": "String"
}
    payload.displayValue Zeichenfolge Optional. Name des zu aktualisierenden Anzeigewerts. Wenn leer gelassen, wird der Anzeigewert nicht geändert.
    Nutzlast.Feldname 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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das das Feld beschreibt, für das die Sichtbarkeit festgelegt werden soll.
    "payload": {
  "fieldName": "String",
  "visibility": Boolean
}
    Nutzlast.Feldname 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: Das 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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das die anzuzeigende Feldnachricht beschreibt.
    "payload": {
  "fieldName": "String",
  "message": "String",
  "type": "String"
    Nutzlast.Feldname Zeichenfolge Name des Felds, neben dem die Nachricht angezeigt werden soll.
    Nutzlast.Nachricht Zeichenfolge Meldung, die angezeigt werden soll.
    Nutzlast.Typ 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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das die anzuzeigende zugehörige Liste beschreibt.
    "payload": {
  "listTableName ": "String"
}
    payload.listTableName Zeichenfolge Name der zugehörigen Liste, die angezeigt werden soll. Wenn die anzuzeigende Liste über eine Beziehung verfügt, 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> .anzeigenZugehörigeListen()

    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

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

    api.data.gform.showRelatedLists();

    API: api.data.<data_resource_id> .absenden ()

    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 die Komponente „Datensatzseiten-Registerkarten“ enthält, muss die Datenressource für diese Methode auf GlideForm (g_form) basieren.

    Die verfügbaren Instanzen der Datenressourcen sind konfigurationsabhängig und werden definiert, wenn Sie die Datenressource Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das die UI-Aktion beschreibt, die zum Senden des aktuellen Formulars verwendet werden soll.
    "payload": {
  "submitActionName": "String"
}
    payload.submitAktionsname Zeichenfolge Name der UI-Aktion, die zum Senden 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(String eventName, Object payload)

    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. Jeder api.emit -Aufruf, der Ereignisse sendet, die nicht in dieser Tabelle deklariert sind, wird ignoriert.

    Weitere Informationen zu Ereignissen finden Sie unter Mit Ereignissen arbeiten.

    Tabelle : 50. Parameter
    Name Typ Beschreibung
    eventName Zeichenfolge Name des auszugebenden Ereignisses. Dieser Name muss den Benennungsrichtlinien für UI-Framework-Aktionen entsprechen:
    • Muss Groß-/Kleinschreibung sein, z. B. ITEM_CHANGED. Alle Buchstaben in Großbuchstaben und alle Leerzeichen durch Unterstriche ersetzt.
    • Muss in der Vergangenheitsform sein, z. B. BUTTON_CLICKED oder USER_SELECTED.

    Weitere Informationen zu diesen Richtlinien für die Benennung von Aktionen 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 mit dem ausgegebenen Ereignis zu sendenden Daten enthält. Dieses Objekt ist eine Freiform und kann alle Daten enthalten, die von der Entität benötigt werden, die die Daten empfängt.
    Hinweis:
    Nutzlasten des Typs „Primitiv“ funktionieren, 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_NOTIFICATIONS mit einer zugehörigen Nutzlast items.

    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(Zeichenfolge 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 Wert an Eigenschaften von Komponenten übergeben werden, die auf der Seite verwendet werden. Sie können Client-Status auch in mehreren Seitenskripts aufrufen und aktualisieren. Ein häufiger Anwendungsfall besteht darin, die von Anwendern in mehreren Formularsteuerelemente auf einer Seite eingegebenen Werte nachzuverfolgen. Wenn das Formular übermittelt wird, kann ein Client-Skript alle in 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 über UI Builder für eine Seite deklarieren können. Anschließend können Sie einen Client-Statusparameter an eine oder mehrere Komponenten binden, um den Client-Statusparameter freizugeben oder darauf zu reagieren.

    api.setState() -Aufrufe werden asynchron ausgeführt und aktualisieren die Anwenderoberfläche nicht unbedingt sofort. Wenn der festzulegende Wert von currentValue des Client-Statusparameters oder einer der im API-Objekt angegebenen Eigenschaften abhängt, sollten Sie diese Variante der api.setState()- Methode verwenden, um die Verwendung veralteter Werte zu vermeiden.

    Tabelle : 52. Parameter
    Name Typ Beschreibung
    stateParm Zeichenfolge Name des zu aktualisierenden Client-Statusparameters. Dieser Name muss in den Client-Statusparametern der zugehörigen Seite deklariert werden.

    Weitere Informationen zum Deklarieren von Client-Statusparametern finden Sie unter Mit Client-Statusparametern arbeiten.
    Wert Beliebig: Muss mit der Client-Statusparameterdeklaration 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 kann, um den Statusparameter des E-Mail-Clients zu aktualisieren, wenn ein Eingabewert für eine now-input-Komponente festgelegt wird.

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

    api – setState(String 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: currentValue und api. Die Funktion darf niemals die Eigenschaft currentValue oder das Objekt api direkt ändern.

    Verwenden Sie Client-Statusparameter, um einen freigegebenen Status auf einer Seite beizubehalten. Der freigegebene Status kann dann als Wert an Eigenschaften von Komponenten übergeben werden, die auf der Seite verwendet werden. Sie können Client-Status auch in mehreren Seitenskripts aufrufen und aktualisieren. Ein häufiger Anwendungsfall besteht darin, die von Anwendern in mehreren Formularsteuerelemente auf einer Seite eingegebenen Werte nachzuverfolgen. Wenn das Formular übermittelt wird, kann ein Client-Skript alle in 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 über UI Builder für eine Seite deklarieren können. Anschließend können Sie einen Client-Statusparameter an eine oder mehrere Komponenten binden, um den Client-Statusparameter freizugeben oder darauf zu reagieren.

    api.setState() -Aufrufe werden asynchron ausgeführt und aktualisieren die Anwenderoberfläche nicht unbedingt sofort. Wenn der festzulegende Wert von currentValue des Client-Statusparameters oder einer der im API-Objekt angegebenen Eigenschaften abhängt, sollten Sie diese Variante der api.setState()- Methode verwenden, um die Verwendung veralteter Werte zu vermeiden.

    Tabelle : 54. Parameter
    Name Typ Beschreibung
    stateParm Zeichenfolge Name des zu aktualisierenden Client-Statusparameters. Dieser Name muss in den Client-Statusparametern der zugehörigen Seite deklariert werden.

    Weitere Informationen zum Deklarieren von Client-Statusparametern finden Sie unter Mit Client-Statusparametern arbeiten.
    callbackFn Funktion Auszuführende Rückruffunktion, um den Wert zu erhalten.
    Tabelle : 55. Rückgaben
    Typ Beschreibung
    Keine

    Dieses Beispiel zeigt, wie api.setState zum Anmelden von Anwendern auf einer Seite verwendet wird.

    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 hängen von der Seitenkonfiguration ab. Name des Client-Statusparameters. Verfügbare Client-Status hängen von der Client-Skript-Implementierung ab.

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

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