API d’action d’interface utilisateur : ServiceNow Fluent
L’API Action d’interface utilisateur définit les actions d’interface utilisateur personnalisées [sys_ui_action], telles que les boutons, les liens et les éléments de menu contextuel sur les formulaires et les listes.
Pour des informations générales sur les actions d’interface utilisateur, reportez-vous à la section Create a UI action.
Objet UiAction
Créez une action d’interface utilisateur [sys_ui_action] à afficher sur un formulaire.
| Nom | Type | Description |
|---|---|---|
| $id | Chaîne ou numéro | Requis. ID unique pour l’objet de métadonnées. Lorsque vous créez l’application, cet ID est haché en une sys_id unique. Pour en savoir plus, consultez ServiceNow Fluent Constructions linguistiques. Format : |
| Table | Chaîne | Requis. Le nom de la table sur laquelle l’action d’interface utilisateur est disponible. Par défaut, l’action d’interface utilisateur s’affiche également sur les tables qui étendent la table sélectionnée. Par exemple, les actions de tâche s’affichent dans la table Incident. Définissez la valeur sur |
| nom | Chaîne | Requis. Texte qui apparaît sur le bouton, le lien ou l’élément de menu contextuel. Le nom doit être unique dans la table spécifiée. |
| actionName | Chaîne | Nom unique à utiliser pour faire référence à l’action d’interface utilisateur dans les scripts. |
| actif | Booléen | Marqueur indiquant si l’action d’interface utilisateur est activée. Valeurs valides :
Par défaut : true |
| formulaire | Objet | Options pour la façon dont les actions d’interface utilisateur apparaissent sur les formulaires. Pour plus d'informations, consultez Objet de formulaire. |
| liste | Objet | Options concernant le mode d’affichage des actions d’interface utilisateur dans la vue de liste. Pour plus d'informations, consultez Objet de liste. |
| client | Objet | Options permettant d’exécuter le script dans le navigateur. Pour plus d'informations, consultez Objet client. |
| espace de travail | Objet | Options définissant le fonctionnement et l’apparition des actions d’interface utilisateur dans les espaces de travail. Pour plus d'informations, consultez Objet d’espace de travail. |
| Remplace | Chaîne ou référence | Nom ou identificateur de variable d’une autre action d’interface utilisateur que l’action d’interface utilisateur remplace. |
| showInsert | Booléen | Marqueur indiquant s’il faut afficher un bouton sur les nouveaux enregistrements avant qu’ils ne soient insérés. Valeurs valides :
Valeur par défaut : false |
| showUpdate | Booléen | Marqueur indiquant s’il faut afficher un bouton sur les enregistrements existants. Valeurs valides :
Par défaut : true |
| showQuery | Booléen | Marqueur indiquant si l’action d’interface utilisateur est visible sur une liste lorsqu’une requête de filtre est appliquée. Valeurs valides :
Valeur par défaut : false |
| showMultipleUpdate | Booléen | Marqueur indiquant s’il faut afficher un bouton lorsque plusieurs enregistrements sont sélectionnés. Valeurs valides :
Valeur par défaut : false |
| condition | Chaîne | Une instruction conditionnelle JavaScript qui spécifie les champs et les valeurs qui doivent être vrais pour que le script s’exécute. Remarque :
Format :
|
| script | Script | Un script côté client ou côté serveur qui s’exécute lorsque l’action d’interface utilisateur est exécutée. Les noms de fonction doivent être uniques. Cette propriété prend en charge le JavaScript en ligne ou une référence à un autre fichier dans l’application qui contient un script. Format :
|
| commentaires | Chaîne | Notes internes sur l’action d’interface utilisateur. |
| messages | Chaîne | Chaînes de texte que l’action d’interface utilisateur peut utiliser comme clé pour rechercher une alternative de message localisé à partir de la table Message [sys_ui_message]. Chaque clé de message se trouve sur une ligne distincte dans le champ Messages. L’instance recherche une chaîne de message localisée chaque fois que l’action d’interface utilisateur effectue un appel getmessage(« [message] ») où la chaîne de message correspond à une clé dans le champ Messages. Pour plus d’informations, consultez Traduire un message en script client. |
| hint | Chaîne | Brève description de l’action d’interface utilisateur qui s’affiche sous forme d’info-bulle lorsque vous la survolez. |
| order | Numéro | Ordre dans lequel l’action d’interface utilisateur apparaît. L’ordre s’applique aux boutons de gauche à droite et aux actions de menu de haut en bas. Par défaut : 100 |
| isoler le script | Booléen | Marqueur indiquant si le script s’exécute en mode strict, avec l’accès au DOM direct, au jQuery, au prototype et à l’objet de fenêtre désactivé. Valeurs valides :
Valeur par défaut : false |
| roles | Tableau | Une liste d’identificateurs de variables d’objets de rôle ou de noms de rôles requis pour que l’action d’interface utilisateur s’applique. Pour en savoir plus, consultez API du rôle : ServiceNow Fluent. |
| includeInViews | Tableau | Liste des noms des vues dans lesquelles l’action d’interface utilisateur est incluse. |
| excludeFromViews | Tableau | Liste des noms des vues dont l’action d’interface utilisateur est exclue. |
| $meta | Objet | Métadonnées pour les métadonnées de l’application. Avec la propriété installMethod , vous pouvez mapper les métadonnées d’application à un répertoire de sortie qui ne se charge que dans des circonstances spécifiques. Valeurs valides pour 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: [],
})Objet de formulaire
Configurez la façon dont une action d’interface utilisateur apparaît sur un formulaire.
L’objet de formulaire est une propriété de l’objet UiAction .
| Nom | Type | Description |
|---|---|---|
| showButton | Booléen | Marqueur indiquant s’il faut inclure un bouton sur un formulaire. Valeurs valides :
Valeur par défaut : false |
| showLink | Booléen | Marqueur indiquant s’il faut inclure un lien dans la section Liens connexes d’un formulaire. Valeurs valides :
Valeur par défaut : false |
| showContextMenu | Booléen | Marqueur indiquant s’il faut inclure un élément dans le menu contextuel d’un formulaire. Valeurs valides :
Valeur par défaut : false |
| Le style | Chaîne | Style qui définit l’apparence des boutons d’action d’interface utilisateur sur un formulaire. Valeurs valides :
|
| $meta | Objet | Métadonnées pour les métadonnées de l’application. Avec la propriété installMethod , vous pouvez mapper les métadonnées d’application à un répertoire de sortie qui ne se charge que dans des circonstances spécifiques. Valeurs valides pour installMethod :
|
form: {
showButton: true,
showLink: true,
showContextMenu: false,
style: 'destructive',
}Objet de liste
Configurez le mode d’affichage d’une action d’interface utilisateur dans la vue de liste.
L’objet list est une propriété de l’objet UiAction .
| Nom | Type | Description |
|---|---|---|
| showButton | Booléen | Marqueur indiquant s’il faut inclure un bouton en bas d’une liste. Remarque : Les boutons situés en bas d’une liste apparaissent quelle que soit la condition et sont évalués par enregistrement lors de leur exécution. Valeurs valides :
Valeur par défaut : false |
| showLink | Booléen | Marqueur indiquant s’il faut inclure un lien dans la section Liens connexes d’une liste. Valeurs valides :
Valeur par défaut : false |
| showContextMenu | Booléen | Marqueur indiquant s’il faut inclure un élément dans le menu contextuel d’une liste. Valeurs valides :
Valeur par défaut : false |
| Le style | Chaîne | Style qui définit le mode d’affichage des boutons d’action d’interface utilisateur dans la vue de liste. Valeurs valides :
|
| showListChoice | Booléen | Marqueur indiquant s’il faut inclure un choix dans la liste Actions d’une liste. Remarque : Les choix de la liste Actions apparaissent quelle que soit la condition et sont évalués par enregistrement lors de l’exécution. Valeurs valides :
Valeur par défaut : false |
| showBannerButton | Booléen | Marqueur indiquant s’il faut inclure un bouton sur la bannière d’une liste. Remarque : Les boutons sur la bannière d’une liste ne sont pas destinés à prendre en charge des conditions spécifiques à un enregistrement. Seule la première ligne est prise en compte lorsque la condition est évaluée pour déterminer si le bouton apparaît dans la liste. N’utilisez pas de conditions spécifiques à l’enregistrement, telles que current.getValue('state') === 'closed'.Valeurs valides :
Valeur par défaut : false |
| showSaveWithFormButton | Booléen | Marqueur indiquant si le formulaire est enregistré lors d’un accès à partir d’une liste avant d’exécuter le bouton d’action d’interface utilisateur. Valeurs valides :
Valeur par défaut : false |
| $meta | Objet | Métadonnées pour les métadonnées de l’application. Avec la propriété installMethod , vous pouvez mapper les métadonnées d’application à un répertoire de sortie qui ne se charge que dans des circonstances spécifiques. Valeurs valides pour installMethod :
|
list: {
showButton: true,
showLink: true,
showContextMenu: false,
style: 'primary',
showListChoice: false,
showBannerButton: true,
showSaveWithFormButton: true,
}Objet client
Configurez les options pour exécuter le script d’action d’interface utilisateur dans le navigateur.
L’objet client est une propriété de l’objet UiAction .
| Nom | Type | Description |
|---|---|---|
| isClient | Booléen | Marqueur indiquant où le script d’action d’interface utilisateur s’exécute. Valeurs valides :
Valeur par défaut : false |
| isUi11Compatible | Booléen | Marqueur indiquant si l’action d’interface utilisateur est prise en charge dans l’interface utilisateur 11 héritée. Valeurs valides :
Valeur par défaut : false |
| isUi16Compatible | Booléen | Marqueur indiquant si l’action d’interface utilisateur est prise en charge dans l’interface utilisateur principale. Valeurs valides :
Valeur par défaut : false |
| onClick | Chaîne | Nom de la fonction JavaScript à exécuter lorsque l’action d’interface utilisateur est exécutée. La fonction est définie avec la propriété script . |
| $meta | Objet | Métadonnées pour les métadonnées de l’application. Avec la propriété installMethod , vous pouvez mapper les métadonnées d’application à un répertoire de sortie qui ne se charge que dans des circonstances spécifiques. Valeurs valides pour installMethod :
|
client: {
isClient: true,
isUi11Compatible: true,
isUi16Compatible: true,
onClick: 'reopenIncident()'
}Objet d’espace de travail
Configurez le fonctionnement et l’affichage d’une action d’interface utilisateur dans les espaces de travail.
L’objet workspace est une propriété de l’objet UiAction .
| Nom | Type | Description |
|---|---|---|
| isConfigurableWorkspace | Booléen | Marqueur qui indique le type d’espace de travail dans lequel une action d’interface utilisateur s’applique. Valeurs valides :
Valeur par défaut : false |
| showFormButtonV2 | Booléen | Marqueur indiquant s’il faut inclure un bouton sur les formulaires d’un espace de travail. Valeurs valides :
Valeur par défaut : false |
| showFormMenuButtonV2 | Booléen | Marqueur indiquant s’il faut inclure un élément dans le menu Actions supplémentaires dans un espace de travail. Valeurs valides :
Valeur par défaut : false |
| clientScriptV2 | Chaîne | Script qui s’exécute lorsque l’action d’interface utilisateur est exécutée dans les espaces de travail. Cette propriété prend en charge le JavaScript en ligne ou une référence à un autre fichier dans l’application qui contient un script. Format :
|
| $meta | Objet | Métadonnées pour les métadonnées de l’application. Avec la propriété installMethod , vous pouvez mapper les métadonnées d’application à un répertoire de sortie qui ne se charge que dans des circonstances spécifiques. Valeurs valides pour installMethod :
|
workspace: {
isConfigurableWorkspace: true,
showFormButtonV2: true,
showFormMenuButtonV2: true,
clientScriptV2: `function onClick(g_form) {
}`,
}