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 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.
Systemdienst-Installationsskript verwenden#
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 Tenant durchgeführt werden
-ubraucht einen i-doit admin-user-pbenötigt ein i-doit admin-user-passwort-ibenötigt eine Mandanten-ID, kann über Konsolenbefehl eingesehen werden tenant-list
1 | |
Erstellen eines Crontab#
Die Crontab führt die CLI-Befehle jede Minute aus. Erstellen Sie eine Crontab für den Apache-Benutzer. Beispiel für Debian:
1 | |
Fügen Sie die folgenden Zeilen am Ende der Datei ein, nachdem Sie die i-doit Anmeldeinformationen ersetzt haben. Möglicherweise müssen Sie auch die Mandanten-ID ersetzen.
1 2 | |
CLI console commands and options#
| Command | Interne Beschreibung |
|---|---|
| flows:perform | Perform executions |
| flows:time-trigger | Trigger execution of time automations |
These commands are only available if the Documents add-on is installed
flows:perform#
Perform executions
Options:
| Parameter (short version) | Parameter (long version) | Description |
|---|---|---|
| -u | --user=USERNAME | Username of a user who is authorized to execute |
| -p | --password=PASSWORD | Password for authentication of the previously specified user |
| -i | --tenant=TENANTID | Tenant ID of the tenant to be used (default: 1) |
| -c | --config=CONFIG | Config File |
| -h | --help | Help message for displaying further information |
| -q | --quiet | Quiet-Mode to deactivate output |
| -V | --version | Output of the i-doit Console version |
| --ansi --no-ansi | Force (or disable --no-ansi) ANSI output | |
| -n | --no-interaction | Disables all interaction questions of the i-doit Console |
| -v / -vv / -vvv | --verbose | Increase the command output (1 = normal output, 2 = detailed output, 3 = debug level) |
Example of use
1 | |
flows:time-trigger#
Trigger execution of time automations
Options:
| Parameter (short version) | Parameter (long version) | Description |
|---|---|---|
| -u | --user=USERNAME | Username of a user who is authorized to execute |
| -p | --password=PASSWORD | Password for authentication of the previously specified user |
| -i | --tenant=TENANTID | Tenant ID of the tenant to be used (default: 1) |
| -c | --config=CONFIG | Config File |
| -h | --help | Help message for displaying further information |
| -q | --quiet | Quiet-Mode to deactivate output |
| -V | --version | Output of the i-doit Console version |
| --ansi --no-ansi | Force (or disable --no-ansi) ANSI output | |
| -n | --no-interaction | Disables all interaction questions of the i-doit Console |
| -v / -vv / -vvv | --verbose | Increase the command output (1 = normal output, 2 = detailed output, 3 = debug level) |
Example of use
1 | |
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.
Anwendungsfälle#
Folgen.
Releases#
| Version | Datum | Changelog |
|---|---|---|
| 1.0 | 10.10.2024 | Initiales Release |