API d’action des scripts : ServiceNow Fluent

L’API d’action des scripts définit les actions des scripts [sysevent_script_action] qui s’exécutent lorsqu’un événement se produit.

Pour des informations générales sur les exécutions de script planifiées, reportez-vous à la section Script actions.

Concepts associés

• ServiceNow Fluent

Objet ScriptAction

Créez une action de script [sysevent_script_action] qui exécute une tâche lorsqu’elle est déclenchée par un événement.

Tableau 1. Propriétés

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 : Now.ID['chaîne' ou numéro]
nom	Chaîne	Requis. Nom unique pour l’action des scripts.
script	Script	Requis. Un script côté serveur qui s’exécute lorsqu’il est déclenché par un événement. Cette propriété prend en charge une fonction d’un module JavaScript, une référence à un autre fichier dans l’application qui contient un script ou JavaScript en ligne. Format : Pour les fonctions, utilisez le nom d’une fonction, d’une expression de fonction ou d’une fonction par défaut exportée à partir d’un module JavaScript et importez-la dans le fichier .now.ts . Pour en savoir plus sur les modules JavaScript, reportez-vous à la section Modules JavaScript et bibliothèques tierces. Pour utiliser le contenu textuel d’un autre fichier, reportez-vous à un fichier de l’application en utilisant le format suivant : Now.include('chemin/vers/fichier'). Pour plus d'informations, consultez ServiceNow Fluent Constructions linguistiques. Pour fournir un script inline, utilisez des chaînes de caractères ou des modèles de lignes de code : « Script » ou « Script ».
eventName	Chaîne	Requis. L’événement qui déclenche l’exécution de l’action des scripts. Pour plus d’informations sur la création d’événements, reportez-vous à la section Create an event.
actif	Booléen	Marqueur indiquant si l’action des scripts est activée. Valeurs valides : vrai : l’action des scripts s’exécute lorsqu’elle est déclenchée par l’événement. faux : l’action du script ne s’exécute pas. Valeur par défaut : false
description	Chaîne	Description de la fonctionnalité et de l’objectif de l’action des scripts.
order	Numéro	Numéro indiquant l’ordre dans lequel l’action des scripts doit s’exécuter. S’il existe plusieurs actions de script sur un événement particulier, les actions de script s’exécutent dans l’ordre spécifié, de la plus basse à la plus élevée. Par défaut : 100
Script conditionnel	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 : N’utilisez pas cette propriété si vous incluez l’instruction condition avec la propriété script . Format : Pour utiliser le contenu textuel d’un autre fichier, reportez-vous à un fichier de l’application en utilisant le format suivant : Now.include('chemin/vers/fichier'). Pour plus d'informations, consultez ServiceNow Fluent Constructions linguistiques. Pour fournir un script inline, utilisez des chaînes de caractères ou des modèles de lignes de code : « Script » ou « 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. $meta: {       installMethod: 'String' } Valeurs valides pour installMethod : demo : génère les métadonnées de l’application dans le répertoire metadata/unload.demo à installer avec l’application lorsque l’option Charger les données de démonstration est sélectionnée. première installation : génère les métadonnées de l’application dans le répertoire metadata/unload à installer uniquement la première fois qu’une application est installée sur une instance.

import { ScriptAction } from '@servicenow/sdk/core'
import { insertIncident } from '../server/scripts.js'

ScriptAction({
    $id: Now.ID['sample-script-action'],
    name: 'SampleScriptAction',
    active: true,
    description: 'Insert an incident',
    script: insertIncident,
    eventName: 'sample.event',
    order: 100,
    conditionScript: "gs.hasRole('my_role')"
})

La propriété script fait référence à une fonction du module scripts.js . Par exemple :

import { GlideRecord } from '@servicenow/glide'

export const insertIncident = () => {
    var gr = new GlideRecord('incident')
    gr.initialize()
    gr.setValue('short_description', 'New incident from event')
    gr.insert()
}