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.
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 | |
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 | |
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 |
Übersicht#
Über die Aktionsleiste können Flows erstellt, gelöscht oder exportiert werden. Sofern ein Flow erstellt wurde kann dieser in der Flows Übersicht, über die Aktionen Spalte geöffnet, aktiviert oder deaktiviert werden. Außerdem sind über den "3 Punkte" (More) Button weitere Aktionen möglich wie zum Beispiel: Bearbeiten, Duplizieren oder Zum Test Modus wechseln.
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.
Auslöser Typ#
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. Wird NICHT ausgelöst, wenn Kategoriedaten durch Importe oder API-Interaktion geändert werden.
Die Aktion wird ausgeführt, wenn Kategorien oder Einträge bearbeitet werden. Wird NICHT ausgelöst, wenn Kategoriedaten durch Importe oder API-Interaktion geändert werden.
Konditionstypen#
Es muss keine Konditionen gewählt werden. Außerdem können conditions mit UND sowie ODER verknüpft und verschachtelt werden.
Es können mehrere Logische Konditionen hinzugefügt werden um Bedingungen zu verknüpfen oder zu verschachteln.
Prüft, ob das Objekt die definierten Bedingungen erfüllt. Diese Auswahl bezieht sich auf den Endzustand des Objekts oder Attributs.
Prüft, ob die Ausführungszeit innerhalb der festgelegten Zeiträume liegt.
Prüft, ob die Bewegung durch ausgewählte Personen oder Mitglieder von Personengruppen ausgelöst wird.
Aktionen#
Es muss mindestens eine Aktion definiert werden.
Die Aktion führt einen definierten API-Aufruf aus. Der API-Aufruf 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 in 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 console commands and options#
| Befehl | Beschreibung |
|---|---|
| flows:perform | Perform executions |
| flows:time-trigger | Trigger execution of time automation |
These commands are only available if the Documents add-on is installed
flows:perform#
Perform executions
Optionen:
| Parameter (short version) | Parameter (long version) | Description |
|---|---|---|
| -u | --user=[USERNAME] | Username eines Benutzers, der zur Ausführung berechtigt ist |
| -p | --password=[PASSWORD] | Passwort zur Authentifizierung des zuvor angegebenen Benutzers |
| -i | --tenant=[TENANT-ID] | Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1) |
| -c | --config=[CONFIG] | Angabe des Pfades zur Konfigurationsdatei |
| -h | --help | Hilfenachricht zur Einblendung weiterer Informationen |
| -q | --quiet | Quiet-Mode um die Rückgabe zu deaktivieren |
| -V | --version | Ausgabe der Version der i-doit Console |
| --ansi --no-ansi | ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren) | |
| -n | --no-interaction | Deaktiviert sämtliche Interaktionsfragen der i-doit Console |
| -v / -vv / -vvv | --verbose | Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level) |
Beispiel
1 | |
flows:time-trigger#
Trigger execution of time automation
Optionen:
| Parameter (short version) | Parameter (long version) | Description |
|---|---|---|
| -u | --user=[USERNAME] | Username eines Benutzers, der zur Ausführung berechtigt ist |
| -p | --password=[PASSWORD] | Passwort zur Authentifizierung des zuvor angegebenen Benutzers |
| -i | --tenant=[TENANT-ID] | Mandanten ID des Mandanten, der verwendet werden soll (Standard: 1) |
| -c | --config=[CONFIG] | Angabe des Pfades zur Konfigurationsdatei |
| -h | --help | Hilfenachricht zur Einblendung weiterer Informationen |
| -q | --quiet | Quiet-Mode um die Rückgabe zu deaktivieren |
| -V | --version | Ausgabe der Version der i-doit Console |
| --ansi --no-ansi | ANSI-Ausgabe erzwingen (oder --no-ansi deaktivieren) | |
| -n | --no-interaction | Disables all interaction questions of the i-doit Console |
| -v / -vv / -vvv | --verbose | Erhöht den Umfang der Rückgabe. (1 = Normale Ausgabe, 2 = Detaillierte Ausgabe, 3 = Debug-Level) |
Beispiel
1 | |
Anwendungsfälle#
Anwendungsfälle sind in unserer Demo zu finden und können von dort Exportiert werden.
Releases#
| Version | Datum | Changelog |
|---|---|---|
| 1.0.1 | 24.02.2025 | [Task] Make symfony 6.4 compatible[Task] [Task]Open "last execution" details in new tab [Task]Allow access to object type information in placeholder [Improvement] Export Flows to file [Improvement] Allow usage of detailed information of assets [Improvement] Import Flows from file [Bug] Trigger is not performed when using a category event for a list category [Bug] Attribute condition should not be available for change in action "update object" [Bug] Not selected attribute value is displayed in the overview of a flow [Bug]Creation date and Date of change are not available in object based conditions [Bug] SQL error in object when an object based condition is configured for a location matches a title [Bug] Selected custom attributes set as a trigger do not trigger the flow [Bug] Selection of the object ID as a variable not possible [Bug] Search popup is hard to read |
| 1.0 | 10.10.2024 | Initiales Release |