Running a process
updated about 1 month ago
This article covers everything you need to know about running your process flow. For information on creating a process, go to "Creating a basic process" article.
Once you build a new process flow for the first time, you will see the "Run" button on the Topbar. The "Run" button is disabled unless the process is both Saved and Validated. You cannot run a process that generates process errors at validation.
Once all errors are fixed, you can proceed with running the process.
There are 3 ways of running your flow:
1. from Topbar, pressing "Run" button
2. from Validation confirmation message, pressing "Run process" button
3. from processes list, in Process Designer (if the process is Vali, the Run button is clickable)
In order to start running, processes may or may not require input data - depending if the process flow has any Input process variables defined.
Process flow with no input process variables
If the process flow built has no Process variable declared as Input, the process flow will simply start running once you hit the "Run" button.
Process flows requiring input data
If the process flow built has Process variables declared as Inputs, once you hit the "Run" button, a dialog will pop-up requiring values for process Inputs in order to initiate the processing.
Input process variables require values of the same data type:
- A primitive type (string, integer, date etc.)
- A custom type:
- Data model - a textarea will be available to set the data model value in a JSON format
The users can upload a single or multiple files, depending if the input variable (file type) is declared as single or list.
Once input data is filled in, hit the "Run" button , the dialog closes and process flow starts running. A notification pops up informing on the process status.
Once processes completes, you will receive a confirmation message.
You can now go to check instances details:
- by clicking on "Check instances" to go to instances details.
- OR by clicking on the contextual menu of the process and go to “View Instances”:
In "Instances" page you will see all the instance Ids generated for each run of the process, each having details like:
- Instance Id: each time a process is Run, a new instance of the process is being created with a unique id;
- Started on : the date when the process was initiated by user (when instance created);
- Last updated: when the last action within the process was processed;
- Submitted by: username of person initiating the processing;
- Status: the status of process (the most severe status of an action within the processes).
In this list, identify the process instance you triggered. This can be done by checking the date it started on or by the user that triggered it (Submitted By column).
Click on your process instance Id to expand and view some of its properties (input and output process variables' values if there were any declared for the process).
Click on “Show details”:
Click on an action to view details about it: status, started on, when it was last updated, input and output process variables' values if there were any declared for the process.You are now on the instance view page. Here you can see a read-only version of the flow that was processed, each action having a visual indicator regarding its individual status:
Both panels for Instance Details or Action Details can be collapsed/expanded as needed: