Running a process

This article covers everything you need to know about running your process flow. For information on creating a process, go toย the Creating a basic processย article.

Once you build a new process flow for the first time, you will see the Run button on the Top bar. The "Run" button is disabled unless the process is both Saved and Validated. You cannot run a process that generates process errors at validation.

Document image

Once all errors are fixed, you can proceed with running the process.

Document image

Run a process

There are 3 ways of running your flow:

1. From the Top bar, pressing Run button.

2. From the Validation confirmation message by pressing the Run process button.

3. From processes list, in Process Designer (if the processย is Valid, the Run button is clickable).

Document image

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.

Document image

Input process variables require values of the same data type:ย 

  • A primitive type (string, integer, date etc.)ย 
  • A custom type: ย 
    • Data model - a text area will be available to set the data model value in a JSON format
    • File(s)

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.

Process instancesย 

You can now go to check instances details:

Document image


  1. Click on Check instances to go to instances details.ย 
  2. OR click on the contextual menu of the process and go to View Instances:
Document image

In the 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;
  • Actions consumed: the number of actions that were used for that run of the process;
  • 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).

Document image


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:

Document image
Document image

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:

Document image

The panels Instance Details or Action Details can be collapsed/expanded as needed:ย 

Document image
Document image