API de script client : ServiceNow Fluent

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 2 minutes de lecture

    • L’API de script client inclut des objets qui définissent les scripts clients [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 la soumission du formulaire ou lorsqu’un champ change de valeur.

    Objet ClientScript

    Créez un script client [sys_script_client] pour configurer les formulaires, les champs de formulaire et les valeurs de champ pendant que 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 fourni au format suivant, où <valeur> est une chaîne ou un nombre.
    $id: Now.ID[<value>]

    Lorsque vous créez l’application, cet ID est haché dans un sys_ID unique.
    table Chaîne Requis. Nom de la table sur laquelle le script client s’exécute.
    nom Chaîne Requis. Le nom du script client.
    Actif Booléen Marqueur indiquant si le script client est activé.
    Valeurs valides :
    • vrai : le script est activé.
    • faux : le script n’est pas activé.

    Valeur par défaut : true
    applies_extended 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
    ui_type Chaîne Interface utilisateur à laquelle le script client s’applique.

    Valeurs valides : bureau, mobile_or_service_portal, tous

    Par défaut : ordinateur de bureau
    description Chaîne Description de la fonctionnalité et de l’objectif 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 de script client.
    isolate_script Booléen Marqueur indiquant si les scripts s’exécutent en mode strict, avec l’accès aux DOM directs, jQuery, prototype et l’objet de la fenêtre désactivé.
    Valeurs valides :
    • true : isolez le script et ne l’exécutez pas en mode strict.
    • false : exécuter le script en mode strict.

    Valeur par défaut : false
    script Script Script inclus précédé d’une balise de script au format suivant :
    script: script`gs.info('info')`,
    Remarque :
    L’importation de fonctions à partir de modules JavaScript ou de bibliothèques tierces n’est pas prise en charge dans les scripts clients.
    global Booléen Marqueur indiquant sur quelles vues de la table le script client est exécuté.
    Valeurs valides :
    • true : le script s’exécute sur toutes les vues.
    • faux : le script s’exécute uniquement sur les vues spécifiées.

    Valeur par défaut : true
    vue Chaîne Les 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 le moment de son exécution. Pour en savoir plus sur les types pris en charge, reportez-vous à la section Client scripts.

    Valeurs valides : onCellEdit, onChange, onLoad, onSubmit
    champ Chaîne Un 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. 
    import { ClientScript } from '@servicenow/sdk/core'

export const cs = ClientScript({
   $id: Now.ID['my_scripts'], 
   name: 'my_scripts',
   table: 'incident',
   active: true, 
   applies_extended: false, 
   global: true,
   ui_type: 'all', 
   messages: '', 
   isolate_script: false, 
   type: 'onLoad',
   script: script`function onLoad() { const x = 'util' g_form.addInfoMessage(x) }`,
})