Reference

This section provides a detailed explanation of the available options for setting up a flow inside IO.

General Configuration

This page aims to provide a comprehensive overview of the general configuration options available for customising flows according to your specific needs.

• Name: The Name field is a label for the flow. It helps users identify and recognise the flow easily.

• Description: The Description field provides a brief summary of the flow's purpose or functionality. It helps users understand the flow at a glance and makes it easier to manage and organise multiple flows.

• Choose how to initialise the flow: This setting determines how the flow will be created or populated when starting a new one. The available options are:

• Creates an empty flow – Starts with a blank flow, allowing you to build all nodes and steps from scratch.

• Import content from file – Loads flow data from an external file, useful for reusing predefined configurations or templates.

• Copy content from an existing flow – Duplicates the structure and content of an existing flow, allowing you to modify it without starting from scratch. It is possible to keep the same ID of the imported flow, particularly relevant when copying flows from different environments.

• Flow Categories: Are used to logically group flows and improve organisation and navigation. You can create your own category if needed.

• Flow Type: Defines the actual purpose or behaviour of the flow within the selected category. You can create your own type if needed, but there are also default types based on the following categories:

• Authentication Category:

  • Login: Handles the process of user authentication when logging in.
  • Logout: Manages the termination of a user session and logout procedure.

• Self Service Category:

  • Registration: Handles the user completing the domain registration.
  • Update Password: Manages the creation of a new user account.
  • Reset Password: Manages password recovery for users who have forgotten their password.

• Admin Category:

  • Invite User: Handles the process of sending invitations to new users to join the system.
  • Delete User: Manages the removal of a user account from the system.
  • Lock User: Handles locking a user account, preventing login temporarily.
  • Unlock User: Manages unlocking a previously locked user account, restoring access.

Besides the default configuration, it is possible to create custom flow categories and user-defined flow types.

Edit Settings

• Active: Indicates whether a flow is enabled and operational. When a flow is marked as active, it can be executed, triggered, or used by the system. If it is inactive, the flow is temporarily disabled and will not run, but it remains saved in the system for later use or editing.

• Tags: Allows you to assign tags to the flow. You can freely type custom tags and press Enter to create them, or you can select from a dropdown list of predefined ones. Tags help you filter, organise and quickly find your flows more easily.

• Enable nodes Tracking: Track and record into the database the execution of nodes within the flow. This provides detailed visibility into the flow's behaviour, allowing for auditing, debugging, and monitoring of every step in the process. Options available:

• Always: Each step executed within the node-based flow will be logged, providing full traceability of the flow's execution for auditing, debugging, and monitoring purposes.

• If there is at least one error: Every step of the flow will be logged only if at least one error occurs during execution. This allows you to capture detailed diagnostic information when something goes wrong, without producing unnecessary logs for successful runs.

• In case of flow failure: The system will log the executed steps only when it goes into a flow failure. This provides a concise record of what happened leading up to the failure, helping with troubleshooting while keeping logging minimal during normal operation.

• Set as default: This flag option allows you to designate a specific flow as the primary or default version. This means that whenever the system requires a flow without a specific selection, it will automatically use the one marked as default.

VIO Settings

VIO interface provides a structured environment for designing, configuring, and managing flows. It includes tools for adding nodes, handling variables, and accessing essential settings.

• Node Button: Opens a menu where you can drag and drop nodes into the flow and quickly search for specific components. Nodes are organised into categories for easier navigation.

• Variable Button: Displays all variables generated or used within the flow, allowing you to review, copy, and reuse them as needed.

• Settings Button: Gives access to key flow operations, including copying the flow URL, downloading or uploading flow files, managing languages, using the mini-map, saving the flow, checking version history, and editing general configurations.

• Additional Functions: Right-clicking on the VIO designer grid allows you to add comments or copy/delete nodes. Comments can also be used to group nodes and highlight specific parts of the flow for improved readability.

Manage Flow

• Run a Flow: Flows can be executed using the Copy Flow URL function, available both in VIO designer and from the Flow list. The copied URL can be pasted into a browser to trigger the flow. When a flow does not include a front-end component and does not require user interaction, it can be executed by calling the /flow/execute endpoint.

Note: Library flows cannot be executed standalone and must be invoked by other flows.

• Flow Import / Export: The Import / Export Flow feature allows VIO flows to be reused, backed up, and migrated across environments. Flows can be imported from a JSON file when creating a new flow using the Import content from file option. Flows can be exported either from the flow list or from within a flow via the Settings menu.

• Delete Flow: Flows can be permanently deleted from the Flow list in VIO using the delete action available in the Actions column of the Flow list.

• Copy Flow ID: Allows copying only the flow ID (without the full URL) from the Flow list.

Note: Active flows must be disabled before they can be deleted.

Flow Versioning

The Flow Version feature allows you to create, manage, test, and restore multiple versions of a flow directly within VIO designer. Flow versions enable safe experimentation, version control, and rollback while preserving the stability of the primary flow.

You can create a new flow version, visible only within the parent flow, by:

• Creates an empty flow: Starting from an empty flow.
• Import content from file: Import a flow definition from a file (optionally preserving the original flow ID).
• Create version with current content: Clone the current flow content.

Language

It is possible to use language localisation using a JSON file structured by 2-digit language codes (e.g., en, it) with key-value pairs. You can upload, download and delete the language in the flow. It is also possible to select a fallback language that is used whenever the user's country language is not present in the JSON.