Blog

Hogyan készítettem egy PS1-es grafikus segédprogramot a ServiceNow üzemeltetéséhez

A cikk bemutatja egy GUI-s PowerShell eszköz hátterét, tervezését és hatását, amely támogatja a szabványos adat-exportot és a Database View definíciókat ServiceNow-ban.

Adatbázis-export és összekapcsolt táblák

Bevezetés

A ServiceNow tartós üzemeltetése és karbantartása során az adatbázisnézetek elkészítésének tudása könnyen néhány embernél összpontosul, mivel relációs adatbázisokkal kapcsolatos alapismereteket igényel. A grafikus felületen végzett adatmunka más nehézségeket is okoz: nagy adatmennyiségnél az export elérheti a felső korlátot, és egyáltalán nem hajtható végre; a kinyert oszlopok köre a listanézet állapotától függhet; a mellékletek pedig az egyes rekordok között szétszórva találhatók, ezért nehézkes az összegyűjtésük. Ezért készítettem egy PowerShell-segédprogramot, amely grafikus felületen támogatja a nyersadat-exportot és a Database View definíciók összeállítását.

A cikk a nyilvános repozitóriumban elérhető megvalósítás alapján mutatja be a hátteret, a fejlesztési megközelítést, a tervezést és az üzemeltetésre gyakorolt hatást.


1. háttértényező: az adatexport lehetséges, de az üzemeltetési teher nagy

A ServiceNow alapértelmezett felületén is lehet adatot exportálni. A tényleges üzemeltetésben azonban az alábbi problémák halmozódnak fel.

  1. Minden alkalommal ugyanazt az oszlopszerkezetet szeretnénk kinyerni, de a listanézet változásai könnyen befolyásolják az eredményt.
  2. Ha rendszeresen minden oszlopra és a belső nevekre is szükség van, hirtelen megnő az eljárás elmagyarázásának időigénye.
  3. Nagy adatmennyiségnél maga a grafikus export is lelassul, és nehézzé válik a futtatások, illetve újrafuttatások kezelése.

Az üzemeltetők így az adatok felhasználása helyett azok kinyerésének támogatásával töltik az idejüket. Ezért más irányból közelítettem: olyan megoldást alakítottam ki, amellyel az egyes részlegek önállóan, API-n keresztül exportálhatják az előre rögzített oszlopokat.


2. háttértényező: Database View készítésekor kiütköznek az RDB-ismeretek eltérései

A Database View hasznos, de magas belépési küszöböt jelent a nem műszaki felhasználóknak vagy a relációs adatbázisokban kevésbé jártas munkatársaknak.

  • A sys_db_view és a sys_db_view_table kezelése elkülönül, ezért sokat kell váltani a képernyők között.
  • A belső oszlopneveket nehéz egyetlen képernyőn, listában áttekinteni.
  • Admin-jogosultság nélküli környezetben a belső neveket egy másik környezetben kell felkutatni és onnan áthozni.
  • A Where-feltételek és JOIN-definíciók kézi beírása könnyen elgépeléshez vagy hibás hivatkozáshoz vezet.

Ezért úgy láttam, hogy a választható elemeket megjelenítő, grafikus összeállítási segítségre van szükség.


Az elkészült eszköz: PS1 SNOW Utilities

A PS1 SNOW Utilities egy PowerShell-eszköz, amely egyetlen grafikus felületen fogja össze a ServiceNow üzemeltetésében gyakran előforduló feladatokat. A fő lapjai a következők.

1. Export lap

  • Céltábla kiválasztása vagy kézi megadása
  • Szűrés beállítása: minden rekord vagy a sys_updated_on szerinti időszak
  • Kimeneti formátum kiválasztása: CSV / JSON / Excel
  • Több CSV-fájlra bontott export nagy rekordszám esetén
  • Kimeneti mappa megadása és a futási napló ellenőrzése

Az üzemeltetési cél az adatkinyerés egységesítése és az egyes munkatársak eljárásai közötti eltérések csökkentése.

2. Database View Editor lap

  • A nézet belső nevének és címkéjének megadása
  • Alaptábla és előtag beállítása
  • JOIN hozzáadása: bal és jobb oldali oszlop, Variable Prefix, valamint LEFT JOIN-választás
  • Az oszlopjelöltek újbóli lekérése és a megjelenítendő oszlopok kiválasztása
  • Nézet létrehozása és az eredményre mutató hivatkozás megjelenítése

A definíció az elérhető elemeket látva állítható össze. Így kevesebbet kell oda-vissza lépkedni a ServiceNow képernyői között, és kisebb teher a Where-, illetve JOIN-feltételek kézi beírása.

3. Attachment Harvester lap

  • Kapcsolódó mellékletek csoportos összegyűjtése a frissítés időszaka alapján
  • Azonos fájlnevek ütközésének elkerülése sorszámozással
  • A letöltési műveletek naplózása

A funkció megismételhető eljárást ad a mellékletek összegyűjtéséhez, amire auditok és vizsgálatok során gyakran szükség van.

4. Truncate lap

  • A tábla teljes adattartalmának törlése fejlesztési célra
  • Megerősítő kód megadása, a cél adatainak megjelenítése és az újrapróbálkozások beállítása

Veszélyes műveletről van szó, ezért éles környezetben nem ajánlott a használata. A funkció az adatok újbóli betöltésének ellenőrzésére szolgál tesztkörnyezetben.

5. Beállítások lap

  • Példánynév
  • Hitelesítési mód: felhasználói azonosító és jelszó / API-kulcs
  • Nyelv: japán / angol
  • Téma: Dark / Light
  • Egyéni tartományhoz való kapcsolódás beállítása (instanceDomain)

A megadott értékek a settings.json fájlba kerülnek. A bizalmas értékeket a Windows DPAPI CurrentUser módjával titkosítva tárolja a program.

A tervezés legfontosabb szempontjai

A megvalósítás során olyan felépítést tartottam fontosnak, amely csökkenti az üzemeltetés közbeni karbantartási terhet.

  1. A kommunikáció közös függvénybe szervezése
    Az Invoke-SnowRequest fogja össze a GET/POST/PATCH/DELETE műveleteket és a mellékletek lekérését, hogy a hitelesítés, a kivételkezelés és a naplózás ne szóródjon szét a kódban.

  2. A felület felépítésének és megjelenítésének szétválasztása
    A Build-* függvények építik fel a felületi elemeket, míg az Apply-*Language és a Set-Theme végzi a megjelenítés váltását.

  3. A beállítások mentésének megbízhatóbbá tétele
    A Load-Settings / Save-Settings és a Request-SaveSettings csökkenti az elmaradó, illetve a szükségtelenül gyakori mentések számát.

  4. A veszélyes műveletek többszörös megerősítése
    A Truncate művelet megerősítő kódot kér és megjeleníti a célt, ezzel mérsékelve a téves művelet kockázatát.

  5. Naplók alapján utólag követhető megvalósítás
    A Logs lap és a ConvertTo-LogCompactJson megkönnyíti a futási eredmények utólagos visszakövetését.


Tudatos kompromisszum a megvalósításban

Vállalati környezetben magas lehet a telepítőcsomagok terjesztésének és a háttérben futó alkalmazások bevezetésének akadálya. Ezért most a szövegként is terjeszthető és futtatható PowerShell-szkriptformát részesítettem előnyben.

Ezzel a döntéssel csökkenteni tudtam a bevezetési akadályokat és a tényleges használatig eltelt időt.


A bevezetés eredményei

A bevezetés után az alábbi 4 eredmény volt megfigyelhető.

  1. Az Export eljárása a felületen rögzítetté vált, így kevesebb magyarázat kellett az egyes adatkinyerési kérésekhez.
  2. Database View létrehozásakor ritkábban kellett a ServiceNow felületén kézzel megadni a Where-feltételeket.
  3. A mellékletek adott időszakra egy menetben összegyűjthetők, így rövidült a vizsgálatok során végzett ismétlődő munka.
  4. A beállítások mentése csökkentette a példánynév és a hitelesítési adatok újbóli megadásának gyakoriságát.

Az eredmények nem látványosak. Gyakorlati értékük abban rejlik, hogy következetesen rövidítik az üzemeltetők újra és újra elvégzett feladataira fordított időt.


Korlátok és tudnivalók

  • A táblalista a sys_db_object alapján készül, ezért az ACL-ek megakadályozhatják a lekérését. Ilyenkor kézi megadással lehet továbblépni.
  • Egyes környezetekben a Where-feltételek és JOIN-definíciók automatikus mentése korlátozott, és kézi kiegészítésre lehet szükség a ServiceNow-ban.
  • Az eszköz nem áll kapcsolatban a ServiceNow vállalattal, és nem rendelkezik annak jóváhagyásával, garanciájával vagy támogatásával.

Összegzés

A PS1 SNOW Utilities-t azért készítettem, hogy csökkentsem az adatkinyerés és a Database View definíciók körüli gyakorlati elakadásokat.

Személyes benyomásom, hogy bár korábban is tudtam a PowerShelles GUI-készítés lehetőségéről, az nem jutott eszembe, hogy magam is belevágjak. Generatív AI segítségével, szinte no-code jellegű, utasításokra épülő munkával idáig eljutni erősen érzékeltette számomra az AI fejlődésének sebességét. Ugyanakkor úgy gondolom, a hagyományos low-code/no-code eszközök nehezen kerülhetik el azt a helyzetet, amelyben újra kell fogalmazniuk az előnyeiket, miközben az elavulás nyomása is nehezedik rájuk.