Blogi

Miten rakensin graafisen PS1-työkalun helpottamaan ServiceNow-ylläpitoa

Tässä artikkelissa käydään läpi GUI-pohjaisen PowerShell-työkalun tausta, toteutus ja vaikutukset ServiceNown vakioituun datavientiin ja Database View -määrittelyihin.

Tietokannan vienti ja yhdistetyt taulukot

Johdanto

ServiceNow-ympäristön ylläpidossa tietokantanäkymien rakentaminen jää helposti tiettyjen henkilöiden varaan, koska se edellyttää relaatiotietokantojen (RDB) perustuntemusta. Datan hyödyntäminen graafisen käyttöliittymän kautta tuo muitakin hankaluuksia: suuri tietomäärä voi ylittää vientirajan ja estää viennin kokonaan, vietävät sarakkeet muuttuvat luettelonäkymän mukaan ja liitteet ovat hajallaan yksittäisissä tietueissa, joten niiden kerääminen on työlästä. Siksi tein PowerShell-työkalun, joka tukee raakadatan vientiä ja Database View -määrittelyjä graafisessa käyttöliittymässä.

Tässä artikkelissa käyn läpi taustan, toteutustavan, suunnitteluratkaisut ja vaikutukset ylläpitotyöhön julkisen tietovaraston toteutuksen pohjalta.


Tausta 1: dataa voi viedä, mutta käytännön työ on raskasta

ServiceNown vakiokäyttöliittymässä on vientitoiminto. Käytännön ylläpidossa seuraavat ongelmat kuitenkin kasautuvat.

  1. Sarakkeet halutaan ulos joka kerta samassa muodossa, mutta luettelonäkymän muutokset vaikuttavat niihin helposti.
  2. Kun tarvitaan vakioitu vienti kaikista sarakkeista sisäisine nimineen, ohjeistamiseen kuluva työ lisääntyy huomattavasti.
  3. Suurilla tietomäärillä graafinen vienti hidastuu, ja suoritusten sekä uusintayritysten hallinta vaikeutuu.

Ylläpito käyttää silloin aikansa datan hyödyntämisen sijaan sen hakemisen tukemiseen. Vaihdoin siksi lähestymistapaa ja rakensin tavan, jolla osastot voivat itse viedä ennalta määritellyt sarakkeet API:n kautta.


Tausta 2: Database View -näkymien luonti paljastaa erot tietokantaosaamisessa

Database View on hyödyllinen, mutta se on korkea kynnys käyttäjälle, joka ei ole tekninen asiantuntija tai jolla on vähän kokemusta relaatiotietokannoista.

  • sys_db_view- ja sys_db_view_table-tietojen käsittely tapahtuu erillään, joten näkymien välillä pitää siirtyä usein.
  • Sarakkeiden sisäisiä nimiä on vaikea tarkistaa yhtenä luettelona samalla ruudulla.
  • Jos ympäristössä ei ole Admin-oikeuksia, sisäiset nimet pitää selvittää toisessa ympäristössä ja tuoda sieltä.
  • Where-ehtojen ja JOIN-määrittelyjen käsin kirjoittaminen altistaa kirjoitusvirheille ja väärille viittauksille.

Näistä syistä päädyin siihen, että tarvitaan graafinen tapa koota määrittelyjä valitsemalla näkyvistä vaihtoehdoista.


Mitä rakensin: PS1 SNOW Utilities

PS1 SNOW Utilities on PowerShell-työkalu, joka kokoaa tavallisia ServiceNown ylläpitotehtäviä yhteen graafiseen käyttöliittymään. Sen tärkeimmät välilehdet ovat seuraavat.

1. Export-välilehti

  • Kohdetaulun valinta tai nimen syöttäminen käsin
  • Suodatus: kaikki tietueet tai aikaväli sys_updated_on-kentän perusteella
  • Vientimuodon valinta: CSV / JSON / Excel
  • Suurten tietuemäärien vienti jaettuna useaan CSV-tiedostoon
  • Kohdekansion määrittäminen ja suorituslokin tarkastelu

Tavoitteena on vakioida poimintatapa ja vähentää työntekijöiden välisiä eroja työvaiheissa.

2. Database View Editor -välilehti

  • Näkymän sisäisen nimen ja näyttönimen syöttäminen
  • Perustaulun ja etuliitteen määrittäminen
  • JOIN-liitoksen lisääminen: vasen ja oikea sarake, Variable Prefix sekä LEFT JOIN -valinta
  • Sarakevaihtoehtojen uudelleenlataus ja näytettävien sarakkeiden valinta
  • Näkymän luonti ja linkki tulokseen

Määrittelyä voi rakentaa näkyvien vaihtoehtojen perusteella. Tämä vähentää ServiceNown näkymien välillä edestakaisin liikkumista sekä Where- ja JOIN-ehtojen kirjoittamista käsin.

3. Attachment Harvester -välilehti

  • Liittyvien liitteiden kerääminen kerralla päivitysaikavälin perusteella
  • Samannimisten tiedostojen erottaminen järjestysnumeroilla
  • Hakutoimintojen kirjaaminen lokiin

Toiminto helpottaa auditoinneissa ja selvityksissä usein tarvittavaa liitteiden keräämistä toistettavalla tavalla.

4. Truncate-välilehti

  • Kohdetaulun kaikkien tietueiden poistaminen kehityskäyttöä varten
  • Vahvistuskoodin syöttäminen, kohteen tietojen näyttäminen ja uudelleenyritysten asetukset

Kyse on vaarallisesta toiminnosta, eikä sitä suositella tuotantokäyttöön. Se on tarkoitettu tietojen uudelleenlatauksen kokeilemiseen testiympäristössä.

5. Asetusvälilehti

  • Instanssin nimi
  • Todennustapa: käyttäjätunnus ja salasana / API-avain
  • Kieli: japani / englanti
  • Teema: Dark / Light
  • Oman verkkotunnuksen yhteysasetus (instanceDomain)

Syötetyt arvot tallennetaan settings.json-tiedostoon. Salaiset arvot säilytetään salattuina Windows DPAPI:n CurrentUser-tilassa.

Suunnittelun keskeiset ratkaisut

Pidin toteutuksessa tärkeänä sellaista rakennetta, joka vähentää ylläpitotyötä käytön aikana.

  1. Verkkoliikenteen kokoaminen yhteiseen funktioon
    Invoke-SnowRequest kokoaa GET/POST/PATCH/DELETE-kutsut ja liitteiden haun yhteen, jotta todennus, poikkeusten käsittely ja lokitus eivät hajaannu eri puolille koodia.

  2. Käyttöliittymän rakentamisen erottaminen esityksen ohjauksesta
    Build-*-funktiot rakentavat käyttöliittymän osat. Apply-*Language ja Set-Theme vaihtavat niiden esitystapaa.

  3. Asetusten tallennuksen vakauttaminen
    Load-Settings / Save-Settings ja Request-SaveSettings vähentävät sekä tallentamatta jääviä muutoksia että tarpeettoman tiheää tallentamista.

  4. Vaarallisten toimintojen monivaiheinen vahvistus
    Truncate-toiminto näyttää kohteen ja pyytää vahvistuskoodin, jotta väärän toiminnon riski pienenee.

  5. Lokien avulla jäljitettävä toteutus
    Logs-välilehti ja ConvertTo-LogCompactJson helpottavat suoritustulosten tarkastelua jälkikäteen.


Toteutuksen tietoinen kompromissi

Yritysympäristössä asennuspakettien jakaminen tai taustalla toimivien sovellusten käyttöönotto voi olla hankalaa. Tässä tapauksessa asetin siksi etusijalle PowerShell-skriptin, jonka voi jakaa myös tekstinä ja suorittaa sellaisenaan.

Ratkaisu madalsi käyttöönoton kynnystä ja lyhensi aikaa siihen, että työkalua päästiin käyttämään oikeassa työssä.


Käyttöönoton vaikutukset

Käyttöönoton jälkeen todettiin seuraavat 4 vaikutusta.

  1. Export-työvaiheet vakioituivat käyttöliittymässä, joten jokainen poimintapyyntö vaati vähemmän ohjeistusta.
  2. Database View -näkymien luonnissa tarvittiin aiempaa harvemmin Where-ehtojen käsin kirjoittamista ServiceNown käyttöliittymässä.
  3. Liitteet voitiin kerätä kerralla halutulta aikaväliltä, mikä vähensi selvityksiin liittyvää toistotyötä.
  4. Asetusten tallentaminen vähensi instanssin nimen ja todennustietojen syöttämistä uudelleen.

Vaikutukset eivät ole näyttäviä, mutta niiden käytännön arvo on selvä: ylläpitäjien jatkuvasti toistamiin tehtäviin kuluu vähemmän aikaa.


Rajoitukset ja huomioitavaa

  • Taululuettelo haetaan sys_db_object-tiedoista, joten ACL-oikeudet voivat estää sen hakemisen. Tällöin taulun nimen voi syöttää käsin.
  • Joissakin ympäristöissä Where-ehtojen ja JOIN-määrittelyjen automaattista tallentamista on rajoitettu, ja niitä pitää täydentää käsin ServiceNowssa.
  • Työkalu ei liity ServiceNow-yhtiöön, eikä sillä ole yhtiön hyväksyntää, takuuta tai tukea.

Yhteenveto

Tein PS1 SNOW Utilities -työkalun vähentämään datan poiminnan ja Database View -määrittelyjen käytännön hankaluuksia.

Henkilökohtaisesti olin jo aiemmin tiennyt, että PowerShellilla voi rakentaa graafisen käyttöliittymän, mutta ajatus siihen itse ryhtymisestä ei ollut tullut mieleeni. Generatiivisen tekoälyn avustamana sain työkalun tähän asti lähes pelkillä ohjeilla, hyvin lähellä no-code-työskentelyä. Kokemus teki tekoälyn kehitysnopeuden minulle erityisen konkreettiseksi. Samalla ajattelen, että perinteisten low-code/no-code-työkalujen on vaikea välttää tilannetta, jossa niiden edut on määriteltävä uudelleen ja niihin kohdistuu vanhenemispainetta.