Blog

Cum am creat un utilitar PS1 cu interfață grafică pentru a simplifica operarea ServiceNow

Articolul prezintă contextul, designul și efectele unui utilitar PowerShell cu GUI pentru exporturi de date standardizate și definirea Database View în ServiceNow.

Export de baze de date și tabele legate

Introducere

În administrarea și întreținerea ServiceNow, crearea vizualizărilor de baze de date ajunge ușor să depindă de câteva persoane, deoarece necesită cunoștințe de bază despre bazele de date relaționale (RDB). Nici folosirea datelor prin interfața grafică nu este lipsită de dificultăți: un volum mare poate depăși limita și poate face exportul imposibil, coloanele extrase se pot schimba în funcție de vizualizarea listei, iar atașamentele sunt răspândite între înregistrări și se adună greu. De aceea am creat un utilitar PowerShell care asistă, prin GUI, exportul datelor brute și definirea Database View.

Articolul prezintă contextul, abordarea implementării, proiectarea și efectele asupra operării, pornind de la implementarea din depozitul public.

  • Numele instrumentului: PS1 SNOW Utilities
  • Depozit: https://github.com/arimagml-collab/PS1SOWUtilities
  • Implementare: PowerShell 5.1 + WinForms, cu execuție locală pe Windows
  • Materiale consultate: README, scriptul principal și notele de proiectare (docs/)

Contextul 1: exportul datelor este posibil, dar operarea rămâne greoaie

Interfața standard ServiceNow permite exportul datelor. În practică însă se acumulează următoarele probleme.

  1. Vrei aceeași structură de coloane la fiecare export, dar modificările vizualizării listei o influențează ușor.
  2. Când ceri o extragere standardizată cu toate coloanele și cu numele lor interne, efortul de explicare a pașilor crește mult.
  3. La volume mari, exportul prin GUI devine lent, iar gestionarea execuțiilor și a reluărilor se complică.

Echipa de întreținere ajunge astfel să ofere ajutor pentru obținerea datelor, în loc să se concentreze pe utilizarea lor. Am schimbat abordarea și am pregătit un mecanism prin care fiecare departament își poate exporta singur coloanele prestabilite, prin API.


Contextul 2: crearea Database View scoate în evidență diferențele de cunoștințe RDB

Database View este util, dar reprezintă un prag ridicat pentru utilizatorii fără profil tehnic sau cu puțină experiență în baze de date relaționale.

  • Lucrul cu sys_db_view și sys_db_view_table se desfășoară separat și presupune multe treceri între ecrane.
  • Este dificil să consulți într-o singură listă, pe același ecran, numele interne ale coloanelor.
  • Într-un mediu fără drepturi Admin, numele interne trebuie căutate într-un alt mediu și aduse de acolo.
  • Scrierea manuală a clauzelor Where și a definițiilor JOIN favorizează greșelile de tastare și referințele incorecte.

Am considerat, prin urmare, că este necesar un ajutor pentru construirea definițiilor în GUI, cu opțiunile disponibile la vedere.


Ce am construit: PS1 SNOW Utilities

PS1 SNOW Utilities este un instrument PowerShell care reunește într-o singură interfață grafică operațiuni frecvente din administrarea ServiceNow. Filele principale sunt următoarele.

1. Fila Export

  • Selectarea tabelului țintă sau introducerea lui manuală
  • Filtrare: toate înregistrările sau un interval bazat pe sys_updated_on
  • Alegerea formatului de ieșire: CSV / JSON / Excel
  • Export împărțit în mai multe CSV-uri pentru volume mari de înregistrări
  • Alegerea folderului de ieșire și consultarea jurnalului de execuție

Scopul operațional este standardizarea extragerii și reducerea diferențelor dintre procedurile folosite de fiecare persoană.

2. Fila Database View Editor

  • Introducerea numelui intern și a etichetei vizualizării
  • Configurarea tabelului de bază și a prefixului
  • Adăugarea unui JOIN: coloanele din stânga și din dreapta, Variable Prefix și opțiunea LEFT JOIN
  • Reîncărcarea coloanelor disponibile și selectarea celor care vor fi afișate
  • Crearea vizualizării și afișarea linkului către rezultat

Definiția poate fi construită consultând opțiunile disponibile. Astfel scade efortul de a trece repetat între ecranele ServiceNow și de a scrie manual clauze Where sau condiții JOIN.

3. Fila Attachment Harvester

  • Colectarea în lot a atașamentelor asociate, pe baza intervalului de actualizare
  • Evitarea coliziunilor de nume prin adăugarea unor numere de ordine
  • Înregistrarea în jurnal a procesului de descărcare

Funcția face mai ușor de repetat colectarea atașamentelor, necesară frecvent la audituri și investigații.

4. Fila Truncate

  • Ștergerea întregului conținut al unui tabel, pentru utilizare în dezvoltare
  • Introducerea unui cod de confirmare, afișarea informațiilor despre țintă și configurarea reîncercărilor

Este o operațiune periculoasă, iar utilizarea în producție nu este recomandată. Funcția este destinată testelor de reîncărcare a datelor într-un mediu de verificare.

5. Fila de setări

  • Numele instanței
  • Metoda de autentificare: ID de utilizator și parolă / cheie API
  • Limba: japoneză / engleză
  • Tema: Dark / Light
  • Conectarea printr-un domeniu propriu (instanceDomain)

Valorile introduse sunt salvate în settings.json, iar cele sensibile sunt păstrate criptat cu Windows DPAPI, în modul CurrentUser.

Punctele esențiale ale proiectării

În această implementare am pus accentul pe o structură care reduce efortul de întreținere în timpul exploatării.

  1. Centralizarea comunicării într-o funcție comună
    Invoke-SnowRequest încapsulează operațiunile GET/POST/PATCH/DELETE și descărcarea atașamentelor, pentru a evita împrăștierea autentificării, tratării excepțiilor și jurnalizării în cod.

  2. Separarea construirii interfeței de controlul afișării
    Funcțiile Build-* construiesc elementele interfeței, iar Apply-*Language și Set-Theme schimbă modul de afișare.

  3. Stabilizarea salvării setărilor
    Load-Settings / Save-Settings și Request-SaveSettings urmăresc să reducă atât schimbările rămase nesalvate, cât și salvările excesive.

  4. Confirmări multiple pentru operațiunile periculoase
    Operația Truncate include un cod de confirmare și afișarea țintei, pentru a reduce riscul unei acțiuni greșite.

  5. O implementare care poate fi urmărită ulterior în jurnale
    Fila Logs și ConvertTo-LogCompactJson fac mai ușoară verificarea ulterioară a rezultatelor execuției.


Compromisul asumat în implementare

Într-un mediu de companie, distribuirea instalatoarelor și introducerea aplicațiilor care rulează permanent în fundal pot întâmpina obstacole serioase. De aceea am preferat, de această dată, forma de script PowerShell care poate fi distribuit și ca text și apoi executat.

Acest compromis a redus barierele de introducere și a scurtat timpul până la utilizarea efectivă.


Efectele introducerii

După introducerea instrumentului am constatat următoarele 4 efecte.

  1. Pașii de export au devenit fixați în interfață, reducând explicațiile necesare pentru fiecare cerere de extragere.
  2. La crearea Database View, au fost mai puține situații în care trebuiau scrise manual clauze Where în interfața ServiceNow.
  3. Atașamentele pot fi colectate într-o singură operațiune pentru un interval dat, scurtând munca repetitivă din timpul investigațiilor.
  4. Salvarea setărilor a redus numărul de reintroduceri ale numelui instanței și ale informațiilor de autentificare.

Rezultatele nu sunt spectaculoase, dar au valoare practică: reduc constant timpul consumat de sarcinile pe care personalul de operare le repetă la fiecare solicitare.


Limitări și precauții

  • Lista tabelelor este citită din sys_db_object, astfel că ACL-urile pot împiedica obținerea ei. Introducerea manuală a numelui oferă o alternativă.
  • În anumite medii există restricții la salvarea automată a clauzelor Where și a definițiilor JOIN; poate fi necesară completarea lor manuală în ServiceNow.
  • Instrumentul nu este afiliat companiei ServiceNow și nu beneficiază de aprobarea, garanția sau suportul acesteia.

Concluzie

Am creat PS1 SNOW Utilities pentru a reduce blocajele practice legate de extragerea datelor și de definirea Database View.

Ca impresie personală, știam de mai mult timp că se poate construi un GUI în PowerShell, dar nu mă gândisem să încep eu însumi. Faptul că, ajutat de AI generativă, am putut ajunge la această formă prin instrucțiuni, aproape ca într-un flux no-code, m-a făcut să simt puternic ritmul evoluției AI. În același timp, cred că instrumentele low-code/no-code tradiționale vor evita cu greu o etapă în care trebuie să-și redefinească avantajele și sunt supuse presiunii de a deveni depășite.