api – UI Builder

  • Freigeben Version: Washingtondc
  • Aktualisiert 1. Februar 2024
  • 21 Minuten Lesedauer

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

    Diese API ist für Client-Skripts verfügbar, die auch als Seitenskripts bezeichnet werden. Client-Skripts werden als Reaktion auf Vorgänge auf einer Seite ausgeführt, z. B.:
    • Benutzerinteraktionsereignisse/-aktionen, z. B. Klicken auf eine Schaltfläche.
    • Lebenszyklus-Events, z. B. eine gestartete Daten-Broker-Ausführung.
    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 von Komponenten bestimmen
    • Event wird mit einer Nutzlast ausgegeben.
    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 über die verfügbaren Methoden vorgenommen werden.

    api – api.context.props.<page_property_name>

    Seiteneigenschaften können in 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 Implementierung des Client-Skripts ab.

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

    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 verschachtelter Objektwerte aus Skripts wird nicht unterstützt.

    api – api.context.session.<session_property>

    Kontextsitzungseigenschaften, die dem aktuellen Benutzer zugeordnet sind.

    Tabelle : 2. Verfügbare Sitzungseigenschaften
    Name Typ Beschreibung
    istAngemeldet Boolean Kennzeichnung, die angibt, ob der aktuelle Benutzer beim System angemeldet ist.
    Mögliche Werte:
    • true: Der aktuelle Benutzer ist bei angemeldet
    • false: Der aktuelle Benutzer ist nicht angemeldet.
    properties.awaAktiviert Zeichenfolge Die Systemeigenschaft glide.awa.enabled, die angibt, ob die automatische Zuweisung für Arbeitselemente für Advanced Work Assignment (AWA) für den aktuellen Benutzer aktiviert ist.
    Mögliche Werte:
    • true: AWA ist für den Benutzer aktiviert.
    • false: AWA ist für den Benutzer nicht aktiviert.

    Weitere Informationen finden Sie unter Mit Advanced Work Assignment installierte Komponenten.
    properties.forgetMe.value Zeichenfolge Die Eigenschaft glide.ui.forgetme, die angibt, ob das Kontrollkästchen „Benutzernamen speichern“ von der Anmeldeseite entfernt werden soll, um zu verhindern, dass Anmeldeinformationen zwischengespeichert werden.
    Mögliche Werte:
    • true: Entfernen Sie das Kontrollkästchen „Benutzernamen speichern“.
    • false: Checkbox „Benutzernamen speichern “ anzeigen.

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

    Zahl, die in eine Zeichenfolge umgewandelt wurde

    		 Die Systemeigenschaft glide.ui.session_timeleft, die die verbleibende Zeit bis zum Ablauf der aktuellen Sitzung bestimmt. Verwenden Sie diese Eigenschaft, um den Benutzer aufzufordern, die aktuelle Sitzung zu erweitern, bevor das Zeitlimit überschritten wird.

    Einheit: Minuten
    properties.sessionTimeout.value Zeichenfolge

    Zahl, die in eine Zeichenfolge umgewandelt wurde

    		 Die Systemeigenschaft glide.ui.session_timeout, die den anfänglichen Zeitüberschreitungswert der Sitzung bestimmt.

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

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

    Weitere Informationen finden Sie unter Exploring user administration.
    user.roles Array Kommagetrennte Liste der Rollen, die dem aktuellen Benutzer zugewiesen sind.
    Hinweis:
    Wenn dem Benutzer keine Rollen zugewiesen sind, gibt diese Kontextsitzungseigenschaft NULL und kein leeres Array zurück.
    user.sys_id Zeichenfolge Sys_id des Benutzers in der Benutzertabelle [sys_user].
    user.timeFormat Zeichenfolge Standardmäßiges Zeitformat, das für den Benutzer verwendet werden soll.
    Benutzer.Zeitzone Zeichenfolge Zeitzone des aktuellen Benutzers.
    user.timeZoneOffset Zeichenfolge Zeitzonenverschiebung des aktuellen Benutzers.

    api – api.data.<data_resource_id> .Lebenszyklus.lastFetchSucceeded

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

    Wenn der Wert „true“ ist, wurde der letzte Abrufversuch für die Datenressourceninstanz 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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das die anzuzeigende Informationsnachricht beschreibt.
    "payload": {
  "message": "String"
}
    Nutzlast.Nachricht Zeichenfolge Anzuzeigende Informationsnachricht.
    Tabelle : 7. Ergebnisse
    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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 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 Auswahltyp-Formularfelds, dem die angegebene Option hinzugefügt werden soll.
    Tabelle : 9. Ergebnisse
    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das die anzuzeigende Warnmeldung beschreibt.
    "payload": {
  "message": "String"
}
    Nutzlast.Nachricht Zeichenfolge Anzuzeigende Warnmeldung.
    Tabelle : 11. Ergebnisse
    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das das Auswahlfeld beschreibt, dessen Optionen gelöscht werden sollen.
    "payload": {
  "fieldName": "String"
}
    payload.fieldName Zeichenfolge Name des Auswahltypfelds, dessen Optionen gelöscht werden sollen.
    Tabelle : 15. Ergebnisse
    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das die auszuführende UI-Aktion beschreibt.
    "payload": {
  "actionSysId": "String"
}
    nutzlast.actionSysId Zeichenfolge Sys_id der auszuführenden UI-Aktion. Befindet sich in der Tabelle „UI-Aktion“ [sys_ui_action].
    Tabelle : 17. Ergebnisse
    Typ Beschreibung
    Keine 

    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 einen der folgenden Typen aufweist:
    • Zusammenfassung
    • GraphQL
    • REST
    • Skriptlet
    • Umwandeln
    Hinweis:
    Diese Methode ist nur verfügbar, wenn das Feld mutates_server_data im entsprechenden Datensatz der Datenressource (Tabelle sys_ux_data_broker_*) auf „ true “ festgelegt ist. Sie 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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. Ergebnisse
    Typ Beschreibung
    Keine

    Dieses Codebeispiel zeigt ein Seitenskript, das aufgerufen wird, wenn auf der Seite auf die Schaltfläche Absenden geklickt wird. 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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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 Nachrichten, die dem angegebenen Formularfeld zugeordnet sind, gelöscht werden sollen.
    Gültige Werte:
    • true: Alle Nachrichten löschen, die dem angegebenen Feld zugeordnet sind.
    • false: Löscht 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 zugeordneten Nachrichten gelöscht werden sollen.
    Tabelle : 21. Ergebnisse
    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das die auszublendende zugehörige Liste beschreibt.
    "payload": {
  "listTableName ": "String"
}
    payload.listTableName Zeichenfolge Name der zugehörigen Liste, die ausgeblendet werden soll. Befindet sich in der Tabelle „Zugehörige Liste“ [sys_ui_related_list]. Wenn die auszublendende Liste eine Beziehung ist, geben Sie die sys_id der Liste anstelle des Namens an.
    Tabelle : 23. Ergebnisse
    Typ Beschreibung
    Keine 

    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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 „false“ festgelegt ist.

    Diese Methode ist asynchron und gibt ein internes Event aus, um die Aktualisierung der angegebenen Datenressourceninstanz auszulösen. Mit UI Builder können Sie Client-Skripts als Reaktion auf Datenressourcen-Lebenszyklus-Ereignisse wie DATA_FETCH_SUCCEEDED und DATA_FETCH_FAILED auslösen. Weitere Informationen zu diesen Events finden Sie unter Event-Zuordnung.

    Diese Methode ist nur verfügbar, wenn die Datenressource einen der folgenden Typen aufweist:
    • Zusammenfassung
    • GraphQL
    • REST
    • Skriptlet
    • Umwandeln
    Hinweis:
    Diese Methode ist nur verfügbar, wenn das Feld mutates_server_data im entsprechenden Datenressourcendatensatz (sys_ux_data_broker_* table) auf „ false “ festgelegt ist.
    Tabelle : 26. Parameter
    Name Typ Beschreibung
    data_resource_id Zeichenfolge Eindeutiger Bezeichner der zugeordneten Datenressource. Die verfügbaren Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    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 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> .reload()

    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    Nutzlast Objekt Objekt, das das zu aktualisierende Auswahlfeld 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 Auswahlformularfelds, aus dem der angegebene Wert entfernt werden soll.
    Tabelle : 31. Ergebnisse
    Typ Beschreibung
    Keine 

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

    api – api.data.<data_resource_id> .speichern()

    Löst die Formularübermittlung mit 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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    Tabelle : 33. Ausgabe
    Typ Beschreibung
    Keine 

    api.data.gform.save();

    api – api.data.<data_resource_id> .setMandatory(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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    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 obligatorischer Wert festgelegt werden soll.
    Nutzlast.obligatorisch Boolean Kennzeichnung, die angibt, dass das angegebene Formularfeld obligatorisch ist, was bedeutet, dass das Formular nicht gespeichert werden kann, ohne dass dieses Feld einen gültigen Wert enthält.
    Gültige Werte:
    • true: Feld ist ein Pflichtfeld.
    • false: Feld ist optional.
    Tabelle : 35. Ergebnisse
    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    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:
    • true: Feld ist schreibgeschützt.
    • false: Feld ist Lesen/Schreiben.
    Tabelle : 37. Ergebnisse
    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 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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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"
}
    Nutzlast.Anzeigewert Zeichenfolge Optional. Name des zu aktualisierenden Anzeigewerts. Wenn das Feld leer gelassen wird, 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. Ergebnisse
    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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
}
    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:
    • true: Feld wird im Formular angezeigt.
    • false: Feld wird nicht im Formular angezeigt.
    Tabelle : 41. Ergebnisse
    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    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.
    Nutzlast.Typ Zeichenfolge Optional. Typ der anzuzeigenden Nachricht.
    Gültige Werte:
    • Fehler
    • Info
    • Warnung

    Standard: info
    Tabelle : 43. Ergebnisse
    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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. Befindet sich in der Tabelle „Zugehörige Liste“ [sys_ui_related_list]. Wenn die anzuzeigende Liste eine Beziehung durchläuft, geben Sie die sys_id der Liste anstelle des Namens an.
    Tabelle : 45. Ergebnisse
    Typ Beschreibung
    Keine 

    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu Ihrer Seite in UI Builderhinzufügen.
    Tabelle : 47. Ausgabe
    Typ Beschreibung
    Keine 

    api.data.gform.showRelatedLists();

    api – api.data.<data_resource_id> .senden()

    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 CTRL_RECORD#SAVE_FORM des Formular-Controllers 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 Datenressourceninstanzen sind konfigurationsabhängig und definiert, wenn Sie die Datenressource zu 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.submitActionName Zeichenfolge Name der UI-Aktion, die ausgeführt werden soll, um das aktuelle Formular zu übermitteln.
    Tabelle : 49. Ergebnisse
    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 Event-Name muss Teil der Liste der gesendeten Events der zugeordneten Seitendefinition sein, die in der Tabelle „UX Macroponent-Definition“ [sys_ux_macroponent] gespeichert ist. Jeder api.emit -Aufruf, der Events auslöst, die nicht in dieser Tabelle deklariert sind, wird ignoriert.

    Weitere Informationen zu Events finden Sie unter Mit Events arbeiten.

    Tabelle : 50. Parameter
    Name Typ Beschreibung
    eventName Zeichenfolge Name des auszugebenden Events. Dieser Name sollte den Benennungsrichtlinien für UI Framework-Aktionen entsprechen:
    • Muss in Großbuchstaben angegeben werden, 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 Event 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 primitiven Typs funktionieren, können jedoch zu inkonsistentem Verhalten führen.
    Tabelle : 51. Ergebnisse
    Typ Beschreibung
    Keine

    Das folgende Codebeispiel zeigt die Ausgabe eines Events namens NOW_UXF_PAGE#ADD_NOTIFICATIONS mit einer zugeordneten 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(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 Client-Status auch in Skripts mit mehreren Seiten aufrufen und aktualisieren. Ein häufiger Anwendungsfall besteht darin, Werte nachzuverfolgen, die von Benutzern in mehreren Formularsteuerelementen auf einer Seite eingegeben wurden. 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 für eine Seite über den UI Builder deklarieren können. Sie können dann einen Client-Statusparameter an eine oder mehrere Komponenten binden, um den Client-Statusparameter freizugeben oder zu bearbeiten.

    api.setState()- Aufrufe werden asynchron ausgeführt und aktualisieren die Benutzeroberfläche nicht unbedingt sofort. Wenn der festzulegende Wert von currentValue des Statusparameters des Clients oder einer der im API-Objekt bereitgestellten 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 zugeordneten Seite deklariert werden.

    Weitere Informationen zum Deklarieren von Client-Statusparametern finden Sie unter Mit Client-Statusparametern arbeiten.
    Wert Beliebig: Muss mit der Statusparameterdeklaration des Clients identisch sein. Wert, auf den der angegebene Statusparameter des Clients festgelegt werden soll.
    Tabelle : 53. Ergebnisse
    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, Function callbackFn)

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

    Die Rückruffunktion wird mit einem Objekt mit zwei Eigenschaften aufgerufen: currentValue und api. Die Funktion sollte 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 Werte an Eigenschaften von Komponenten übergeben werden, die auf der Seite verwendet werden. Sie können Client-Status auch in Skripts mit mehreren Seiten aufrufen und aktualisieren. Ein häufiger Anwendungsfall besteht darin, Werte nachzuverfolgen, die von Benutzern in mehreren Formularsteuerelementen auf einer Seite eingegeben wurden. 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 für eine Seite über den UI Builder deklarieren können. Sie können dann einen Client-Statusparameter an eine oder mehrere Komponenten binden, um den Client-Statusparameter freizugeben oder zu bearbeiten.

    api.setState()- Aufrufe werden asynchron ausgeführt und aktualisieren die Benutzeroberfläche nicht unbedingt sofort. Wenn der festzulegende Wert von currentValue des Statusparameters des Clients oder einer der im API-Objekt bereitgestellten 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 zugeordneten Seite deklariert werden.

    Weitere Informationen zum Deklarieren von Client-Statusparametern finden Sie unter Mit Client-Statusparametern arbeiten.
    RückrufFn Funktion Rückruffunktion, die ausgeführt werden soll, um den Wert zu erhalten.
    Tabelle : 55. Ergebnisse
    Typ Beschreibung
    Keine

    Dieses Beispiel zeigt, wie api.setState verwendet wird, um Benutzer auf 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 hängen von der Seitenkonfiguration ab. Name des Client-Statusparameters. Die verfügbaren 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> .

    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 verschachtelter Objektwerte aus Skripts wird nicht unterstützt.