Blog

Wie ich ein PS1-Tool mit GUI für einen einfacheren ServiceNow-Betrieb entwickelt habe

Der Beitrag beschreibt Hintergrund, Umsetzung und Wirkung eines PowerShell-Tools mit GUI für standardisierte Datenexports und Database-View-Definitionen in ServiceNow.

Datenbankexporte und verknüpfte Tabellen

Einleitung

Wer ServiceNow länger betreibt und wartet, merkt schnell: Das Erstellen von Datenbank-Views hängt von RDB-Grundkenntnissen ab, und das nötige Wissen konzentriert sich leicht auf einzelne Personen. Auch die Datennutzung über die GUI hat ihre Tücken. Große Datenmengen können die Exportgrenze überschreiten und den Export ganz verhindern. Welche Spalten ausgegeben werden, hängt vom Zustand der Listenansicht ab. Anhänge liegen zudem verstreut an einzelnen Datensätzen und lassen sich nur mühsam einsammeln. Deshalb habe ich ein PowerShell-Tool entwickelt, das den Export von Rohdaten und die Definition von Database Views über eine GUI unterstützt.

Dieser Artikel beschreibt den Hintergrund, den Umsetzungsansatz, den Entwurf und die Auswirkungen im Betrieb anhand der Implementierung im öffentlichen Repository.


Hintergrund 1: Datenexport ist möglich, der Betriebsaufwand bleibt hoch

Die Standardoberfläche von ServiceNow kann Daten exportieren. Im tatsächlichen Betrieb häufen sich jedoch folgende Probleme.

  1. Man möchte jedes Mal dieselbe Spaltenstruktur ausgeben, doch Änderungen an der Listenansicht wirken sich leicht darauf aus.
  2. Sobald ein regelmäßiger Export aller Spalten einschließlich ihrer internen Namen gefragt ist, steigt der Erklärungsaufwand für das Vorgehen stark an.
  3. Bei großen Datenmengen wird schon der GUI-Export selbst schwerfällig; Ausführungen und Wiederholungen lassen sich nur mühsam verwalten.

Die betreuenden Personen verbringen ihre Zeit dann damit, beim Beschaffen der Daten zu helfen, statt deren Nutzung zu unterstützen. Deshalb habe ich den Ansatz geändert und eine Möglichkeit geschaffen, mit der jede Abteilung festgelegte Spalten selbstständig über die API exportieren kann.


Hintergrund 2: Beim Erstellen von Database Views werden Unterschiede im RDB-Wissen sichtbar

Database Views sind nützlich. Für nichttechnische Anwender oder Personen mit wenig Erfahrung mit relationalen Datenbanken ist die Einstiegshürde jedoch hoch.

  • Die Bearbeitung von sys_db_view und sys_db_view_table erfolgt getrennt und erfordert viele Bildschirmwechsel.
  • Interne Spaltennamen lassen sich nur schwer auf derselben Oberfläche gesammelt prüfen.
  • Ohne Admin-Berechtigungen muss man interne Namen in einer anderen Umgebung recherchieren und von dort übernehmen.
  • Beim manuellen Schreiben von Where-Klauseln und JOIN-Definitionen entstehen leicht Tippfehler oder falsche Referenzen.

Deshalb hielt ich eine GUI-Unterstützung für nötig, mit der sich Definitionen anhand der sichtbaren Auswahlmöglichkeiten zusammensetzen lassen.


Das Ergebnis: PS1 SNOW Utilities

PS1 SNOW Utilities ist ein PowerShell-Werkzeug, das häufige Aufgaben im ServiceNow-Betrieb in einer einzigen GUI bündelt. Die wichtigsten Registerkarten sind folgendermaßen aufgebaut.

1. Registerkarte Export

  • Zieltabelle auswählen oder manuell eingeben
  • Filter festlegen: alle Datensätze oder ein Zeitraum nach sys_updated_on
  • Ausgabeformat wählen: CSV / JSON / Excel
  • Große Datenmengen auf mehrere CSV-Dateien verteilt exportieren
  • Zielordner festlegen und Ausführungsprotokoll prüfen

Das Ziel im Betrieb ist, die Datenextraktion zu vereinheitlichen und Unterschiede zwischen den Vorgehensweisen einzelner Personen zu verringern.

2. Registerkarte Database View Editor

  • Internen Namen und Bezeichnung der View eingeben
  • Basistabelle und Präfix festlegen
  • JOIN hinzufügen: linke und rechte Spalte, Variable Prefix sowie die Option LEFT JOIN
  • Verfügbare Spalten erneut laden und die anzuzeigenden Spalten auswählen
  • View erstellen und einen Link zum Ergebnis anzeigen

Die Definition lässt sich mit Blick auf die verfügbaren Auswahlmöglichkeiten aufbauen. Das reduziert das Hin- und Herwechseln zwischen ServiceNow-Oberflächen sowie das manuelle Eingeben von Where-Klauseln und JOIN-Bedingungen.

3. Registerkarte Attachment Harvester

  • Zugehörige Anhänge anhand eines Aktualisierungszeitraums gesammelt herunterladen
  • Kollisionen gleicher Dateinamen durch fortlaufende Nummern vermeiden
  • Den Abruf im Protokoll festhalten

Damit lässt sich das bei Audits und Untersuchungen häufig nötige Einsammeln von Anhängen leichter als wiederholbarer Ablauf ausführen.

4. Registerkarte Truncate

  • Alle Datensätze einer Tabelle für Entwicklungszwecke löschen
  • Bestätigungscode eingeben, Zielinformationen anzeigen und Wiederholungsversuche konfigurieren

Das ist eine gefährliche Operation, deren Einsatz in der Produktion nicht empfohlen wird. Die Funktion ist für Tests zum erneuten Einspielen von Daten in einer Testumgebung gedacht.

5. Registerkarte Einstellungen

  • Instanzname
  • Authentifizierung: Benutzer-ID und Passwort / API-Schlüssel
  • Sprache: Japanisch / Englisch
  • Darstellungsmodus: Dark / Light
  • Verbindung über eine eigene Domain (instanceDomain)

Die Eingaben werden in settings.json gespeichert. Vertrauliche Werte werden mit Windows DPAPI im Modus CurrentUser verschlüsselt aufbewahrt.

Wesentliche Entwurfsentscheidungen

Bei dieser Implementierung war mir ein Aufbau wichtig, der den Wartungsaufwand im laufenden Betrieb reduziert.

  1. Kommunikation in einer gemeinsamen Funktion bündeln
    Invoke-SnowRequest kapselt GET/POST/PATCH/DELETE und den Abruf von Anhängen, damit Authentifizierung, Ausnahmebehandlung und Protokollierung nicht im gesamten Code verteilt sind.

  2. Aufbau und Darstellung der Oberfläche trennen
    Die Build-*-Funktionen erstellen die UI-Elemente. Apply-*Language und Set-Theme übernehmen das Umschalten ihrer Darstellung.

  3. Das Speichern der Einstellungen stabilisieren
    Load-Settings / Save-Settings und Request-SaveSettings sollen sowohl vergessene Speichervorgänge als auch unnötig häufiges Speichern vermeiden.

  4. Gefährliche Operationen mehrfach bestätigen lassen
    Vor der Truncate-Ausführung werden ein Bestätigungscode abgefragt und das Ziel angezeigt, um das Risiko einer Fehlbedienung zu verringern.

  5. Nachvollziehbarkeit über Protokolle vorsehen
    Die Registerkarte Logs und ConvertTo-LogCompactJson erleichtern es, Ausführungsergebnisse später nachzuvollziehen.


Ein bewusster Kompromiss bei der Umsetzung

In Unternehmensumgebungen sind die Verteilung von Installationsprogrammen und die Einführung dauerhaft laufender Anwendungen oft mit hohen Hürden verbunden. Deshalb habe ich diesmal ein PowerShell-Skript bevorzugt, das auch als Text verteilt und anschließend ausgeführt werden kann.

Mit diesem Kompromiss konnte ich die Einführungshürden senken und die Zeit bis zur tatsächlichen Nutzung verkürzen.


Auswirkungen nach der Einführung

Nach der Einführung ließen sich die folgenden 4 Verbesserungen feststellen.

  1. Die Export-Schritte sind in der Oberfläche fest vorgegeben. Dadurch braucht jede neue Extraktionsanfrage weniger Erklärung.
  2. Beim Erstellen von Database Views müssen Where-Klauseln seltener von Hand in der ServiceNow-Oberfläche eingetragen werden.
  3. Anhänge lassen sich gesammelt für einen bestimmten Zeitraum abrufen, was wiederkehrende Arbeit bei Untersuchungen verkürzt.
  4. Gespeicherte Einstellungen verringern die Zahl der erneuten Eingaben von Instanznamen und Zugangsdaten.

Die Ergebnisse sind nicht spektakulär. Ihr praktischer Wert liegt darin, dass sie die Zeit für Aufgaben zuverlässig verkürzen, die im Betrieb immer wieder anfallen.


Einschränkungen und Hinweise

  • Die Tabellenliste wird aus sys_db_object gelesen. Je nach ACL kann der Zugriff scheitern; dann lässt sich der Tabellenname manuell eingeben.
  • In manchen Umgebungen ist das automatische Speichern von Where-Klauseln und JOIN-Definitionen eingeschränkt. Gegebenenfalls müssen sie in ServiceNow manuell ergänzt werden.
  • Das Werkzeug steht in keiner Verbindung zum Unternehmen ServiceNow und erhält von ihm weder Freigabe noch Garantie oder Support.

Fazit

Ich habe PS1 SNOW Utilities entwickelt, um praktische Hindernisse bei der Datenextraktion und der Definition von Database Views zu verringern.

Meine persönliche Erfahrung dabei: Ich wusste schon länger, dass sich mit PowerShell eine GUI bauen lässt, war aber nicht auf die Idee gekommen, es selbst anzugehen. Mit Unterstützung generativer KI konnte ich das Werkzeug fast nur durch Anweisungen, beinahe wie bei No-Code, bis zu diesem Stand bringen. Das hat mir die Geschwindigkeit der KI-Entwicklung sehr deutlich vor Augen geführt. Gleichzeitig denke ich, dass klassische Low-Code-/No-Code-Werkzeuge kaum darum herumkommen werden, ihre Vorteile neu zu definieren und sich dem Druck zunehmender Überalterung zu stellen.