Reviewing version information for virtual environment process flows

Introduction

When reviewing version information for a process flow that's deployed to virtual environments, there are two levels to consider:

The process flow versions panel

The versions panel is available in process flow settings - for example:

To access this information, open the required process flow, access process flow settings, then scroll down to the versions panel.

From here, you can see the following details for each version:

Heading
Summary

#

The flow version number. The version number remains constant unless another version is deleted, in which case any remaining version numbers update accordingly.

ID

The unique identifier associated with a version. This identifier remains constant, even if the original version number changes as a consequence of another version being deleted. If you are using our API to work with virtual environments, you'll need this id to target the required flow version.

Created

The date and time (UTC) this version was created.

Updated

The date and time (UTC) this version was updated.

Status

The current status of this version. Each new version of a process flow starts as a draft, and increments the version number. The version then progresses through its own lifecycle. It's important to remember that a single flow version can be deployed to multiple virtual environments. So:

  • If a flow version shows as deployed here, then it is currently deployed to at least one virtual environment (or to no virtual environment).

  • If a flow version shows as inactive here, then it has been disabled in/deleted from all virtual environments where it was previously deployed.

With this in mind, you'll likely want to view deployment activity for each version at a more granular level. You can do this within view deployments.

Version options

The ellipsis associated with each version provides access to the following options (availability varies, depending on the version status):

Option
Applicable from status...
Summary

Duplicate flow

draftdeployedinactive

Copy the selected flow version to a new process flow.

Copy to draft

deployedinactive

Overwrite the existing draft version with content from the selected flow version.

Upload to marktplace

deployed

Upload the selected version to your private marketplace (only applicable if the partner features bolt-on is enabled for your company profile).

Delete

inactive

Deletes the selected version entirely, including from any associated virtual environments and packages. Remaining version numbers are re-sequenced accordingly.

The view deployments page

Each time a process flow version is deployed to any (or no) environment, an entry is added to the view deployments page - for example:

To access this information, open the required process flow, access process flow settings, and then click view deployments:

From here, you can see the following details for each deployment:

Heading
Summary

Virtual environment

The name of the virtual environment selected for this deployment. This is appended with the environment type (either test or live).

Version

The process flow version number selected for this deployment. This is appended with the version id (a unique identifier for the version, which is needed if you're working with virtual environments via the API).

Enabled at

The date and time (UTC) that this deployment was made, appended with the username of the person who completed this operation.

Queue priority

The queue priority selected for this deployment.

Package

If a flow version was deployed via a package, the package name is shown.

Virtual environment deployment options

The ellipsis associated with each deployment provides access to the following options:

Option
Summary

Edit

Use this as a shortcut if you want to deploy a given version again, with similar settings. This populates the virtual envrionment, flow version, and queue priority fields with selections used in the given deployment. From here you can change the virtual envrionment and/or queue priority fields, then deploy the given version again.

Disable / Enable

Availability depends on whether the selected deployment is currently enabled or disabled, so you set the reverse state. Note that:

  • If a deployment is enabled, it will run in the associated virtual environment.

  • If a deployment is disabled, it will NOT run in the associated virtual environment.

Delete

Delete the selected deployment. This removes the flow version from the associated virtual environment and sets the status to inactive.

Last updated