UI-Aktions-API – ServiceNow Fluent
Die UI-Aktions-API definiert anwenderdefinierte Anwenderoberflächenaktionen [sys_ui_action], z. B. Schaltflächen, Links und Kontextmenüelemente in Formularen und Listen.
Allgemeine Informationen zu UI-Aktionen finden Sie unter Create a UI action.
UiAction-Objekt
Erstellen Sie eine UI-Aktion [sys_ui_action], die in einem Formular angezeigt werden soll.
| Name | Typ | Beschreibung |
|---|---|---|
| $ID | Zeichenfolge oder Zahl | Erforderlich. Eine eindeutige ID für das Metadatenobjekt. Wenn Sie die Anwendung erstellen, wird diese ID in eine eindeutige sys_ID gehasht Weitere Informationen finden Sie unter ServiceNow Fluent Sprachkonstrukte. Format: |
| table | Zeichenfolge | Erforderlich. Der Name der Tabelle, für die die UI-Aktion verfügbar ist. Standardmäßig wird die UI-Aktion auch in Tabellen angezeigt, die die ausgewählte Tabelle erweitern. Beispielsweise werden Aufgabenaktionen in der Incident-Tabelle angezeigt. Legen Sie den Wert auf fest |
| Name | Zeichenfolge | Erforderlich. Der Text, der auf der Schaltfläche, dem Link oder dem Kontextmenüelement angezeigt wird. Der Name muss innerhalb der angegebenen Tabelle eindeutig sein. |
| actionName | Zeichenfolge | Ein eindeutiger Name, der verwendet werden soll, wenn in Skripts auf die UI-Aktion verwiesen wird. |
| aktiv | Boolean | Kennzeichnung, die angibt, ob die UI-Aktion aktiviert ist. Gültige Werte:
Standardwert: wahr |
| Formular | Objekt | Optionen für die Anzeige von UI-Aktionen in Formularen. Weitere Informationen finden Sie unter Formularobjekt. |
| Liste | Objekt | Optionen für die Anzeige von UI-Aktionen in der Listenansicht. Weitere Informationen finden Sie unter Listenobjekt. |
| Client | Objekt | Optionen zum Ausführen des Skripts im Browser. Weitere Informationen finden Sie unter Client-Objekt. |
| workspace | Objekt | Optionen für die Funktion und Anzeige von UI-Aktionen in Arbeitsbereichen. Weitere Informationen finden Sie unter Arbeitsbereichsobjekt. |
| overrides | Zeichenfolge oder Referenz | Der Name oder Variablenbezeichner einer anderen UI-Aktion, die die UI-Aktion überschreibt. |
| ShowEinfügen | Boolean | Kennzeichnung, die angibt, ob eine Schaltfläche in neuen Datensätzen angezeigt werden soll, bevor sie eingefügt werden. Gültige Werte:
Standardwert: false |
| ShowUpdate | Boolean | Kennzeichnung, die angibt, ob eine Schaltfläche in vorhandenen Datensätzen angezeigt werden soll. Gültige Werte:
Standardwert: wahr |
| ShowQuery | Boolean | Kennzeichnung, die angibt, ob die UI-Aktion in einer Liste sichtbar ist, wenn eine Filterabfrage angewendet wird. Gültige Werte:
Standardwert: false |
| ShowMultipleUpdate | Boolean | Kennzeichnung, die angibt, ob eine Schaltfläche angezeigt werden soll, wenn mehrere Datensätze ausgewählt sind. Gültige Werte:
Standardwert: false |
| Bedingung | Zeichenfolge | Eine bedingte JavaScript-Anweisung, die die Felder und Werte angibt, die „wahr“ sein müssen, damit das Skript ausgeführt werden kann. Hinweis:
Format:
|
| Skript | Skript | Ein clientseitiges oder serverseitiges Skript, das ausgeführt wird, wenn die UI-Aktion ausgeführt wird. Funktionsnamen müssen eindeutig sein. Diese Eigenschaft unterstützt Inline-JavaScript oder einen Verweis auf eine andere Datei in der Anwendung, die ein Skript enthält. Format:
|
| Kommentare | Zeichenfolge | Interne Hinweise zur UI-Aktion. |
| Nachrichten | Zeichenfolge | Textzeichenfolgen, die die UI-Aktion als Schlüssel verwenden kann, um eine lokalisierte Nachrichtenalternative aus der Tabelle „Nachricht“ [sys_ui_message] zu suchen. Jeder Nachrichtenschlüssel befindet sich in einer separaten Zeile im Feld Nachrichten. Die Instanz sucht immer dann nach einer lokalisierten Nachrichtenzeichenfolge, wenn die UI-Aktion einen ausführt Getmessage(„[message]“) Aufruf, bei dem die Nachrichtenzeichenfolge mit einem Schlüssel im Feld „Nachrichten“ übereinstimmt. Weitere Informationen finden Sie unter Übersetzen Sie eine Client-Skriptnachricht . |
| Tipp | Zeichenfolge | Eine kurze Beschreibung der UI-Aktion, die als Tooltip angezeigt wird, wenn der Mauszeiger darüber bewegt wird. |
| Reihenfolge | Nummer | Die Reihenfolge, in der die UI-Aktion angezeigt wird. Die Reihenfolge gilt für Schaltflächen von links nach rechts und für Menüaktionen von oben nach unten. Standard: 100 |
| IsolateScript | Boolean | Kennzeichnung, die angibt, ob das Skript im strikten Modus ausgeführt wird, wobei der Zugriff auf direktes DOM, jQuery, Prototyp und das Fensterobjekt deaktiviert ist. Gültige Werte:
Standardwert: false |
| Rollen | Array | Eine Liste von Variablenbezeichnern von Rolle Objekte oder Namen von Rollen, die für die Anwendung der UI-Aktion erforderlich sind. Weitere Informationen finden Sie unter Rollen-API – ServiceNow Fluent. |
| EinschließenInViews | Array | Eine Liste von Namen von Ansichten, in denen die UI-Aktion enthalten ist. |
| Ausschließenvon Ansichten | Array | Eine Liste von Namen von Ansichten, von denen die UI-Aktion ausgeschlossen ist. |
| $Meta | Objekt | Metadaten für die Anwendungsmetadaten. Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird. Gültige Werte für InstallMethod :
|
import { UiAction } from '@servicenow/sdk/core'
UiAction({
$id: Now.ID['car_info'],
table: 'x_snc_ts_custom_cars',
actionName: 'Car Information',
name: 'View car info',
active: true,
showInsert: true,
showUpdate: true,
hint: 'View car info',
condition: "current.type == 'SUV'",
form: {
showButton: true,
showLink: true,
showContextMenu: false,
style: 'destructive',
},
list: {
showLink: true,
style: 'primary',
showButton: true,
showContextMenu: false,
showListChoice: false,
showBannerButton: true,
showSaveWithFormButton: true,
},
workspace: {
isConfigurableWorkspace: true,
showFormButtonV2: true,
showFormMenuButtonV2: true,
clientScriptV2: `function onClick(g_form) {
}`,
},
script: `current.name = "updated by script";
current.update();`,
roles: ['u_requestor'],
client: {
isClient: true,
isUi11Compatible: true,
isUi16Compatible: true,
},
order: 100,
showQuery: false,
showMultipleUpdate: false,
isolateScript: false,
includeInViews: ['specialView'],
excludeFromViews: [],
})Formularobjekt
Konfigurieren Sie, wie eine UI-Aktion in einem Formular angezeigt wird.
Die Formular Objekt ist eine Eigenschaft innerhalb von UiAktion Objekt.
| Name | Typ | Beschreibung |
|---|---|---|
| ShowButton | Boolean | Kennzeichnung, die angibt, ob eine Schaltfläche in ein Formular aufgenommen werden soll. Gültige Werte:
Standardwert: false |
| ShowLink | Boolean | Kennzeichnung, die angibt, ob ein Link in den Abschnitt „zugehörige Links“ eines Formulars aufgenommen werden soll. Gültige Werte:
Standardwert: false |
| ShowContextMenu | Boolean | Kennzeichnung, die angibt, ob ein Element in das Kontextmenü eines Formulars aufgenommen werden soll. Gültige Werte:
Standardwert: false |
| Stil | Zeichenfolge | Ein Stil, der definiert, wie UI-Aktionsschaltflächen in einem Formular angezeigt werden. Gültige Werte:
|
| $Meta | Objekt | Metadaten für die Anwendungsmetadaten. Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird. Gültige Werte für InstallMethod :
|
form: {
showButton: true,
showLink: true,
showContextMenu: false,
style: 'destructive',
}Listenobjekt
Konfigurieren Sie, wie eine UI-Aktion in der Listenansicht angezeigt wird.
Die Liste Objekt ist eine Eigenschaft innerhalb von UiAktion Objekt.
| Name | Typ | Beschreibung |
|---|---|---|
| ShowButton | Boolean | Kennzeichnung, die angibt, ob eine Schaltfläche am Ende einer Liste eingefügt werden soll. Hinweis: Schaltflächen am unteren Rand einer Liste werden unabhängig von der Bedingung angezeigt und pro Datensatz bei der Ausführung ausgewertet. Gültige Werte:
Standardwert: false |
| ShowLink | Boolean | Kennzeichnung, die angibt, ob ein Link in den Abschnitt „zugehörige Links“ einer Liste aufgenommen werden soll. Gültige Werte:
Standardwert: false |
| ShowContextMenu | Boolean | Kennzeichnung, die angibt, ob ein Element in das Kontextmenü einer Liste aufgenommen werden soll. Gültige Werte:
Standardwert: false |
| Stil | Zeichenfolge | Ein Stil, der definiert, wie UI-Aktionsschaltflächen in der Listenansicht angezeigt werden. Gültige Werte:
|
| ShowListChoice | Boolean | Kennzeichnung, die angibt, ob eine Auswahl in die Aktionsliste einer Liste aufgenommen werden soll. Hinweis: Auswahlmöglichkeiten in der Liste „Aktionen“ werden unabhängig von der Bedingung angezeigt und pro Datensatz bei der Ausführung ausgewertet. Gültige Werte:
Standardwert: false |
| ShowBannerButton | Boolean | Kennzeichnung, die angibt, ob eine Schaltfläche in das Banner einer Liste aufgenommen werden soll. Hinweis: Schaltflächen im Banner einer Liste sind nicht dafür vorgesehen, datensatzspezifische Bedingungen zu unterstützen. Nur die erste Zeile wird berücksichtigt, wenn die Bedingung ausgewertet wird, um zu bestimmen, ob die Schaltfläche für die Liste angezeigt wird. Verwenden Sie keine datensatzspezifischen Bedingungen wie Current.getValue('State') === 'Closed' .Gültige Werte:
Standardwert: false |
| ShowSaveWithFormButton | Boolean | Kennzeichnung, die angibt, ob das Formular beim Zugriff aus einer Liste gespeichert wird, bevor die UI-Aktionsschaltfläche ausgeführt wird. Gültige Werte:
Standardwert: false |
| $Meta | Objekt | Metadaten für die Anwendungsmetadaten. Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird. Gültige Werte für InstallMethod :
|
list: {
showButton: true,
showLink: true,
showContextMenu: false,
style: 'primary',
showListChoice: false,
showBannerButton: true,
showSaveWithFormButton: true,
}Client-Objekt
Konfigurieren Sie Optionen zum Ausführen des UI-Aktionsskripts im Browser.
Die Client Objekt ist eine Eigenschaft innerhalb von UiAktion Objekt.
| Name | Typ | Beschreibung |
|---|---|---|
| IsClient | Boolean | Kennzeichnung, die angibt, wo das UI-Aktionsskript ausgeführt wird. Gültige Werte:
Standardwert: false |
| IsUi11kompatibel | Boolean | Kennzeichnung, die angibt, ob die UI-Aktion in der Legacy-UI 11 unterstützt wird. Gültige Werte:
Standardwert: false |
| IsUi16kompatibel | Boolean | Kennzeichnung, die angibt, ob die UI-Aktion in der Core-UI unterstützt wird. Gültige Werte:
Standardwert: false |
| Beim Klicken | Zeichenfolge | Der Name der JavaScript-Funktion, die ausgeführt werden soll, wenn die UI-Aktion ausgeführt wird. Die Funktion wird mit definiert Skript Eigenschaft. |
| $Meta | Objekt | Metadaten für die Anwendungsmetadaten. Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird. Gültige Werte für InstallMethod :
|
client: {
isClient: true,
isUi11Compatible: true,
isUi16Compatible: true,
onClick: 'reopenIncident()'
}Arbeitsbereichsobjekt
Konfigurieren Sie, wie eine UI-Aktion in Arbeitsbereichen funktioniert und angezeigt wird.
Die Arbeitsbereich Objekt ist eine Eigenschaft innerhalb von UiAktion Objekt.
| Name | Typ | Beschreibung |
|---|---|---|
| IsConfigurableWorkspace | Boolean | Kennzeichnung, die den Typ des Arbeitsbereichs angibt, in dem eine UI-Aktion gilt. Gültige Werte:
Standardwert: false |
| ShowFormSchaltflächenV2 | Boolean | Kennzeichnung, die angibt, ob eine Schaltfläche in Formularen in einem Arbeitsbereich eingefügt werden soll. Gültige Werte:
Standardwert: false |
| ShowFormMenuButtonV2 | Boolean | Kennzeichnung, die angibt, ob ein Element in das Menü „weitere Aktionen“ in einem Arbeitsbereich aufgenommen werden soll. Gültige Werte:
Standardwert: false |
| ClientScriptV2 | Zeichenfolge | Ein Skript, das ausgeführt wird, wenn die UI-Aktion in Arbeitsbereichen ausgeführt wird. Diese Eigenschaft unterstützt Inline-JavaScript oder einen Verweis auf eine andere Datei in der Anwendung, die ein Skript enthält. Format:
|
| $Meta | Objekt | Metadaten für die Anwendungsmetadaten. Mit InstallMethod Eigenschaft können Sie die Anwendungsmetadaten einem Ausgabeverzeichnis zuordnen, das nur unter bestimmten Umständen geladen wird. Gültige Werte für InstallMethod :
|
workspace: {
isConfigurableWorkspace: true,
showFormButtonV2: true,
showFormMenuButtonV2: true,
clientScriptV2: `function onClick(g_form) {
}`,
}