Checking the Validity of a Flow with the Flow Review Tool

Not available in Factory Lite and Factory Personal licenses.

The Flow Review Tool is used to check the validity of your flow. Rules and best practices are defined in an excel file, which can be configured as required.

This tool is essential to ensure that your flows satisfy compliance constraints to avoid generating errors in production, and is particularly useful when new rules are identified, as the updated excel file can be used to check multiple processes and spot where the new rule is not respected quickly and easily.

Best practices can also be identified to improve the quality of your flows and avoid warnings.

You can open the Flow Review Tool in two ways:

  • By right clicking on the flow in the Explorer;

  • By clicking on the Flow Review Tool button on the toolbar.


Prerequisites


Procedure

  1. Right-click the flow you want to check in the Explorer or click on the Flow Review Tool button on the toolbar. Multiple flows can be selected at the same time keeping the CTRL button pressed as you make selections. If you are selecting a list of flows, you can select the first one by clicking on it, and the last on of the list keeping the SHIFT button pressed as you make the selection.

  2. Select Flow Review Tool.

  3. Configure the remaining options as described in the table below.

  4. Click Apply. The validity check will be executed immediately and a results file will be saved in the chosen directory. 

Parameter Name

Description

Input file

Select how you want to import the excel configuration file. 

Before choosing the location of the file, define the source type, which can be Saved or Custom.

The file can be located either:

  • on your local file system, or

  • remotely via HTTP API, SharePoint, HDFS, AWS S3 or FTP. If you decide to import the file via remote connection, you must configure the connection in the Remote Connections tab.

Files (input directory)

Drag and drop the Excel file you want to import or click Select to browse on your computer. 

Output file

Select how you want to export the results file. 

Before choosing the location of the file, define the source type, which can be Saved or Custom.

The file can be located either:

  • on your local file system, or

  • remotely via HTTP API, SharePoint, HDFS, AWS S3 or FTP. If you decide to import the file via remote connection, you must configure the connection in the Remote Connections tab.

Files (Output directory)

Click the Select button to navigate to the folder where you want to save the results file. 


Results

The output results file contains a tab for each flow that has been checked with all warning/error messages generated, and an overall summary tab.

The summary tab displays general information such as the names of all checked flows, the numbers of errors and warnings found, the number of rules defined, and the start and end time of the flow.

The tabs for each individual flow contain the type of rule (error, warning or custom types), the sheet where the rule was not satisfied (e.g. Workflow) and the line which contains the violated rule, the task and corresponding option which did not respect the rule and an error message explaining the issue for each entry.

Errors are displayed first, followed by warnings and then any custom rule types defined.