Deploying a process flow

Introduction

When a process flow is deployed and enabled, it runs automatically, according to defined trigger shape settings (or API requests).

Typically, you would build your required flow from the draft version and then deploy this however, it is possible to deploy an older, inactive version if needed.

For detailed information about the different process flow versions that you may encounter, please see Process flow versioning.

If you use virtual environments, the steps detailed on this page will vary - please refer to Deploying a single process flow to a virtual environment.

Need to know

  • Unless you're using virtual environments, you will always deploy process flows to no environment.

  • A process flow can be deployed to no environment (or any given virtual environment) once. If you attempt to deploy a different version, you are prompted to overwrite the existing version as part of the deployment operation.

The steps

1

Access version details for the required process flow

Open settings for your process flow and scroll down to the versions panel.

For detailed instructions, please refer to Accessing process flow versions.

2

Select the required version

The currently selected version (i.e. the version displayed on the canvas) is shown with an 'eye' icon in the selected column.

Make sure that the version you want to deploy is selected here - typically, this would be a draft version, for example:

The selected version is shown on the canvas - double-check the process flow to ensure that it's correct.

3

Access deployment details

Click the view deployments button:

The deploy flow modal opens, showing existing deployments for this flow in the lower panel, and deployment options are in the upper panel :

If you use virtual environments, a single process flow might be deployed multiple times.

4

Select deployment options

Click in the environment field and select the no environment option:

If you use virtual environments, you'll see all available environments here. In this case, please refer to Deploying a single process flow to a virtual environment for more information.

Click in the flow version field and select the version to deploy:

If you want to change the default queue priority that's defined in process flow settings, click in the queue priority field and select your preferred priority:

The priority set here takes precedence over the queue priority defined for the process flow as a whole, in process flow settings.

5

Start the deployment

Click the deploy button to confirm your selections.

6

Confirm the deployment

If any version of this process flow is found in your target environment (including no environment), you are prompted to confirm that you want to replace the existing deployment:

If you're satisfied that it's safe to proceed, confirm this action. The deployment completes, and the canvas now shows the deployed version - for example:

At this point, the process flow is deployed AND enabled, which means it will run automatically as per any trigger settings.

If you click the view deployments button again, you'll see this deployment in the deploy flow modal - for example:

The associated ellipsis icon can be used to manage this deployment:

From here, you can edit, disable or delete the deployment.

PreviousManaging process flowsNextEnabling & disabling a flow deployment

Last updated

Was this helpful?