Inhalt
User-Scripts sind Lua oder genauer gesagt Luau (https://luau-lang.org) Scripts, welche bei verschiedenen Events (z.B. neue Alarmierung) ausgeführt werden. Der Hauptzweck ist es Kunden-Administratoren die Möglichkeit zu geben Daten via http(s) an Drittsysteme mit beliebigen Anforderungen an Datenformat und Vorbedindungen zu übertragen.
Vorlagen
Vorlagen sind der Grundbaustein eines User-Scripts, sie bestehen aus Meta-Informationen (Titel & Beschreibung), einer Vorgabe der Eventtypen die diese Vorlage unterstützt, dem Script Code selbst und einer Formulardefinition.
Mehr Infos: User-Scripts - Vorlagen im Detail
Events
Events beschreiben ein Ereignis in DIVERA 24/7, welches die Ausführung eines Scripts auslöst. Das klassische Beispiel wäre das Anlegen oder Aktualisieren einer Alarmierung.
Script
Im Script Editor wird der Lua(u)-Code welcher beim Auftreten eines Events ausgeführt wird geschrieben.
Aktuell gibt es leider noch keine Autovervollständigung oder andere Hilfen.
Als Referenz für Standard Libraries sowie Sprachkonstrukte in Luau, empfehlen wir das Lua 5.1 Referenz Handbuch https://www.lua.org/manual/5.1/de/.
Es gibt einige Luau spezifische Änderungen diese finden sich auf der Seite von Luau (Englisch) https://luau-lang.org/compatibility.
Außerdem stellen wir einige Libraries bereit, mehr Infos dazu: User-Scripts - bereitgestellte Script-Bibliotheken
Formular
Formulare erlauben als JSON ein Formular zu definieren, welches in Instanzen angezeigt und ausgefüllt wird. Der Sinn dahinter ist, keine sensiblen Daten wie Accesskeys in Scripts selbst zu hinterlegen, sondern diese beim Erstellen einer Instanz anzugeben.
Der Formulareditor bietet eine Autovervollständigung von Eigenschaften und zeigt Fehler an.
Mehr Infos & ein Beispielformular: User-Scripts - Vorlagen im Detail
Import & Export
Vorlagen können importert und exportiert werden, um es einfacher zu machen geschriebene Integrationen für externe Dienste mit anderen Einheiten zu teilen.
Beim Export werden alle Eigenschaften (Titel, Beschreibung, unterstützte Events, Script & Formular) gespeichert. Nicht exportiert werden angelegte Instanzen oder sonstige Daten des Authors oder der Einheit.
Instanzen
Während die Vorlage das Grundgerüst eines User-Scripts bildet, enthält eine Instanz einer Vorlage nur die Events für die es konfiguriert wurde (beim Anlegen einer Instanz werden standardmäßig die Events der Vorlage übernommen), sowie das in der Vorlage konfigurierte Formular.
Außerdem können Instanzen einzeln aktiviert und deaktiviert werden, um sie bspw. gezielt zu stoppen, ohne sie zu löschen.