Téléchargement des dépendances avec le ServiceNow SDK

Télécharger les dépendances d’application et les définitions TypeScript à partir d’une instance pour IntelliSense et la validation des scripts et ServiceNow Fluent du code.

Tout au long du processus de développement, vous devez télécharger les dépendances et les définitions TypeScript à partir d’une instance pour prendre en charge le codage par rapport à ces dépendances dans une application.

Pour télécharger l’ensemble des scripts et ServiceNow Fluent dépendances d’une application, vous pouvez utiliser la commande dependencies sans paramètre. Si nécessaire, fournissez également le répertoire d’application et l’alias d’authentification.

now-sdk dependencies [--directory <package path>] [--auth <alias>]

Télécharger ServiceNow Fluent les dépendances d’applications

Téléchargez les définitions TypeScript pour les dépendances dans d’autres périmètres de l’application afin d’obtenir la prise en charge et la validation d’IntelliSense pour ServiceNow Fluent le code.

Avant de commencer

Ajoutez une application à votre système local avec le .ServiceNow SDK Pour en savoir plus, consultez Ajout d’applications avec le ServiceNow SDK.

Rôle requis : admin

Pourquoi et quand exécuter cette tâche

Cette procédure utilise l’interface de ligne de ServiceNow SDK commande (CLI). À partir d’un outil en ligne de commande, entrez now-sdk --help pour obtenir des informations sur les commandes disponibles et les options globales. Pour obtenir des informations supplémentaires sur une commande et ses paramètres, entrez la commande et --help ou -h. Par exemple, now-sdk auth --help. Pour plus d’informations sur l’interface de ligne de commande, reportez-vous à .ServiceNow SDK Interface de ligne de commande

Procédure

1. Dans , ouvrez le répertoire de votre application incluse dans Visual Studio Codele champ d’application.
2. Dans le fichier now.config.json , ajoutez les éléments dont dépend votre application dans l’objet dependencies .

   L’objet dépendances a la structure suivante. Vous devez spécifier le périmètre de l’application ainsi que le type de dépendance et les noms ou sys_ids. Seuls les tables et les rôles peuvent être spécifiés par nom. Vous pouvez utiliser un caractère générique (*) pour ajouter tous les éléments d’une table et d’un périmètre spécifiés.

   "dependencies": {
       "<scope>": {
         "<type>": ["<sys_id or name>"],
         ...
       },
       ...
   }

   Par exemple :

   {
     "dependencies": {
       "global": {
         "tables": ["incident", "problem"],
         "roles": ["admin"],
         "sys_script_client": ["fa776f6d97700100f309124eda2975bc"]
       },
       "x_custom": {
         "tables": ["custom_table"],
         "sys_security_acl": "*",
       }
     }
   }

3. Enregistrez vos changements.
4. Dans le répertoire de l’application, ouvrez une fenêtre de terminal intégrée.
5. Téléchargez les dépendances de l’application à l’aide de la commande dependencies .

   now-sdk dependencies --auth <alias> --fluent-only

   Remarque :

   Si vous souhaitez également télécharger les dépendances de script, excluez le paramètre --fluent-only .

   La commande dependencies télécharge les dépendances spécifiées dans le fichier now.config.json et génère des définitions TypeScript pour celles-ci dans le répertoire @types/servicenow/fluent avec l’extension de fichier .d.now.ts . Lors de la création de l’application, ces fichiers ne sont pas compilés comme des fichiers de code source.

Que faire ensuite

Vous pouvez référencer les dépendances dans les fichiers à ServiceNow Fluent l’aide du format d’importation de sous-chemin d’accès #now :{scope}/{category} . Par exemple :

// Import roles from global scope
import { role as globalRole } from '#now:global/security'

// Import roles from custom app scope  
import { role as xExampleAppRole } from '#now:x_example_app/security'

// Use in ACLs, flows, etc.
Acl({
    $id: Now.ID['my_acl'],
    type: 'record',
    table: 'incident',
    operation: 'read',
    roles: [globalRole.admin, xExampleAppRole.xExampleAppCool],
})

Pour ce faire, le fichier de package.json de votre application doit inclure la configuration d’importation suivante :

{
  "imports": {
    "#now:*": "./@types/servicenow/fluent/*/index.js"
  }
}

Télécharger les dépendances du module et du script

Téléchargez les définitions TypeScript pour les dépendances de module et de script afin d’obtenir la prise en charge et la validation d’IntelliSense pour les API et les includes de script Glide.

Avant de commencer

Ajoutez une application à votre système local avec le .ServiceNow SDK Pour en savoir plus, consultez Ajout d’applications avec le ServiceNow SDK.

Rôle requis : admin

Pourquoi et quand exécuter cette tâche

Cette procédure utilise l’interface de ligne de ServiceNow SDK commande (CLI). À partir d’un outil en ligne de commande, entrez now-sdk --help pour obtenir des informations sur les commandes disponibles et les options globales. Pour obtenir des informations supplémentaires sur une commande et ses paramètres, entrez la commande et --help ou -h. Par exemple, now-sdk auth --help. Pour plus d’informations sur l’interface de ligne de commande, reportez-vous à .ServiceNow SDK Interface de ligne de commande

Procédure

1. Dans , ouvrez le répertoire de votre application incluse dans Visual Studio Codele champ d’application.
2. Dans le répertoire de l’application, ouvrez une fenêtre de terminal intégrée.
3. Téléchargez les dépendances pour les scripts dans l’application à l’aide de la commande dependencies .

   now-sdk dependencies --auth <alias> --type-defs-only

   Remarque :

   Si vous souhaitez également télécharger les dépendances d’application, excluez le paramètre --type-defs-only .

   La commande dependencies télécharge les définitions de type pour toutes les API Glide, analyse les modules et les scripts dans votre application et crée des définitions de type pour les includes de script qu’ils utilisent. Les définitions de type sont ajoutées dans le répertoire @types/ServiceNow . Pour ajouter d’autres définitions de type, vous pouvez les créer manuellement. Pour en savoir plus, consultez Ajouter des définitions de type pour les API.

4. Dans le répertoire src/fluent , créez un fichier tsconfig.server.json pour les scripts côté serveur.
   Dans l’objet include , incluez les définitions de type que vous avez téléchargées pour les API Glide côté serveur (glide.server.d.ts) et les includes de script (script-includes.server.d.ts).

   {
     "compilerOptions": {
       "lib": [
         "ES2021"
       ],
       "noEmit": true,
       "checkJs": false,
       "allowJs": true,
       "noEmitHelpers": true,
       "esModuleInterop": false,
       "module": "None",
       "types": []
     },
     "include": [
       "./**/*.server.js",
       "../../@types/servicenow/*.server.d.ts",
     ]
   }

5. Dans le répertoire src/fluent , créez un fichier tsconfig.client.json pour les scripts côté client.
   Dans l’objet include , incluez les définitions de type que vous avez téléchargées pour les API Glide côté client (glide.client.d.ts).

   {
     "compilerOptions": {
       "target": "ES6",
       "lib": [
         "DOM",
         "ES6"
       ],
       "checkJs": false,
       "allowJs": true,
       "noEmit": true,
       "noEmitHelpers": true,
       "esModuleInterop": false,
       "module": "None",
       "types": []
     },
     "include": [
       "./**/*.client.js",
       "../../@types/servicenow/*.client.d.ts",
     ]
   }

6. Dans le répertoire src/fluent , créez un fichier tsconfig.json .
   Remarque :

   Ce fichier tsconfig.json est distinct d’un fichier tsconfig.json utilisé pour les applications qui utilisent TypeScript pour créer des modules JavaScript.

   Dans l’objet de références , ajoutez les chemins d’accès aux fichiers tsconfig.server.json et tsconfig.client.json .

   {
     "files": [],
     "references": [
       {
         "path": "./tsconfig.server.json"
       },
       {
         "path": "./tsconfig.client.json"
       }
     ]
   }

7. Enregistrez vos changements.

Résultats

Avec cette configuration, vous pouvez utiliser l’extension de fichier .server.js pour les scripts côté serveur et l’extension de fichier .client.js pour les scripts côté client et obtenir une prise en charge de la suggestion automatique pendant le développement.