ServiceNow SDK

Utilisez le ServiceNow® kit de développement logiciel (SDK) pour ajouter localement des modules JavaScript et des bibliothèques tierces aux applications et charger les modifications dans une instance du Now Platform.

ServiceNow Vue d’ensemble du SDK

Avec le SDK, les ServiceNow développeurs peuvent créer et modifier des applications incluses dans le périmètre avec des modules personnalisés et des bibliothèques Visual Studio Code tierces, et déployer ces applications sur une instance de non-production sur la Washington DC version. L’écriture ServiceNow d’applications en dehors d’une instance vous permet d’utiliser des pratiques de développement standard et des ServiceNow outils familiers, et de détecter les erreurs au moment de la génération plutôt qu’au moment de l’exécution uniquement.

Les applications créées ou converties avec le Kit de développement logiciel (SDK) incluent les fichiers de code source et les fichiers XML de métadonnées générés à partir des enregistrements de la base de données de l’application. Un fichier package.json définit la structure de l’application, qui est similaire à celle des applications Node.js ou des packages npm (Node Package Manager).

Le Kit de développement logiciel (SDK) comprend une interface de ligne de commande (CLI) permettant de gérer les changements entre une instance et une application locale. À l’aide de commandes CLI simples, vous pouvez créer, convertir, générer, déployer et extraire des applications.

ServiceNow Workflow SDK

L’infographie suivante montre le workflow permettant aux développeurs de commencer à développer des applications qui utilisent des modules JavaScript et des bibliothèques tierces avec le Kit de développement logiciel ( ServiceNow SDK).

Figure 1. Développement d’applications avec le Kit de développement logiciel ( ServiceNow SDK)

1. Un développeur doté du rôle admin installe le SDK.
2. À l’aide de l’interface de ligne de commande, le développeur s’authentifie auprès d’une instance de non-production pour assurer l’interface entre son environnement local et l’instance à l’aide de la commande now-sdk auth .
3. Le développeur crée une application incluse dans le périmètre (now-sdk create) ou convertit une application incluse dans le périmètre existante à partir de l’instance (now-sdk convert) pour l’utiliser avec le Kit de développement logiciel (SDK).
4. Dans Visual Studio Code, le développeur écrit des modules JavaScript personnalisés et ajoute des bibliothèques tierces.
5. Le développeur génère l’application, qui compile le code source, le transforme en métadonnées de base de données pour l’instance et génère un package déployable (now-sdk build).
6. Le développeur déploie l’application sur l’instance (now-sdk deploy).
7. Les autres utilisateurs peuvent continuer à modifier les métadonnées de l’application sur l’instance, et les développeurs peuvent réutiliser le code des modules d’autres modules ou scripts avec le SDK.
8. Le développeur récupère l’application sur l’instance pour obtenir localement les dernières mises à jour des métadonnées de l’application (extraction now-sdk).

ServiceNow Avantages du SDK

Avantage	Fonctionnalité	Utilisateurs
Écrivez des modules JavaScript personnalisés pour organiser et réutiliser le code dans les applications incluses dans le périmètre.	Modules JavaScript et bibliothèques tierces Développement d’applications avec le Kit de développement logiciel ( ServiceNow SDK)	Développeurs
Utilisez les utilitaires JavaScript tiers existants pour éviter de réécrire les fonctionnalités open source existantes.
Réduisez le délai de rentabilisation des applications en augmentant la productivité, l’efficacité et l’optimisation.
Utilisez des outils de développement familiers avec des fonctionnalités JavaScript standard, notamment TypeScript, la sécurité de type, Intellisense et l’application des dépendances.	Utilisation de TypeScript avec le Kit de développement logiciel (SDK)ServiceNow

Structure de l’application

Les applications créées avec le Kit de développement logiciel (SDK) incluent les répertoires et fichiers suivants :

Remarque :

Les développeurs ne doivent pas modifier ou conserver manuellement les répertoires dist, node_modules et cible , ainsi que tous les fichiers et répertoires commençant par . dans le contrôle de code source.

.Métadonnées

Répertoire contenant les fichiers XML de métadonnées de l’application, tels que les schémas de table et les règles métier, organisés dans la même structure de répertoire que les applications existantes ServiceNow .

Ce répertoire contient un exemple de règle métier (sys_script_<sysID>.xml) par défaut et, s’il est spécifié, un exemple de table (<scope>_to_do.xml).

Remarque :

Les métadonnées d’application doivent être modifiées sur l’instance plutôt qu’à l’échelle locale.

.Maintenant

Répertoire contenant des informations de mesures et de mise en cache pour les processus de génération et de déploiement.

Dist

Répertoire contenant les artefacts de build pour l’empaquetage.

node_modules

Répertoire contenant les modules de Node.js tiers dont votre application dépend. Ce répertoire est ajouté lorsque des paquets sont installés avec npm.

src (en anglais seulement)

Répertoire contenant le code du module (fichiers JavaScript ou TypeScript), y compris un exemple de module nommé myfunction.js.

target

Répertoire contenant un package déployable à charger vers une instance.

.eslintrc.json

Fichier contenant la configuration ESLint. ESLint permet d’identifier et de résoudre les problèmes dans le code de l’application.

package.json

Fichier contenant des informations sur votre application, la ServiceNow configuration 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.

Dans le fichier package.json , la configuration de l’application ServiceNow est définie dans l’objet now .

"now": {
        "scope": "x_snc_example_app",
        "scopeId": "2f8400eb07426110f736e28f69d3017a",
        "moduleDir": "src"
    }

Vous pouvez configurer la structure des répertoires d’une application dans le fichier package.json avec les paramètres suivants :

Répmodule

Répertoire contenant le code du module (fichiers JavaScript ou TypeScript). La valeur par défaut est src.

Répertoire de métadonnées

Répertoire contenant les métadonnées de l’application sous forme de fichiers XML. La valeur par défaut est .metadata.

compileOutputDir

Répertoire permettant de générer les artefacts de version pour l’empaquetage lors de la création de l’application. La valeur par défaut est dist/app.

Répertoire cpackSortieRépertoire

Répertoire de sortie du fichier zip à charger vers une instance lors de la création de l’application. La valeur par défaut est target.