Jak jsem vytvořil PS1 nástroj s GUI pro snazší provoz ServiceNow
Článek shrnuje důvody, návrh a přínosy PowerShell utility s GUI pro pravidelný export dat a definice Database View v ServiceNow.
Úvod
Při dlouhodobé správě a údržbě ServiceNow se tvorba databázových pohledů snadno stává záležitostí několika konkrétních lidí, protože závisí na základních znalostech relačních databází (RDB). Ani práce s daty přes GUI není vždy jednoduchá: velký objem může překročit limit a export znemožnit, vybrané sloupce se mění podle zobrazení seznamu a přílohy jsou rozptýlené u jednotlivých záznamů, takže jejich shromáždění zabere čas. Proto jsem vytvořil nástroj v PowerShellu, který přes GUI podporuje export surových dat a definování Database View.
Článek shrnuje pozadí, přístup k implementaci, návrh a přínosy pro provoz na základě implementace ve veřejném repozitáři.
- Název nástroje: PS1 SNOW Utilities
- Repozitář: https://github.com/arimagml-collab/PS1SOWUtilities
- Provedení: PowerShell 5.1 + WinForms, spouštěné lokálně ve Windows
- Podklady: README, hlavní skript a návrhové poznámky (
docs/)
Pozadí 1: data exportovat lze, ale provozní režie je vysoká
Standardní rozhraní ServiceNow export dat umožňuje. V reálném provozu se však postupně hromadí následující problémy.
- Potřebuji pokaždé stejnou sestavu sloupců, ale změny zobrazení seznamu ji snadno ovlivní.
- Požadavek na pravidelný export všech sloupců včetně interních názvů výrazně zvyšuje čas potřebný k vysvětlení postupu.
- Při velkém objemu dat je samotný export přes GUI pomalý a obtížně se řídí jeho spouštění i opakování.
Správci pak místo využití dat věnují čas pomoci s jejich získáním. Zvolil jsem proto jiný přístup: umožnit jednotlivým oddělením samostatně exportovat předem stanovené sloupce přes API.
Pozadí 2: tvorba Database View odhaluje rozdíly ve znalostech RDB
Database View jsou užitečné, ale pro netechnické uživatele nebo lidi s malou zkušeností s relačními databázemi představují vysokou překážku.
- Práce s
sys_db_viewasys_db_view_tableprobíhá odděleně a vyžaduje mnoho přechodů mezi obrazovkami. - Interní názvy sloupců se obtížně prohlížejí společně na jedné obrazovce.
- V prostředí bez oprávnění Admin je nutné interní názvy zjistit v jiném prostředí a přenést je.
- Ruční zápis klauzulí Where a definic JOIN snadno vede k překlepům nebo chybným odkazům.
Vyhodnotil jsem proto, že je potřeba podpora sestavování definic v GUI s průběžným výběrem z dostupných možností.
Co jsem vytvořil: PS1 SNOW Utilities
PS1 SNOW Utilities je nástroj v PowerShellu, který soustřeďuje časté úlohy při provozu ServiceNow do jednoho GUI. Hlavní karty mají následující podobu.
1. Karta Export
- Výběr cílové tabulky nebo její ruční zadání
- Nastavení filtru: všechny záznamy nebo období podle
sys_updated_on - Volba výstupního formátu: CSV / JSON / Excel
- Export rozdělený do více CSV pro velký počet záznamů
- Výběr výstupní složky a kontrola logu průběhu
Z provozního hlediska jde o sjednocení postupu extrakce a omezení rozdílů mezi jednotlivými pracovníky.
2. Karta Database View Editor
- Zadání interního názvu a popisku pohledu
- Nastavení základní tabulky a prefixu
- Přidání JOIN: levý a pravý sloupec, Variable Prefix a volba LEFT JOIN
- Opětovné načtení dostupných sloupců a výběr těch, které se mají zobrazit
- Vytvoření pohledu a zobrazení odkazu na výsledek
Definici lze sestavovat s přehledem dostupných možností. Tím se omezuje přecházení mezi obrazovkami ServiceNow a ruční zadávání klauzulí Where nebo podmínek JOIN.
3. Karta Attachment Harvester
- Hromadné shromáždění souvisejících příloh podle období aktualizace
- Řešení shodných názvů souborů přidáním pořadového čísla
- Zaznamenávání průběhu stahování do logu
Funkce usnadňuje opakovatelný sběr příloh, který bývá potřeba při auditech a šetřeních.
4. Karta Truncate
- Smazání všech záznamů tabulky pro vývojové účely
- Zadání potvrzovacího kódu, zobrazení informací o cíli a nastavení opakovaných pokusů
Jde o nebezpečnou operaci, jejíž použití v produkci se nedoporučuje. Funkce je určena pro testy opětovného naplnění dat ve zkušebním prostředí.
5. Karta nastavení
- Název instance
- Způsob ověření: uživatelské ID a heslo / API klíč
- Volba jazyka: japonština / angličtina
- Volba motivu: Dark / Light
- Nastavení připojení přes vlastní doménu (
instanceDomain)
Zadané hodnoty se ukládají do settings.json; citlivé hodnoty se uchovávají zašifrované pomocí Windows DPAPI v režimu CurrentUser.
Hlavní body návrhu
Při implementaci jsem kladl důraz na návrh, který snižuje náročnost údržby během provozu.
-
Soustředění komunikace do společné funkce
Invoke-SnowRequestzastřešuje GET/POST/PATCH/DELETE i stahování příloh, aby ověřování, zpracování výjimek a zápis logů nebyly rozptýlené po kódu. -
Oddělení sestavení UI od řízení zobrazení
Funkce řadyBuild-*vytvářejí prvky UI, zatímcoApply-*LanguageaSet-Themepřepínají jejich zobrazení. -
Spolehlivější ukládání nastavení
Load-Settings/Save-SettingsaRequest-SaveSettingsomezují jak neuložené změny, tak zbytečně časté ukládání. -
Vícenásobné potvrzení nebezpečných operací
Operace Truncate zahrnuje potvrzovací kód a zobrazení cíle, aby se snížilo riziko omylu. -
Implementace umožňující zpětné dohledání v logu
Karta Logs aConvertTo-LogCompactJsonusnadňují dodatečné sledování výsledků jednotlivých spuštění.
Vědomý kompromis při implementaci
V podnikovém prostředí bývá obtížné distribuovat instalátory nebo zavádět aplikace, které běží na pozadí. Tentokrát jsem proto upřednostnil PowerShellový skript, který lze distribuovat i jako prostý text a rovnou spustit.
Tento kompromis snížil překážky nasazení a zkrátil dobu, než se nástroj začal skutečně používat.
Přínosy nasazení
Po nasazení se potvrdily následující 4 přínosy.
- Postup na kartě Export je pevně daný rozhraním, takže každý požadavek na extrakci vyžaduje méně vysvětlování.
- Při vytváření Database View ubylo situací, kdy je třeba ručně zapisovat klauzule Where v rozhraní ServiceNow.
- Přílohy lze shromáždit hromadně za zvolené období, což zkracuje opakovanou práci při šetření.
- Ukládání nastavení omezuje opakované zadávání názvu instance a přihlašovacích údajů.
Nejde o okázalé výsledky. Jejich praktická hodnota spočívá v tom, že spolehlivě zkracují úkoly, které provozní pracovníci vykonávají stále dokola.
Omezení a upozornění
- Seznam tabulek se získává z
sys_db_object, takže jej některá nastavení ACL nemusí zpřístupnit. V takovém případě lze název zadat ručně. - V některých prostředích má automatické ukládání klauzulí Where a definic JOIN omezení a je nutné je ručně doplnit v ServiceNow.
- Nástroj není spojen se společností ServiceNow a nemá její schválení, záruku ani podporu.
Shrnutí
PS1 SNOW Utilities jsem vytvořil s cílem omezit praktické zádrhely při získávání dat a definování Database View.
Z osobního pohledu jsem už dříve věděl, že v PowerShellu lze vytvořit GUI, ale nenapadlo mě pustit se do toho sám. S pomocí generativní AI jsem se dostal až k této podobě nástroje téměř jen zadáváním pokynů, skoro jako při práci bez kódu. Tato zkušenost mi dala silně pocítit rychlost vývoje AI. Zároveň si myslím, že tradiční low-code/no-code nástroje budou jen těžko unikat tlaku na zastarávání a nutnosti znovu vymezit své výhody.