Créer ou convertir une application avec l’attribut ServiceNow SDK

  • Rversion finale: Xanadu
  • Mis à jour 1 août 2024
  • 3 minutes de lecture
  • Créez une application incluse dans le périmètre ou convertissez une application existante pour qu’elle soit développée en code source avec le ServiceNow SDKfichier .

    Avant de commencer

    Installez ou mettez à niveau le npm à l’aide de ServiceNow SDK . Pour plus d'informations, voir Installer ServiceNow SDK ou Mettre à niveau la ServiceNow SDK.

    Rôle requis : administrateur

    Pourquoi et quand exécuter cette tâche

    Cette procédure utilise l’interface de ServiceNow SDK ligne de commande (CLI). Pour plus d’informations sur les commandes et les paramètres disponibles, reportez-vous à la section ServiceNow SDK CLI.

    Procédure

    1. Dans le répertoire dans lequel vous souhaitez ajouter une application, ouvrez un outil en ligne de commande sur votre système.
    2. Démarrez le ServiceNow SDKfichier .
      now-sdk
      Renvoie ServiceNow SDK des informations sur les commandes disponibles.
      Conseil :
      Pour obtenir des informations supplémentaires sur une commande, entrez la commande et le paramètre --help ou -h . Par exemple, now-sdk auth --help.
    3. Authentifiez-vous auprès d’une instance de non-production ServiceNow .
      L’instance doit figurer sur la Xanadu mise en production.
      1. Stockez vos informations d’identification d’utilisateur à l’aide d’un alias avec la commande auth .
        now-sdk auth save [<alias>] [--host <instance url>] [--username <admin username>]

        Les informations d’identification sont stockées dans le trousseau de clés de l’appareil ou dans le gestionnaire d’informations d’identification de votre système.

        Pour définir cet alias comme alias par défaut, ajoutez le paramètre --default ou -d à votre commande.

        Par exemple :
        now-sdk auth save devuser1 --host https://myinstance.service-now.com --username user1 --default
      2. À l’invite, entrez votre mot de passe.
    4. Créez une application incluse dans le périmètre ou convertissez une application existante pour l’utiliser avec le ServiceNow SDKfichier .
      OptionÉtapes
      Créer une application incluse dans le périmètre
      1. Créez une application suivant un ensemble guidé d’invites à l’aide de la commande create :
        now-sdk create <scopeName> --interactive
        Par exemple :
        now-sdk create x_snc_example --interactive
        Remarque :
        Le nom du champ d’application doit être unique sur l’instance, commencer par x_<préfixe> et comporter 12 caractères maximum. Pour en savoir plus, consultez Identificateur d’espace de noms.
      2. Répondez aux invites suivantes :
        • Nom de l’application incluse dans le périmètre : <nom de l’application>
        • Description associée à sys_app : <description>
        • Modèle de projet ? Sélectionner TypeScript ou JavaScript
        • Nom du package NPM : <nom du package>
        • Ajouter un exemple de table à l’application ? [Oui/Non]
        • Créer une structure de projet Fluent ou JS Module ? Sélectionner Courant ou Module

          Cette option détermine la structure de l’application par défaut selon que vous souhaitez utiliser ServiceNow Fluent des modules JavaScript et des bibliothèques tierces dans l’application (fluent) ou utiliser uniquement des modules JavaScript et des bibliothèques tierces (module).

      Convertir une application existante Convertissez une application incluse dans le périmètre existante à partir de votre instance à l’aide de la commande convert :
      now-sdk convert <scopeName> <packageName> --projectType <type>

      Utilisez le paramètre --projectType pour spécifier le type d’application à créer. Cette option détermine la structure de l’application par défaut selon que vous souhaitez utiliser ServiceNow Fluent des modules JavaScript et des bibliothèques tierces dans l’application (fluent) ou utiliser uniquement des modules JavaScript et des bibliothèques tierces (module).

      Par exemple :
      now-sdk convert x_snc_example example-app --projectType fluent

      La conversion d’une application ajoute les fichiers et répertoires nécessaires à l’utilisation ServiceNow SDK locale et télécharge les métadonnées de l’application sous forme ServiceNow Fluent de code source ou de fichiers XML, selon le type de projet. L’application n’est pas modifiée dans l’instance.

    Résultats

    Une application incluse dans le périmètre avec la structure d’application par défaut est disponible localement. Pour en savoir plus sur la structure de l’application, reportez-vous à la Structure de l’application section de la rubrique Création d’applications en code source.

    Si l’application est créée et déployée sur 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>. Si vous avez choisi de ne pas générer et enregistrer l’application sur l’instance lors de la création, l’application n’est pas déployée sur l’instance tant que vous ne l’avez pas fait. Pour plus d'informations, consultez Créez et déployez une application avec l’option ServiceNow SDK.

    Que faire ensuite

    Dans Visual Studio Code, Commencez à développer votre application en code source à l’aide ServiceNow Fluentde , en écrivant des modules JavaScript personnalisés ou en ajoutant des bibliothèques tierces.