Créer et utiliser des modules JavaScript dans des applications avec ServiceNow SDK

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 3 minutes de lecture

    • Optimisez votre base de code en définissant des blocs de code réutilisables avec des modules JavaScript et le ServiceNow SDK.

    Avant de commencer

    Créez ou convertissez une application incluse dans le périmètre avec le ServiceNow SDK. Pour en savoir plus, reportez-vous Créer une application avec le ServiceNow SDK à la section ou .

    Remarque :
    Pour utiliser TypeScript dans les modules, définissez le paramètre --template sur typescript lors de la création ou de la conversion d’une application. Pour configurer une application existante afin de prendre en charge l’utilisation de TypeScript, reportez-vous à la section L’utilisation de TypeScript dans les modules JavaScript avec le ServiceNow SDK.

    Rôle requis : admin

    Pourquoi et quand exécuter cette tâche

    Pour en savoir plus sur la prise en charge de l’utilisation des modules JavaScript dans les applications incluses dans le périmètre, y compris certaines limitations, reportez-vous à la section Modules JavaScript et bibliothèques tierces. Pour des informations générales sur la syntaxe utilisée pour créer des modules JavaScript, consultez la page Modules JavaScript sur le site Web MDN Web Docs.

    Procédure

    1. Dans Visual Studio Code, ouvrez le répertoire de votre application incluse dans le périmètre.
    2. Dans le répertoire src/server de l’application, créez un fichier JavaScript ou TypeScript contenant le code du module que vous souhaitez réutiliser.
    3. Facultatif : Importez les API Glide globales pour les appeler à partir de votre module. 
      import { gs } from '@servicenow/glide'
    4. Dans le module, identifiez le code à exporter avec des instructions d’exportation .

      Vous pouvez utiliser une exportation nommée ou une exportation par défaut. Les exportations nommées peuvent être des variables, des constantes, des fonctions ou des classes, tandis que les exportations par défaut peuvent être uniquement des fonctions ou des classes.

      L’exemple suivant est une façon d’ajouter une exportation nommée pour plusieurs fonctionnalités (une fonction et une variable) dans un module :
      export { myFunction, myVariable };
    5. Utilisez le code du module exporté dans d’autres modules ou scripts côté serveur.
      FichierÉtapes
      Module
      1. À partir du répertoire src/server , créez ou ouvrez un module JavaScript.
      2. Importez le code du module avec les instructions d’importation .
        L’exemple suivant est une façon d’importer une fonction exportée dans un module :
        import { feature } from "path/to/module";
      3. Appelez le code du module à partir de ce module pour le réutiliser.
      Script côté serveur dans le code source
      1. Créez ou ouvrez la définition des métadonnées d’application qui inclut un script côté serveur, tel qu’une règle métier, dans le code source (fichier .now.ts ).
      2. Dans la propriété du script , importez et appelez le code du module pour le réutiliser.
        Vous pouvez importer une fonction ou fournir un script en ligne précédé d’une balise de script .
        • Importez une fonction, une expression de fonction ou une fonction par défaut exportée. Par exemple :
          script: FunctionExport,
        • Les scripts en ligne doivent utiliser des instructions require pour importer le code du module. Par exemple :
          script: script`
    const { process } = require('./dist/modules/server/handler.js')
    process(request, response)`,

        Pour plus d’informations sur les scripts côté serveur dans le code source, reportez-vous à la section ServiceNow Fluent Référence d’API.
      Enregistrement de script côté serveur
      1. Ouvrez l’enregistrement d’un script côté serveur, tel qu’une règle métier.
      2. Importez le code du module avec des instructions require .
        L’exemple suivant est une façon d’importer une fonction exportée dans un script :
        const { feature } = require("path/to/module");
      3. Appelez le code du module à partir de ce script pour le réutiliser.
    6. Enregistrez vos changements.

    Que faire ensuite

    Pour utiliser des bibliothèques tierces dans un module JavaScript, reportez-vous à la section Utiliser des bibliothèques tierces dans des applications avec ServiceNow SDK.

    Pour créer votre application et ajouter les modules à la table du module EcmaScript [sys_module], reportez-vous à la section Créez et déployez une application avec le ServiceNow SDK.