Flows Add-on (Introduction)

With the Flows Add-on you automate processes in i-doit. You define rules that are triggered by certain events or states -- such as a change in the CMDB. This way you automate repetitive tasks, reduce errors, and simplify the administration of complex IT environments.

Download and installation#

This add-on can be installed additionally. Details on download, installation, and updates can be found in the article i-doit Add-ons.

Required CLI Commands#

The Flows Add-on requires two CLI commands to function fully. You have two options for setting them up:

• Crontab -- Run the commands regularly via Cron.
• System service -- Use the included script create-daemon.sh located under i-doit/src/classes/modules/synetics_flows/.

Automating the CLI Commands#

Creating a system service via script#

The script creates a system service that executes the CLI commands every few seconds. First set the execution rights:

1

sudo chmod +x src/classes/modules/synetics_flows/create-daemon.sh

Then run the script for each tenant individually:

• -u i-doit person with administrator rights
• -p the password for the person
• -i tenant ID in which the person is used (viewable via the console command tenant-list)

1

src/classes/modules/synetics_flows/./create-daemon.sh -u admin-user -p admin-user-password -i 1

Creating a crontab#

Alternatively, set up a crontab that executes the CLI commands every minute. Example for Debian:

1

sudo crontab -u www-data -e

Add the following lines at the end of the file and replace the login credentials as well as the tenant ID if applicable:

1
2

* * * * * /usr/bin/php /var/www/html/console.php flows:perform ---user admin-user --password admin-user-password --tenantId 1
* * * * * /usr/bin/php /var/www/html/console.php flows:time-trigger --user admin-user --password admin-user-password --tenantId 1

Assigning rights#

Under Administration → Permissions → Flows can permissions for persons and person groups be adjusted.

Overview#

Via the action bar you create, delete, or export Flows. In the overview you open, enable, or disable Flows via the Actions column. The More button (three dots) offers additional options: Edit, Duplicate, and Switch to test mode.

Creating a Flow#

To create a Flow:

1. Open Add-ons → Flows.
2. Click Add to create a new Flow.
3. Define a name, a trigger, and at least one action.
4. Activate the Flow via the corresponding button.

Trigger types#

Triggers determine when a Flow is executed. Only one trigger per Flow is possible.

Condition types#

Conditions are optional. You can link and nest them with AND as well as OR.

Actions#

At least one action must be defined.

Logs#

The logs show execution information -- either for all Flows or for the currently opened Flow.

i-doit console utility commands and options#

flows:perform#

Perform executions

Options:

Example

1

sudo -u www-data php console.php flows:perform --user admin-user --password admin-user-password --tenantId 1

flows:time-trigger#

Trigger execution of time automation

Options:

Example

1

sudo -u www-data php console.php flows:time-trigger --user admin-user --password admin-user-password --tenantId 1

Use Cases#

Ready-made use cases can be found in our Demo -- you can export them from there.

Releases#