Création d’applications en code source

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 5 minutes de lecture
  • Créez et développez des applications personnalisées en code source à l’aide d’outils et de processus de développement familiers.

    Vue d'ensemble

    Vous pouvez créer des applications incluses dans le code à l’aide de la ServiceNow IDE commande sur le ou localement dans Visual Studio Code le Now Platform bureau à l’aide de la commande .ServiceNow SDK

    Dans l’un ou l’autre des environnements de développement, vous utilisez ServiceNow Fluent, un langage de programmation spécifique au domaine, pour définir les métadonnées qui composent les applications. ServiceNow Fluent inclut des API pour définir les différents types de métadonnées.

    Avec le ServiceNow IDE 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 périmètre.

    Le développement et la maintenance d’applications en 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 code source et de détecter les erreurs au moment de la génération.

    Comparaison de la et de la ServiceNow IDEServiceNow 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 Visualisez les modifications apportées par un 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 les changements dans une instance à l’aide de l’interface de ServiceNow SDK ligne 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 les fonctionnalités Git les plus courantes et s’intègre à 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 Prend uniquement en charge les applications incluses dans le périmètre créées avec ou ServiceNow IDEServiceNow SDK.

    Les applications converties ne sont pas prises en charge dans le ServiceNow IDE.

    Prise en charge de la conversion d’applications incluses dans le périmètre existantes non créées avec ou ServiceNow IDEServiceNow 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 les fichiers de code source ou ServiceNow SDK et les fichiers XML de ServiceNow IDE 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).

    Par défaut, les applications incluent les répertoires et fichiers suivants. Vous pouvez modifier certains aspects de la structure de l’application pour répondre à 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 génération et de déploiement.
    dist/app
    Répertoire contenant les artefacts de version pour l’empaquetage. Ce répertoire n’est disponible qu’avec le ServiceNow SDKfichier .
    metadonné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ées dans la même structure de répertoires 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 de l’application dans le code source ou dans le Now Platformfichier .
    node_modules
    Répertoire contenant les modules de Node.js tiers dont votre application dépend.
    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 les fichiers de code source pour définir les métadonnées d’application (.now.ts). Le sous-répertoire généré contient les fichiers d’application générés avec ServiceNow Fluent.
    • server : répertoire contenant le code de module JavaScript (.js ou .ts) à utiliser avec les scripts côté serveur.
    target
    Répertoire contenant un package déployable à charger vers une instance. Ce répertoire n’est disponible qu’avec le ServiceNow SDKfichier .
    .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 que Git doit ignorer. 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",
      "metadataDir": "metadata",
      "appOutputDir": "dist/app",
      "sourceDir": "src",
      "fluentDir": "src/fluent",
      "serverModulesDir": "src/server", 
      "packOutputDir": "target",
      "transpiledSourceDir": "dist/modules",
      "maxInlineScriptLines": 15,
      "ignoreTransformTableList": ["ua_table_licensing_config", "sys_embedded_help_role"]
    }
    Tableau 1. Paramètres now.config.json pris en charge
    Paramètre Description
    répertoires métadonnées Répertoire contenant les métadonnées de l’application sous forme de fichiers XML.

    Par défaut : métadonnées

    appOutputDir Répertoire dans lequel sortir les artefacts de version pour l’emballage lors de la création de l’application. Ce répertoire n’est disponible qu’avec le ServiceNow SDKfichier .

    Par défaut : dist/app

    Répertoire source Répertoire contenant le code source de l’application.

    Par défaut : src

    rép. fluent Répertoire contenant ServiceNow des fichiers Fluent (.now.ts) qui définissent les métadonnées d’application dans le code source.

    Par défaut : src/fluent

    répservateur 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

    rép. packOutputDir Répertoire permettant de générer le fichier zip à charger vers une instance lors de la création de l’application. Ce répertoire n’est disponible qu’avec le ServiceNow SDKfichier .

    Par défaut : cible

    transpiledSourceDir Répertoire contenant les fichiers JavaScript transpilés.

    Par défaut : valeur du sourceDir paramètre

    maxInlineScriptLines Nombre maximal de lignes dans un script inclus défini dans le code source à l’aide de la balise script avant que le script ne soit automatiquement déplacé vers un fichier distinct. Le fichier de script est référencé à partir de la propriété de script dans le code source.

    Par défaut : 10

    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 ServiceNow SDKfichier .
    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.

    Applications et fonctionnalités associées

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