Créer une application avec le ServiceNow SDK

  • Rversion finale: Yokohama
  • Mis à jour 30 janv. 2025
  • 4 minutes de lecture
  • Créez une application incluse dans le périmètre pour développer dans le code source avec le ServiceNow SDK.

    Avant de commencer

    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 CLI.

    Procédure

    1. À partir du répertoire dans lequel vous souhaitez ajouter une application, ouvrez un outil en ligne de commande sur votre système.
    2. Créez une application en suivant un ensemble d’invites guidées avec la commande create :
      now-sdk create
      Remarque :
      Si vous préférez spécifier les paramètres manuellement avec la commande create , définissez le paramètre --interactive sur false et fournissez le nom du périmètre et le nom de l’application requis. Pour plus d’informations, consultez la commande create dans la rubrique CLI du SDK ServiceNow .
    3. Répondez à la série d’invites suivante.
      Tableau 1. Invites interactives pour la commande de création
      Invite Description
      Se connecter à une instance Option permettant de s’authentifier auprès d’une instance et de valider que le périmètre de l’application que vous indiquez est valide lors de la création de l’application.
      • Oui : le nom du champ d’application est validé avant que l’application ne soit créée localement.
      • Non : le nom du champ d’application n’est pas validé lors de la création, vous devez donc vérifier que le nom du champ d’application est valide avant le déploiement sur votre instance.
      Informations d’identification d’instance Une option permettant de créer ou de sélectionner des informations d’identification pour s’authentifier sur une instance. Pour ajouter des informations d’identification, procédez comme suit :
      1. Sélectionnez Ajouter de nouvelles informations d’identification.
      2. Répondez à la série d’invites suivantes :
        • Hôte cible pour le déploiement de l’application : <URL d’instance>
        • Nom d’utilisateur à authentifier avec l’instance : <nom d’utilisateur>
        • Mot de passe pour s’authentifier avec l’instance : <password>
        • Alias pour ces informations d’identification : <alias>

      Si vous avez déjà configuré les informations d’identification, vous pouvez les sélectionner dans la liste des alias existants et des instances associées.

      Nom de l’application ServiceNow Nom de l’application.
      Nom de package NPM Nom du package d’application utilisé dans le fichier de package.json .

      Le nom du package doit respecter les normes de dénomination des packages NPM.

      Description associée à sys_app Une brève description de votre application.
      Nom du champ d'application Le périmètre de l’application.

      Le nom du champ d’application doit être unique sur l’instance, commencer par x_<préfixe> et comporter au maximum 18 caractères. Pour en savoir plus, consultez Identificateur de l’espace de noms.

      Modèle de projet Une option permettant de spécifier si JavaScript ou TypeScript doit être utilisé dans les modules. Cette option détermine la configuration des fichiers package.json et now.config.json et ajoute un fichier tsconfig.json pour les projets TypeScript.
      • JavaScript : l’application est configurée pour construire des fichiers .js du répertoire src/server en modules.
      • Tapuscrit: l’application est configurée pour créer des fichiers .ts du répertoire src/server en modules.
      Structure du projet Fluent ou JS Module ? Type d’application, qui détermine la configuration d’application par défaut.
      • Parler couramment: la configuration d’application par défaut est configurée pour l’utilisation ServiceNow Fluentde modules JavaScript et de bibliothèques tierces.
      • Module: la configuration d’application par défaut est configurée pour utiliser uniquement les modules JavaScript et les bibliothèques tierces.
      Ajouter un exemple de table à l’application ? Option permettant de créer un exemple de table dans l’application.
      • Oui : un exemple de table nommé <scope>_to_do est créé.
      • Non : aucun exemple de table n’est créé dans l’application.
      Déployer l’application immédiatement ? Option permettant de déployer l’application sur l’instance immédiatement après la création.
      • Oui : l’application est déployée vers l’instance si elle est créée avec succès. Si vous êtes hors ligne, l’application n’est pas déployée.
      • Non : l’application est créée localement, mais n’est pas déployée sur l’instance. Vous devez créer et déployer l’application dans l’instance ultérieurement. Pour plus d'informations, consultez Créez et déployez une application avec le ServiceNow SDK.
      $ now-sdk create
      [now-sdk] Bootstrapping a new ServiceNow application project...
      ==========================================
      
      Create nowSDK Application
      
      ==========================================
      
      ? Connect to an instance (helps ensure the created app is valid)?  yes
      [now-sdk] Listing all credentials: 
      ? Instance credentials:  Add new credentials
      ? Target host for application deployment https://<instance>.service-now.com
      [now-sdk] Authenticating to instance "https://<instance>.service-now.com".
      ? The username to authenticate with the instance admin
      ? The password to authenticate with the instance
      [now-sdk] Attempting to log into instance https://<instance>.service-now.com as admin.
      [now-sdk] Successfully authenticated to instance https://<instance>.service-now.com.
      [now-sdk] Storing credentials for instance "https://<instance>.service-now.com" with alias undefined.
      ? Alias for these credentials devuser2
      [now-sdk] Successfully stored credentials for instance "https://<instance>.service-now.com" with alias undefined.
      ? Name of ServiceNow Application:  My Example App
      ? NPM package name:  my-example-app
      ? Description associated with sys_app:  A custom ServiceNow application
      ? Scope name:  x_snc_myexapp
      ? Project template:  Javascript
      ? Fluent or JS Module project structure?  Fluent
      ? Add a sample table to the application?  yes
      ? Deploy application immediately?  yes

    Résultats

    Une application incluse dans le périmètre avec la structure d’application par défaut est disponible localement. 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.

    Si l’application est créée et déployée dans l’instance, l’interface de ligne de commande renvoie l’URL à l’application, par exemple https://myinstance.service-now.com/sys_app.do?sys_id=<sysID>.

    Que faire ensuite

    Dans Visual Studio Code, commencez à développer votre application dans le code source avec ServiceNow Fluent, écrivez des modules JavaScript personnalisés ou ajoutez des bibliothèques tierces.