Flows Add-on
Das Flows Add-on für i-doit ist ein leistungsstarkes Werkzeug zur Automatisierung von Prozessen innerhalb des CMDB-Systems. Es ermöglicht die Erstellung von automatisierten Flows basierend auf Triggern und definierten Bedingungen. Mit Flows können Benutzer repetitive Aufgaben und manuelle Schritte automatisieren, indem sie Regeln festlegen, die durch bestimmte Ereignisse oder Zustände (z. B. eine Änderung in der CMDB) ausgelöst werden. Das Add-on hilft, Arbeitsabläufe effizienter zu gestalten, Fehler zu reduzieren und die Verwaltung komplexer IT-Umgebungen zu vereinfachen, indem es Routineprozesse ohne Benutzerinteraktion abwickelt.
Add-on ist aktuell nur in englischer Sprache verfügbar
Download und Installation#
Dieses Add-on kann nachträglich installiert werden. Detaillierte Beschreibungen bezüglich Download, Installation, Updates usw. liefert der Artikel i-doit Add-ons.
Benötigte CLI Commands#
Sofern der Befehl für einen anderen als den ersten Mandanten ausgeführt werden soll, ist die entsprechende Mandanten ID zu übergeben.
Das Flows Add-on wird mit zwei CLI-Befehlen geliefert. Beide Befehle werden benötigt, damit das Flows-Add-on vollständig funktioniert. Es gibt zwei Möglichkeiten, die CLI-Befehle einzurichten. Die Befehle können z.B. über einen Crontab ausgeführt werden. Wir haben auch ein Service-Installationsskript mit dem Namen create-daemon.sh erstellt, das sich im Flows Add-on Ordner unter i-doit/src/classes/modules/synetics_flows/ befindet.
Automatisierung der CLI Commands#
Systemdienst erstellen via Skript#
Mit dem Linux Skript lässt sich ein Dienst erstellen, dieser Dienst führt alle paar Sekunden die CLI-Befehle des Flows Add-on aus. Zuerst müssen wir die Ausführungsrechte für die Datei festlegen. Verwenden Sie den Befehl im Ordner i-doit:
1 | |
Nun kann die Datei ausgeführt werden, um einen Systemdienst zu erstellen. Dies muss für jeden Mandanten durchgeführt werden
-ui-doit Person mit Administrator rechten-pdas Passwort für die Person-iMandanten ID in dem die Person verwendet wird, kann über Konsolenbefehl eingesehen werden tenant-list
1 | |
Aufgabenplanung & Cron Jobs#
Wird Windows verwendet kann die Aufgabenplanung genutzt werden. Siehe Aufgabenplanung & Cron Jobs.
Rechtevergabe#
Unter Verwaltung → Berechtigungen → Flows können Rechte für Personen und Personengruppen angepasst werden.
| Recht | Beschreibung |
|---|---|
| Erstellen | Erlaubt das erstellen, duplizieren und impliziert das Ansehen Recht |
| Ansehen | Erlaubt Zugriff auf die Flows Overview |
| Editieren | Erlaubt editieren, aktivieren/deaktivieren und impliziert das Ansehen Recht |
| Löschen | Erlaubt das löschen von Flows und impliziert das Ansehen Recht |
| Supervisor | Erlaubt alles |
Overview#
Über die Aktionsleiste können Flows erstellt oder gelöscht werden. Sofern ein Flow erstellt wurde kann dieser auch über die Actions Spalte geöffnet, aktiviert oder deaktiviert werden. Außerdem sind über den "3 Punkte" (More) Button weitere Aktionen möglich wie zum Beispiel, editieren, duplizieren,
Flow erstellen#
Um einen Flow zu erstellen wird das Flows Add-on aufgerufen, dies erfolgt über Add-ons → Flows. Anschließend wird über den Add Button ein neuer Flow erstellt. Ein Flow muss einen Namen, einen Trigger und eine oder mehrere Actions definiert haben um vollständig zu sein. Zu guter Letzt muss der Flow über den Button noch aktiviert werden.
Trigger types#
Trigger bestimmen wann ein FLow ausgeführt wird. Es ist nur ein Trigger pro Flow möglich.
Die Aktion wird ausgeführt, sobald Datum und Uhrzeit erreicht sind. Sie kann regelmäßig wiederholt werden.
Die Aktion wird ausgeführt, sobald der Button angeklickt wird. Der Button wird in der Aktionsleiste des Objektes angezeigt, wenn die Bedingungen erfüllt sind.
Die Aktion wird ausgeführt, wenn ein bestimmter CMDB-Status gesetzt wird. Es lässt sich auch nach bestimmten Objekttypen filtern.
Die Aktion wird ausgeführt, wenn Kategorien oder Einträge bearbeitet werden. Es lässt sich auch einstellen, dass sie erst dann ausgeführt wird, wenn bestimmte Kategorien oder Attribute bearbeitet werden.
Conditions types#
Es muss keine Condition gewählt werden. Außerdem können conditions mit AND sowie OR verknüpft und verschachtelt werden.
Es können mehrere Logical conditions hinzugefügt werden um Bedingungen zu verknüpfen oder zu verschachteln.
Die Aktion wird nur für Objekte ausgelöst, die die konfigurierte Bedingung erfüllen.
Die Aktion wird nur zu einer bestimmten Zeit ausgelöst.
Die Aktion wird nur ausgelöst wenn diese durch bestimmte User oder User groups ausgelöst wird.
Action types#
Es muss mindestens eine Action definiert werden.
Die Aktion führt einen definierten API Call aus. Der API Call benötigt eine URL, eine Methode sowie angaben zur Autorisierung. Für diesen Action type kann Twig als template Engine verwendet werden.
Die Aktion sendet eine E-Mail an bestimmte Empfänger. Ein Subject ist notwendig. Für diesen Action type kann Twig als template Engine verwendet werden.
Die Aktion erstellt ein neues Objekt. Es ist möglich Attribute für Kategorien zu hinterlegen.
Die Aktion aktualisiert Attribute bei Objekten.
Logs#
Die Logs sind für alle Flows ersichtlich oder für den jeweils geöffneten Flow. In den Logs werden wichtige Informationen zu den Ausführungen gespeichert.
CLI-Befehle und Optionen#
| Befehl | Interne Beschreibung |
|---|---|
| flows:perform | Führt Ausführungen durch |
| flows:time-trigger | Löst die Ausführung der Zeitautomatisierung aus |
flows:perform#
Führt Ausführungen durch.
Optionen:
| Parameter (Kurzversion) | Parameter (Langversion) | Beschreibung |
|---|---|---|
| -u | --user=BENUTZERNAME | Benutzername eines autorisierten Benutzers zur Ausführung |
| -p | --password=PASSWORT | Passwort zur Authentifizierung des angegebenen Benutzers |
| -i | --tenant=MANDANTID | Mandanten-ID des zu verwendenden Mandanten (Standard: 1) |
| -c | --config=KONFIGURATION | Konfigurationsdatei |
| -h | --help | Hilfetext zur Anzeige weiterer Informationen |
| -q | --quiet | Quiet-Modus zur Deaktivierung der Ausgabe |
| -V | --version | Gibt die Version der i-doit Konsole aus |
| --ansi --no-ansi | Erzwingt (oder deaktiviert mit --no-ansi) ANSI-Ausgabe | |
| -n | --no-interaction | Deaktiviert alle Interaktionsfragen der i-doit Konsole |
| -v / -vv / -vvv | --verbose | Erhöht die Ausführlichkeit der Ausgabe (1 = normale Ausgabe, 2 = detaillierte Ausgabe, 3 = Debug-Level) |
Anwendungsbeispiel
1 | |
flows:time-trigger#
Löst die Ausführung der Zeitautomatisierung aus.
Optionen:
| Parameter (Kurzversion) | Parameter (Langversion) | Beschreibung |
|---|---|---|
| -u | --user=BENUTZERNAME | Benutzername eines autorisierten Benutzers zur Ausführung |
| -p | --password=PASSWORT | Passwort zur Authentifizierung des angegebenen Benutzers |
| -i | --tenant=MANDANTID | Mandanten-ID des zu verwendenden Mandanten (Standard: 1) |
| -c | --config=KONFIGURATION | Konfigurationsdatei |
| -h | --help | Hilfetext zur Anzeige weiterer Informationen |
| -q | --quiet | Quiet-Modus zur Deaktivierung der Ausgabe |
| -V | --version | Gibt die Version der i-doit Konsole aus |
| --ansi --no-ansi | Erzwingt (oder deaktiviert mit --no-ansi) ANSI-Ausgabe | |
| -n | --no-interaction | Deaktiviert alle Interaktionsfragen der i-doit Konsole |
| -v / -vv / -vvv | --verbose | Erhöht die Ausführlichkeit der Ausgabe (1 = normale Ausgabe, 2 = detaillierte Ausgabe, 3 = Debug-Level) |
Anwendungsbeispiel
1 | |
Anwendungsfälle#
Wir haben Anwendungsfälle in der Demo zur Verfügung gestellt.
Releases#
| Version | Datum | Changelog |
|---|---|---|
| 1.0 | 10.10.2024 | Initiales Release |