ServiceNow SDK CLI

  • Rversion finale: Washingtondc
  • Mis à jour 1 févr. 2024
  • 8 minutes de lecture

    • Utilisez l’interface de ServiceNow ligne de commande (CLI) du SDK pour gérer les changements entre une application locale et l’application sur une instance.

    À partir de l’outil de ligne de commande de votre système, entrez now-sdk pour démarrer l’interface de ligne de commande et renvoyer une liste des commandes disponibles ou now-sdk [command] pour commencer à utiliser le ServiceNow SDK.

    L’interface de ligne de commande comprend les commandes et options globales suivantes :

    Tableau 1. Options globales
    Option Description
    --Version Renvoyer la version de l’interface de ligne de commande.
    --help, -h Renvoie des informations sur les commandes, les sous-commandes et les paramètres.

    autorisation

    Authentifiez-vous auprès d’une instance et stockez, mettez à jour ou affichez les informations d’identification de l’utilisateur pour accéder à une instance de votre système.

    La commande auth dispose des sous-commandes save, clear, view et set-default et de la structure suivante :
    now-sdk auth [<subcommand>]

    Enregistrer

    Stockez les informations d’identification dans le trousseau de l’appareil ou dans le gestionnaire d’informations d’identification de votre système. À l’invite, fournissez un mot de passe pour vous authentifier auprès de l’instance.

    La sous-commande save a la structure suivante :
    now-sdk auth save [<alias>] [--host <hostname>] [--username <username>] [--default]
    Tableau 2. Paramètres requis
    Paramètre Type Description Valeur par défaut
    alias Chaîne Identificateur unique pour les informations d’identification de l’hôte et de l’utilisateur.

    L’alias peut être utilisé pour l’authentification avec les commandes créer, convertir, extraire et déployer .

    		 —
    --Hôte Chaîne Instance cible à laquelle vous souhaitez accéder et vers laquelle vous déployez et extrayez des applications. L’instance doit se trouver sur la Washington DC version. —
    --nom d'utilisateur Chaîne Un nom d’utilisateur pour l’authentification à l’instance. L’utilisateur doit disposer d’un accès administrateur. —
    Tableau 3. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --default, -d Booléen Option permettant de définir l’alias comme alias par défaut. faux

    Par exemple :

    now-sdk auth save devuser1 --host https://myinstance.service-now.com --username user1 --default

    effacer

    Supprimez les informations d’identification dans le trousseau de l’appareil ou le gestionnaire d’informations d’identification sur votre système.

    La sous-commande clear a la structure suivante : 
    now-sdk auth clear [<alias>]
    Tableau 4. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    alias Chaîne Identificateur unique pour les informations d’identification de l’hôte et de l’utilisateur. tous
    Par exemple :
    now-sdk auth clear devuser1

    liste

    Affichez les informations d’identification enregistrées dans le trousseau d’appareils ou le gestionnaire d’informations d’identification sur votre système. Les mots de passe ne sont pas rendus.

    La sous-commande list a la structure suivante : 
    now-sdk auth list [<alias>]
    Tableau 5. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    alias Chaîne Identificateur unique pour les informations d’identification de l’hôte et de l’utilisateur. tous
    Par exemple :
    now-sdk auth list devuser1

    définir par défaut

    Définissez les informations d’identification à utiliser par les commandes par défaut.

    La sous-commande set-default a la structure suivante : 
    now-sdk auth set-default [<alias>]
    Tableau 6. Paramètres requis
    Paramètre Type Description Valeur par défaut
    alias Chaîne Identificateur unique pour les informations d’identification de l’hôte et de l’utilisateur. —
    Par exemple :
    now-sdk auth set-default devuser1

    créer

    Créez une application incluse dans le périmètre personnalisée et, si spécifié, déployez-la sur une instance.

    La structure de la commande create est la suivante :
    now-sdk create <projectName> <scopeName> [<directory>] [--description <description>] [--sampleTable <flag>] [--offline <flag>] [--auth <alias>] [--open-browser <flag>] [--interactive <flag>]
    Tableau 7. Paramètres requis
    Paramètre Type Description Valeur par défaut
    projectName Chaîne Le nom de l'application.

    Le nom de l’application doit respecter les conventions de dénomination des packages NPM.

    		 —
    scopeName (nom du périmètre) Chaîne Périmètre de l’application.

    Le nom du champ d’application doit être unique sur l’instance, commencer par x_&lt;préfixe> et comporter moins de 18 caractères. Pour plus d'informations, consultez Identificateur d’espace de noms.

    		 —
    Tableau 8. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    répertoire Chaîne Répertoire local dans lequel créer les répertoires et les fichiers d’application. Répertoire de travail actuel
    --Description Chaîne Une brève description de votre application. —
    --sampleTable Booléen Une option pour créer un exemple de table dans l’application.

    Si vrai, l’exemple de table (&lt;scope>_to_do.xml) est créé dans le répertoire .metadata .

    		 faux
    --hors ligne, -o Booléen Une option permettant d’ignorer le déploiement d’une application sur l’instance.

    Si vrai, 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.

    Remarque :
    Ce paramètre est ignoré lorsque le paramètre d’authentification est défini.
    		 faux
    --auth, -a Chaîne Un alias pour les informations d’identification à utiliser pour s’authentifier auprès de l’instance. S’il est défini, il s’agit de l’alias par défaut.
    --open-browser, -b Booléen Une option pour ouvrir l’enregistrement d’application (sys_app) dans votre navigateur par défaut après le déploiement réussi de l’application.
    Remarque :
    Ce paramètre est ignoré lorsque le paramètre hors ligne est défini sur vrai.
    		 faux
    --interactif, -i Booléen Option permettant de répondre à un ensemble guidé d’invites pour créer l’application. faux
    Par exemple :
    now-sdk create example-app x_snc_example /path/to/app_folder --description example_app_description --sampleTable true --auth devuser1 --open-browser true

    convertir

    Convertissez une application existante à partir d’une instance pour prendre en charge sa modification locale et Visual Studio Code son déploiement de modifications d’application sur l’instance avec le ServiceNow SDK.

    La conversion d’une application télécharge les fichiers XML de métadonnées de l’application et ajoute les fichiers et répertoires nécessaires à l’utilisation locale du SDK. L’application n’est pas modifiée sur l’instance. Pour plus d’informations, consultez la Structure de l’application section de la ServiceNow rubrique SDK.

    La commande convert a la structure suivante :
    now-sdk convert <scopeName> <packageName> [<directory>] [--auth <alias>] [--scopeId <app_scope_id>]
    Tableau 9. Paramètres requis
    Paramètre Type Description Valeur par défaut
    scopeName (nom du périmètre) Chaîne Le périmètre de l’application existante.

    Pour les applications globales, utilisez le nom de l’application.

    		 —
    Packagename Chaîne Nom du package d’application utilisé dans le fichier package.json .

    Le nom du package doit être conforme aux conventions de nommage des packages NPM.

    		 —
    Tableau 10. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    répertoire Chaîne Répertoire local dans lequel créer les répertoires et les fichiers d’application. Répertoire de travail actuel
    --auth, -a Chaîne Un alias pour les informations d’identification à utiliser pour s’authentifier auprès de l’instance. S’il est défini, il s’agit de l’alias par défaut.
    --scopeId Chaîne La sys_id de l’application existante.
    Remarque :
    Ce paramètre est requis pour convertir des applications globales.
    		 —

    Par exemple :

    now-sdk convert x_snc_example example-app /path/to/app_folder --auth user1-dev --scopeId example_app_scope_id

    Chercher

    Téléchargez les métadonnées d’application à partir d’une instance et mettez à jour les fichiers XML de métadonnées dans votre application locale pour qu’ils correspondent.

    La structure de la commande fetch est la suivante :
    now-sdk fetch [--directory <package path>] [--mode <fetch mode>] [--auth <alias>]
    Tableau 11. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --Répertoire Chaîne Le chemin d’accès de votre application. Répertoire de travail actuel
    --mode, -m Chaîne Option pour les métadonnées à extraire.
    • complete : extraire toutes les métadonnées de l’application.
    • Incrémentiel : extrait uniquement les changements apportés aux métadonnées de l’application depuis votre dernière extraction.
    		 Incrémental
    --auth, -a Chaîne Un alias pour les informations d’identification à utiliser pour s’authentifier auprès de l’instance. S’il est défini, il s’agit de l’alias par défaut.
    Par exemple : 
    now-sdk fetch --auth devuser1 --directory /path/to/package --mode incremental

    build

    Compilez les fichiers sources et générez un package déployable. Les dépendances de bibliothèques tierces sont converties en fichiers XML qui peuvent être installés avec l’application.

    La structure de la commande build est la suivante :
    now-sdk build <source> [--debug <flag>] [--generate-deletes <flag>] [--lint <flag>] [--optimize <flag>]
    Tableau 12. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    source Chaîne Le chemin d’accès au fichier package.json de votre application.

    Le package.json doit se trouver dans le répertoire de base de votre application.

    		 Répertoire de travail actuel
    --debug, -d Booléen Option permettant de renvoyer les journaux de débogage générés pendant le processus de génération. faux
    --générer-supprime Booléen Option permettant de générer des mises à jour d’enregistrements de suppression pour les fichiers supprimés entre les versions. VRAI
    --Charpie Booléen Option permettant de cloner les fichiers sources avant de les générer. VRAI
    --optimiser, -o Booléen Option permettant d’optimiser l’empaquetage en réutilisant les fichiers XML de dépendance inchangés. VRAI
    Par exemple :
    now-sdk build /path/to/package --debug true --generate-deletes true --lint true --optimize true

    Déployer

    Déployez une application sur une instance. Avant d’utiliser la commande deploy , vous devez utiliser la commande build pour générer un package déployable.

    La structure de la commande deploy est la suivante :

    now-sdk deploy [--source <package path>] [--mode <deploy mode>] [--auth <alias>] [--open-browser <flag>]
    Tableau 13. Paramètres facultatifs
    Paramètre Type Description Valeur par défaut
    --Source Chaîne Le chemin d’accès au fichier package.json de votre application.

    Le package.json doit se trouver dans le répertoire de base de votre application.

    		 Répertoire de travail actuel
    --mode, -m Chaîne Une option pour le déploiement de l’application.
    • terminer : déployez l’intégralité de l’application.
    • réinstaller : désinstallez et réinstallez l’application sur l’instance pour vous assurer que les métadonnées de l’instance correspondent aux métadonnées du package de déploiement.
      Avertissement :
      Les métadonnées qui se trouvent sur l’instance, mais pas dans votre application locale, sont supprimées.
    • Incrémentiel : déployez uniquement les changements apportés aux métadonnées de l’application depuis votre dernier déploiement.
    		 Incrémental
    --auth, -a Chaîne Un alias pour les informations d’identification à utiliser pour s’authentifier auprès de l’instance. S’il est défini, il s’agit de l’alias par défaut.
    --open-browser, b Booléen Une option pour ouvrir l’enregistrement d’application (sys_app) dans votre navigateur par défaut après le déploiement réussi de l’application. faux
    --info, -i Booléen Option permettant de renvoyer des détails sur le déploiement le plus récent de cette application, tels que l’état et les enregistrements mis à jour. Lorsque ce paramètre est utilisé, l’application n’est pas déployée. faux
    Par exemple : 
    now-sdk deploy --auth devuser1 --source /path/to/package --mode incremental --open-browser true