API de script client : ServiceNow Fluent

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 3 minutes de lecture

    • L’API de script client définit des scripts côté client [sys_script_client] qui exécutent JavaScript sur le client (navigateur Web) lorsque des événements liés au client se produisent, par exemple lors du chargement d’un formulaire, après l’envoi d’un formulaire ou lorsqu’un champ change de valeur.

    Pour des informations générales sur les scripts clients, reportez-vous à la section Client scripts.

    Objet ClientScript

    Créez un script client [sys_script_client] pour configurer les formulaires, les champs de formulaire et les valeurs de champ lorsque l’utilisateur utilise le formulaire.

    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]
    Table Chaîne Requis. Nom de la table sur laquelle le script client s’exécute.
    nom Chaîne Requis. Nom du script client.
    actif Booléen Marqueur indiquant si le script client est activé.
    Valeurs valides :
    • vrai : le script est activé.
    • false : le script n’est pas activé.

    Par défaut : true
    appliesExtended Booléen Marqueur indiquant si le script client s’applique aux tables étendues à partir de la table spécifiée.
    Valeurs valides :
    • true : le script s’applique aux tables étendues.
    • false : le script ne s’applique pas aux tables étendues.

    Valeur par défaut : false
    uiType Chaîne Interface utilisateur à laquelle le script client s’applique.
    Valeurs valides :
    • desktop
    • mobile_or_service_portal
    • tous

    Par défaut : ordinateur de bureau
    description Chaîne Description de la fonctionnalité et de la finalité du script client.
    messages Chaîne Chaînes de texte disponibles pour le script client en tant que messages localisés utilisant getMessage(« [message] ») Pour plus d’informations, consultez Traduire un message en script client.
    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 :
    • vrai : isole le script et ne l’exécute pas en mode strict.
    • false : exécuter le script en mode strict.

    Valeur par défaut : false
    script Script Un script côté client qui s’exécute dans le navigateur. 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 :
    • 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 ».
    global Booléen Marqueur indiquant sur quelles vues de la table le script client s’exécute.
    Valeurs valides :
    • vrai : le script s’exécute sur toutes les vues.
    • false : le script s’exécute uniquement sur les vues spécifiées.

    Par défaut : true
    vue Chaîne Vues de la table sur laquelle le script client s’exécute. Cette propriété s’applique uniquement lorsque la propriété globale est définie sur false.
    type Chaîne Type de script client, qui définit quand il s’exécute. Pour en savoir plus sur les types pris en charge, reportez-vous à la section Client scripts.
    Valeurs valides :
    • onCellEdit : S’exécute lorsque l’éditeur de liste modifie la valeur d’une cellule.
    • onChange : s’exécute lorsqu’une valeur de champ particulière change sur le formulaire.
    • onLoad : s’exécute lorsque le système affiche le formulaire pour la première fois et avant que les utilisateurs puissent saisir des données. En règle générale, les scripts clients onLoad() effectuent une manipulation côté client du formulaire actif ou définissent des valeurs d’enregistrement par défaut.
    • onSubmit : s’exécute lorsqu’un formulaire est soumis. En règle générale, les scripts onSubmit() valident des éléments sur le formulaire et s’assurent que la soumission a un sens. Un script client onSubmit() peut annuler la soumission d’un formulaire en renvoyant la valeur faux.
    champ Chaîne Champ de la table auquel le script client s’applique. Cette propriété s’applique uniquement lorsque la propriété type est définie sur onChange ou onCellEdit.
    $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 { ClientScript } from '@servicenow/sdk/core'

export const cs = ClientScript({
   $id: Now.ID['my_scripts'], 
   name: 'my_scripts',
   table: 'incident',
   active: true, 
   appliesExtended: false, 
   global: true,
   uiType: 'all', 
   messages: '', 
   isolateScript: false, 
   type: 'onLoad',
   script: Now.include('../client/client-script.js'),
})
    Le script client est défini dans le fichier client-script.js référencé à partir de la propriété de script . Par exemple :
    function onLoad() { 
    const x = 'util' g_form.addInfoMessage(x) 
}