Blog

J’ai créé un utilitaire PS1 GUI pour simplifier l’exploitation ServiceNow

Cet article présente le contexte, la conception et les résultats d’un utilitaire PowerShell avec interface GUI pour l’export de données standardisé et la définition de Database View dans ServiceNow.

Export de base de données et tables liées

Introduction

Avec le temps, l’exploitation et la maintenance de ServiceNow font apparaître une dépendance à certaines personnes pour créer les vues de base de données : cette tâche repose sur des connaissances de base en bases relationnelles (RDB). De plus, lorsqu’on veut exploiter les données depuis la GUI, un volume important peut dépasser les limites et rendre l’export impossible, les colonnes obtenues varient selon l’état de la vue en liste, et les pièces jointes sont dispersées entre les enregistrements, ce qui complique leur collecte. J’ai donc créé un utilitaire PowerShell avec GUI pour faciliter l’export de données brutes et la définition de Database View.

Cet article présente le contexte, les choix d’implémentation, la conception et les effets sur l’exploitation, en s’appuyant sur le code du dépôt public.


Contexte 1 : l’export de données est possible, mais lourd à exploiter

L’interface standard de ServiceNow permet d’exporter des données. En exploitation réelle, les difficultés suivantes finissent toutefois par s’accumuler.

  1. On souhaite retrouver la même structure de colonnes à chaque export, mais les changements de vue en liste influencent facilement le résultat.
  2. Dès qu’il faut une extraction standardisée de toutes les colonnes avec leurs noms internes, l’effort nécessaire pour expliquer la procédure augmente fortement.
  3. Avec de gros volumes, l’export par la GUI devient lui-même lourd, et la gestion des exécutions et des relances se complique.

L’équipe de maintenance passe alors du temps à expliquer comment extraire les données plutôt que comment les utiliser. J’ai changé d’approche en préparant un dispositif permettant à chaque service d’exporter de manière autonome un ensemble fixe de colonnes via l’API.


Contexte 2 : créer une Database View révèle les écarts de connaissances en RDB

Database View est utile, mais représente une difficulté pour les non-ingénieurs ou les utilisateurs peu expérimentés en bases de données relationnelles.

  • Les opérations sur sys_db_view et sys_db_view_table se font dans des contextes distincts, avec de nombreux changements d’écran.
  • Il est difficile de consulter la liste des noms internes des colonnes sur un même écran.
  • Dans un environnement sans droits Admin, il faut rechercher les noms internes dans un autre environnement, puis les reporter.
  • Saisir manuellement les clauses Where et les définitions de JOIN expose aux fautes de frappe et aux erreurs de référence.

J’ai donc jugé nécessaire d’aider à construire les définitions dans une GUI tout en voyant les options disponibles.


L’outil réalisé : PS1 SNOW Utilities

PS1 SNOW Utilities est un outil PowerShell qui regroupe dans une seule GUI des tâches fréquentes de l’exploitation ServiceNow. Ses principaux onglets sont les suivants.

1. Onglet Export

  • Sélection de la table cible ou saisie manuelle
  • Filtres : tous les enregistrements ou une période sur sys_updated_on
  • Choix du format de sortie : CSV / JSON / Excel
  • Export réparti entre plusieurs CSV pour les gros volumes
  • Choix du dossier de destination et consultation du journal d’exécution

L’objectif opérationnel est de standardiser l’extraction pour réduire les différences de procédure d’une personne à l’autre.

2. Onglet Database View Editor

  • Saisie du nom interne et du libellé de la vue
  • Configuration de la table de base et du Prefix
  • Ajout de JOIN : colonnes gauche et droite, Variable Prefix et option LEFT JOIN
  • Actualisation des colonnes disponibles et choix de celles à afficher
  • Création de la vue et affichage du lien vers le résultat

La définition se construit en consultant les options disponibles. Cela réduit les allers-retours entre les écrans de ServiceNow pour saisir manuellement les clauses Where et les conditions de JOIN.

3. Onglet Attachment Harvester

  • Collecte groupée des pièces jointes associées, filtrée par période de mise à jour
  • Ajout de numéros successifs pour éviter les collisions de noms de fichiers
  • Journalisation des opérations de récupération

Cette fonction facilite la collecte de pièces jointes, courante lors d’audits ou d’investigations, selon une procédure reproductible.

4. Onglet Truncate

  • Suppression de tous les enregistrements d’une table pour les besoins du développement
  • Saisie d’un code de confirmation, affichage de la cible et configuration des nouvelles tentatives

Cette opération étant dangereuse, son usage en production est déconseillé. Elle est prévue pour tester le rechargement des données dans un environnement de validation.

5. Onglet de configuration

  • Nom de l’instance
  • Mode d’authentification : identifiant et mot de passe / clé d’API
  • Langue : japonais / anglais
  • Thème : Dark / Light
  • Connexion à un domaine personnalisé : instanceDomain

Les valeurs saisies sont enregistrées dans settings.json. Les valeurs sensibles sont conservées après chiffrement avec Windows DPAPI (CurrentUser).

Les points clés de la conception

Dans cette implémentation, j’ai privilégié une conception qui diminue la charge de maintenance pendant l’exploitation.

  1. Centraliser les communications dans des fonctions communes
    Invoke-SnowRequest encapsule GET/POST/PATCH/DELETE et la récupération des pièces jointes, afin d’éviter de disperser l’authentification, la gestion des exceptions et la journalisation.

  2. Séparer la construction de l’UI du contrôle de l’affichage
    Les fonctions Build-* construisent les éléments de l’UI, tandis que Apply-*Language et Set-Theme gèrent les changements d’affichage.

  3. Fiabiliser l’enregistrement de la configuration
    Load-Settings / Save-Settings et Request-SaveSettings permettent de limiter à la fois les oublis d’enregistrement et les enregistrements excessifs.

  4. Multiplier les confirmations pour les opérations dangereuses
    Truncate passe par un code de confirmation et l’affichage de la cible pour réduire les risques de fausse manipulation.

  5. Prévoir le suivi à partir des journaux
    L’onglet Logs et ConvertTo-LogCompactJson facilitent l’examen a posteriori des résultats d’exécution.


Un choix pragmatique d’implémentation

En entreprise, la distribution d’installateurs et l’introduction d’applications résidentes peuvent se heurter à de nombreux obstacles. J’ai donc privilégié un script PowerShell pouvant fonctionner même lorsqu’il est distribué sous forme de texte.

Ce compromis a réduit la difficulté de déploiement et raccourci le délai avant la première utilisation sur le terrain.


Effets observés après la mise en place

Après l’introduction de l’outil, j’ai pu constater les 4 effets suivants.

  1. La procédure d’Export est fixée à l’écran, ce qui réduit les explications nécessaires pour chaque demande d’extraction.
  2. La création d’une Database View exige moins souvent de saisir des clauses Where à la main dans l’UI de ServiceNow.
  3. La collecte groupée des pièces jointes avec un filtre de période réduit les tâches répétitives pendant les investigations.
  4. L’enregistrement de la configuration réduit les saisies répétées du nom de l’instance et des informations d’authentification.

Les gains n’ont rien de spectaculaire, mais leur valeur pratique est réelle : ils réduisent concrètement le temps consacré aux mêmes tâches répétées par les équipes d’exploitation.


Limites et précautions

  • La liste des tables provient de sys_db_object. Selon les ACL, sa récupération peut être impossible ; la saisie manuelle permet de contourner ce problème.
  • Certains environnements limitent l’enregistrement automatique des clauses Where ou des définitions de JOIN. Il peut alors être nécessaire de les compléter manuellement dans ServiceNow.
  • Cet outil est indépendant de ServiceNow et ne bénéficie ni de son approbation, ni de sa garantie, ni de son support.

Synthèse

J’ai créé PS1 SNOW Utilities pour réduire les difficultés pratiques liées à l’extraction des données et à la définition de Database View.

À titre personnel, je savais déjà qu’il était possible de créer une GUI avec PowerShell, mais je n’avais pas eu l’idée de m’y mettre moi-même. Arriver à ce résultat avec l’aide de l’IA générative, en donnant des instructions d’une manière proche du no-code, m’a fait mesurer très concrètement la rapidité de son évolution. En parallèle, je pense que les outils traditionnels de low-code et de no-code auront du mal à éviter une période où ils devront redéfinir leurs avantages et subiront une pression d’obsolescence.