Création d’applications dans le code source

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

    • Créez et développez des applications personnalisées dans le code source à l’aide d’outils et de processus de développement familiers.

    Vue d’ensemble de la création dans le code source

    Vous pouvez créer des applications incluses dans le périmètre en code à l’aide de ou ServiceNow IDE localement dans Visual Studio Code le Now Platform bureau avec le ServiceNow SDK.

    Quel que soit l’environnement de développement, vous utilisez ServiceNow Fluent, un langage de programmation spécifique à un domaine, pour définir les métadonnées qui composent les applications. ServiceNow Fluent inclut des API permettant de définir les différents types de métadonnées.

    Avec le ou ServiceNow SDK, vous pouvez également créer des modules JavaScript et utiliser des bibliothèques tierces dans votre application pour optimiser la réutilisation du code dans les scripts au sein d’une application incluse dans le ServiceNow IDE périmètre.

    Le développement et la maintenance d’applications dans le code source vous permettent de travailler dans des environnements de développement familiers, de créer et de modifier des applications complexes, de gérer plus facilement le code dans le contrôle de source et de détecter les erreurs au moment de la création.

    Comparaison du ServiceNow IDE et du ServiceNow SDK

    Fonctionnalité ServiceNow IDE ServiceNow SDK
    Environnement de développement Instance en ligne ServiceNow Développement local et possibilité de travailler hors ligne
    Interface utilisateur IDE basé sur Visual Studio Code pour le Web Visual Studio Code Bureau
    Collaboration Affichez les changements de n’importe quel utilisateur en temps réel dans le code ou les interfaces utilisateur intégrées Now Platform .

    Collaborez avec d’autres développeurs sur des applications dans le contrôle de source.

    		 Récupérez et déployez des changements sur une instance à l’aide de l’interface de ligne ServiceNow SDK de commande pour collaborer avec d’autres utilisateurs.

    Collaborez avec d’autres développeurs sur des applications dans le contrôle de source.
    Contrôle de source Prend en charge la fonctionnalité Git la plus courante et l’intégration à un fournisseur Git de votre choix.

    Une branche simultanée par référentiel et par instance.

    		 Prise en charge complète
    Conversion d’application Prise en charge de la conversion des applications incluses dans le périmètre existantes non créées avec le ServiceNow IDE ou ServiceNow SDK. Prise en charge de la conversion des applications incluses dans le périmètre existantes non créées avec le ServiceNow IDE ou ServiceNow SDK.
    ServiceNow Fluent Prise en charge complète Prise en charge complète
    Modules JavaScript et bibliothèques tierces Prise en charge complète Prise en charge complète

    Structure de l’application

    Applications incluses dans le périmètre personnalisées créées avec le ou ServiceNow SDK incluent des fichiers de code source et des ServiceNow IDE fichiers XML de métadonnées. Les fichiers package.json et now.config.json définissent la structure de l’application, qui est similaire à celle des applications Node.js ou des packages npm (Node Package Manager).

    Figure 1. Structure par défaut d’une application créée dans le ServiceNow IDE
    Structure d’une application créée dans le ServiceNow IDE

    Par défaut, les applications incluent les répertoires et fichiers suivants. Vous pouvez modifier certains aspects de la structure de l’application en fonction de vos besoins dans le fichier now.config.json .

    .Maintenant
    Répertoire contenant des informations de mise en cache et de mesures pour les processus de création et de déploiement.
    distr/application
    Répertoire contenant les artefacts de version pour l’empaquetage.
    métadonnées

    Répertoire contenant les métadonnées d’application (XML) de l’application, telles que les schémas de table et les règles métier, organisés dans la même structure de répertoire que les applications existantes ServiceNow .

    Remarque :
    Les métadonnées d’application ne doivent pas être modifiées à partir des fichiers XML. Modifiez les métadonnées d’application dans le code source ou dans le Now Platformfichier .
    node_modules
    Répertoire contenant les modules Node.js tiers dont dépend votre application.
    src
    Répertoire contenant le code source de votre application, y compris les fichiers d’exemple. Ce répertoire comprend les sous-répertoires suivants :
    • fluent : Répertoire contenant ServiceNow Fluent du code dans .now.ts fichiers. Le sous-répertoire généré contient les fichiers d’application convertis en ServiceNow Fluent.
    • serveur : répertoire contenant le code du module JavaScript dans les fichiers .js ou .ts .
    target
    Répertoire contenant un package déployable à charger sur une instance.
    .eslintrc.json
    Fichier contenant la configuration ESLint. ESLint permet d’identifier et de résoudre les problèmes dans le code de l’application.
    .gitignore
    Fichier contenant une liste de répertoires ou de fichiers à ignorer par Git. Ces fichiers ne sont pas suivis dans le contrôle de source.
    now.config.json
    Fichier contenant la configuration de l’application ServiceNow . Le fichier now.config.json doit se trouver dans le répertoire de base d’une application.
    Vous pouvez configurer la structure des répertoires d’une application en ajoutant les paramètres suivants. Par exemple : 
    {
  "scope": "x_snc_example_app",
  "scopeId": "2f8400eb07426110f736e28f69d3017a",
  "name": "ExampleApp"
  "metadataDir": "metadata",
  "appOutputDir": "dist/app",
  "fluentDir": "src/fluent",
  "serverModulesDir": "src/server",
  "modulePaths": {
      "src/server/*.ts": "dist/server/*.js",
    },
  "ignoreTransformTableList": ["ua_table_licensing_config", "sys_embedded_help_role"]
}
    Tableau 1. Paramètres now.config.json pris en charge
    Paramètre Description
    MetadataDir Répertoire contenant les métadonnées de l’application sous forme de fichiers XML.

    Par défaut : métadonnées
    appOutputDir Répertoire vers lequel sortir les artefacts de version pour l’empaquetage lors de la création de l’application.

    Par défaut : dist/app
    fluentDir Répertoire contenant ServiceNow les fichiers Fluent (.now.ts) qui définissent les métadonnées d’application dans le code source.

    Par défaut : src/fluent
    répertoire serverModulesDir Répertoire contenant les fichiers JavaScript ou TypeScript à intégrer dans les modules JavaScript à utiliser dans les scripts côté serveur.

    Par défaut : src/server
    Chemins d’accès des modules Un mappage du répertoire source pour les modules au répertoire de sortie pour les modules. Ce paramètre est utilisé pour compiler les fichiers sources TypeScript en modules JavaScript. Pour plus d'informations, consultez L’utilisation de TypeScript dans les modules JavaScript avec le ServiceNow SDK.

    Ce paramètre n’est pas nécessaire si vous utilisez le paramètre tsconfigPath .
    tsconfigPath Un chemin vers le fichier de tsconfig.json de l’application s’il ne se trouve pas dans le répertoire de base. Par exemple, « ./src/tsconfig.json ».

    Ce paramètre n’est pas nécessaire si vous utilisez le paramètre modulePaths .
    ignoreTransformTableList Tables à ignorer lors de la transformation des métadonnées d’application en code source.
    package-lock.json
    Fichier mis à jour automatiquement contenant des informations complètes sur les dépendances et leurs versions. Ce fichier n’est disponible qu’avec le fichier ServiceNow SDK.
    package.json

    Fichier contenant des informations sur votre application et les dépendances de modules personnalisés ou tiers. Le fichier package.json doit se trouver dans le répertoire de base d’une application. Sur une instance, le chemin d’accès de l’package.json est spécifié dans le champ JSON du package de l’enregistrement d’application personnalisée [sys_app] au format <scope>/<package-name>/<version>/package.json.

    tsconfig.json

    Fichier contenant la configuration TypeScript et les options pour la compilation des fichiers TypeScript dans des modules JavaScript et pour les définitions de types.

    Applications et fonctionnalités associées

    API JavaScript
    Utilisez les API JavaScript dans les scripts que vous écrivez pour modifier les fonctionnalités des applications ou lorsque vous créez des applications.