Convertir une application avec le ServiceNow SDK

Convertissez une application incluse dans le périmètre existante pour prendre en charge le développement dans le code source avec le ServiceNow SDK.

Avant de commencer

Utilisez le ServiceNow SDK pour vous authentifier auprès d’une ServiceNow instance. Pour en savoir plus, consultez Authentification sur une ServiceNow instance avec le ServiceNow SDK.

Rôle requis : admin

Pourquoi et quand exécuter cette tâche

Les applications incluses dans le périmètre existantes qui n’ont pas été créées avec le ou ServiceNow SDK qui doivent être converties pour prendre en charge le développement dans le ServiceNow IDE code source. La conversion d’une application ajoute les fichiers et répertoires nécessaires à son développement dans le code source. Vous pouvez choisir de convertir ou non les métadonnées d’application existantes en ServiceNow Fluent code. L’application n’est pas modifiée sur l’instance tant que vous ne l’avez pas créée et installée sur l’instance.

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. Créez un répertoire local pour votre application.
2. Dans Visual Studio Code, ouvrez le répertoire.
3. Dans le répertoire de l’application, ouvrez une fenêtre de terminal intégrée.
4. Convertissez une application incluse dans le périmètre existante à partir d’une instance ou d’un répertoire local à l’aide de la commande init .

   Avec le paramètre --from , fournissez une sys_id d’une application sur l’instance ou un chemin d’accès à un répertoire local contenant une application à convertir pour prendre en charge le développement dans le code source.

   npx @servicenow/sdk init --from <sys_id or path>

   Par exemple :

   npx @servicenow/sdk init --from aadfdd904748a6500ff14ee4316d4369

   Remarque :

   L’utilisation de la commande npx installe le ServiceNow SDK dans votre répertoire d’application plutôt que globalement.
5. À l’invite, saisissez un nom pour le package d’application utilisé dans le fichier package.json .

   Le nom du package doit respecter les normes de dénomination de package Node Package Manager (npm).

   Dans l’exemple suivant, une application est téléchargée à partir de l’instance et convertie à l’aide de son sys_id.

   $ npx @servicenow/sdk init --from aadfdd904748a6500ff14ee4316d4369
   [now-sdk] Bootstrapping a new ServiceNow application project...
   [now-sdk] Please provide the missing required fields:
   ? NPM package name:  example-app
   [now-sdk] Access Token has expired, refreshing token
   [now-sdk] Downloading application package for aadfdd904748a6500ff14ee4316d4369 from https://myinstance.service-now.com
   [now-sdk] Unzipping downloaded package...
   [now-sdk] Successfully downloaded and unzipped application aadfdd904748a6500ff14ee4316d4369
   [now-sdk] Summary of downloaded metadata files
   Metadata: 13 (Total: 13)
     Copied To Metadata Directory::
       1. dictionary/x_snc_example_app_mytable.xml
       2. package_inventory.csv
       3. sys_app_aadfdd904748a6500ff14ee4316d4369.xml
       4. update/sys_db_object_7030a5d04748a6500ff14ee4316d4338.xml
       5. update/sys_dictionary_x_snc_example_app_mytable_null.xml
       6. update/sys_documentation_x_snc_example_app_mytable__en.xml
   ... and 7 more
   
   [now-sdk] Successfully converted application.
   [now-sdk] Install the required dependencies with your preferred package manager before running "$now-sdk build".
             Ex: Run "npm install" if using npm.

   L’application est disponible localement avec la structure d’application par défaut et prend en charge le développement dans le code source. Les métadonnées d’application existantes sont téléchargées dans le répertoire des métadonnées . Pour plus d’informations sur la structure de l’application, consultez la Structure de l’application section de la rubrique Création d’applications dans le code source.

6. Installez les dépendances tierces requises à l’aide de votre gestionnaire de packages préféré.
   Par exemple, si vous utilisez le gestionnaire de package de nœud (npm), exécutez l’installation npm.
7. Facultatif : Transformez les métadonnées d’application existantes (XML) en ServiceNow Fluent code à l’aide de la commande transform .

   Avec le paramètre --from , fournissez un chemin vers un répertoire local ou un fichier contenant des métadonnées XML à transformer en ServiceNow Fluent code.

   now-sdk transform [--from <path>] [--directory <package path>] [--preview <flag>] [--auth <alias>]

   Conseil :

   Vous pouvez définir le paramètre --preview sur true pour prévisualiser le code transformé ServiceNow Fluent à partir de la ligne de commande sans enregistrer les modifications.
   Par exemple :

   now-sdk transform --from metadata/update --auth devuser1

   Les métadonnées d’application sont définies dans ServiceNow Fluent le code du répertoire src/fluent/generated et supprimées du répertoire spécifié.

   Remarque :

   Un nombre limité de types de métadonnées, tels que les instantanés de métadonnées [sys_metadata_link] et les ressources UX [sys_ux_lib_asset], ne peuvent pas être représentés sous forme ServiceNow Fluent de code et ne sont pas transformés. Ces types de métadonnées restent sous forme de fichiers XML de métadonnées dans le répertoire de métadonnées de votre application.
8. Créez l’application à l’aide de la commande build .

   now-sdk build

9. Facultatif : Mettez à jour l’application sur l’instance avec la commande install .

   now-sdk install --auth <alias>

Résultats

L’application convertie est ajoutée à votre répertoire local avec les fichiers et répertoires nécessaires pour prendre en charge le développement dans le code source. Si vous avez correctement installé l’application, elle est mise à jour sur l’instance. Pour plus d’informations sur l’installation d’applications, reportez-vous à la section Créer et installer une application avec le ServiceNow SDK. Après l’installation d’une application convertie, le champ JSON du package de l’enregistrement d’application personnalisée [sys_app] contient le chemin d’accès au fichier package.json de l’application.

Les nouvelles métadonnées d’application ajoutées après la conversion d’une application sont automatiquement transformées en code source dans le répertoire src/fluent/generated lorsque vous utilisez la commande transform . Si des métadonnées existent dans l’application locale à la fois en tant que code XML et source, la version XML prévaut lorsqu’elle est installée sur l’instance.

Que faire ensuite

Dans , commencez à développer votre application dans le code source avec ServiceNow Fluent, écrivez des modules JavaScript personnalisés ou ajoutez des bibliothèques tierces. pour Visual Studio Codeplus d’informations, reportez-vous à .Développer des applications avec le ServiceNow SDK