Deploying a single process flow to a virtual environment

Introduction

You can deploy any existing draft or inactive version of a process flow to a virtual environment.

This page provides instructions for deploying process flows in the context of virtual environments. Before deploying process flows to virtual environments for the first time, it's important to understand how flow versioning works - if you're not already familiar with this, please see Understanding flow versioning for virtual environments.

If you need to deploy multiple process flows, adding them to a package of flows for deployment is more efficient. For further information, please refer to our virtual environment packages section.

If you do NOT use virtual environments, different instructions apply; please refer to Deploying a process flow.

Need to know

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

  • Any version of a given process flow can be deployed to any number of virtual environments.

  • When a process flow is deployed to a virtual environment, it runs against the current deployed configuration version for that environment.

  • If a process flow includes a run process flow shape, the 'called' flow must be deployed to the same virtual environment. If a 'called' process flow can't be found in the same environment, an error is given, and the flow will fail.

For detailed information about how versioning works with process flows in virtual environments, please refer to Understanding flow versioning for virtual environments.

Deploying a process flow to a virtual environment

1

Access the required process flow

Access the first process flow that you want to deploy.

2

Open process flow settings

Select the settings icon from the actions bar:

3

View deployments

Scroll down to the versions panel and click the view deployments option:

The view deployments page is displayed:

For more information about the view deployments page, please see Reviewing version information for process flows.

4

Choose an environment

Click in the environment field and select the required virtual environment from the dropdown list - for example:

If necessary, you can deploy a flow version without selecting an environment. This deploys and enables the flow, allowing it to run according to defined triggers, but without any virtual environment replacements.

All virtual environments with a deployed configuration version will be available for selection. If you don't see a virtual environment that you're expecting, check that its configuration has been deployed.

5

Choose a flow version

Click in the flow version field and select the required process flow version from the dropdown list - for example:

Over time, the number of flow versions displayed here will change. You can deploy any version (of any status), provided that the selected environment does not already contain a version of this process flow.

6

Set a queue priority

Each process flow has a queue priority, defined in process flow settings. This applies to the process flow as a whole - any version you choose to deploy inherits this setting. If required, you can override the priority here:

Changing the priority here means that the new priority is applied when this flow version runs in the given virtual environment.

7

Start the deployment

Click the deploy button to confirm your selections.

This deployment is added to the list and can be managed from here as needed.

8

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. At this point, the process flow is deployed AND enabled, which means it will run automatically as per any trigger settings.

The deployment is added to the view deployments modal, where the associated ellipsis icon can be used to manage this deployment:

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

PreviousTesting a process flow against a virtual environmentNextUnderstanding flow versioning for virtual environments

Last updated

Was this helpful?