Deploying a package

Introduction

Having created a package with a collection of process flows for deployment to one or more virtual environments, you can deploy it.

Deploying a package adds all associated flow versions to a selected virtual environment. As part of the deployment, all process flow versions are enabled, so they will run in the virtual environment automatically, according to any defined trigger settings.

Need to know

  • You can deploy a given package to a virtual environment as many times as you need.

  • If a deployed configuration exists for the selected virtual environment, this will be used. Otherwise, the current draft configuration is used. Note that this behaviour differs from deploying a single process flow via process flow settings, where only deployed virtual environments can be selected.

  • If you deploy a package to a virtual environment and the package includes a process flow that already exists in that virtual environment, the package takes precedence - the existing version becomes inactive and the package version is deployed.

  • When process flows are deployed via a package, they are enabled automatically (i.e. they will run according to any trigger shape settings). If you aren't ready for these deployments to be live, you can choose to deploy the package with disabled process flows.

  • Process flows are associated with a package for deployment purposes only. After a flow version is deployed, it won't be affected by any subsequent actions taken with the package - for example, if a package is removed, any associated flow deployments won't change.

The steps

1

Access virtual environment packages

Log in to the dashboard and select virtual environments | packages from the left-hand navigation menu.

2

Find the required package

Locate the package that you want to deploy (you can scroll the list, step through multiple pages, or search).

3

Select the deploy option

Click the ellipsis icon associated with the required package, then select the deploy option:

4

Select a virtual environment

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

All flows in the associated package will be deployed to this environment. If the package includes a process flow for which a version already exists in the selected environment, the existing version in the virtual environment is replaced with the package version.

If you're in any doubt about what might be replaced in virtual environments as a result of this deployment, you can use the compare option to clarify updates.

A package is deployed to one virtual environment at a time.

5

Add notes & confirm your selection

Optionally, you can add notes for this deployment - after this, click the review button:

6

Review pending deployments

Use the review panel to double-check flow versions in the selected package - for example:

If necessary, you can:

  • Use remove buttons to remove associated flows from this package

  • By default, process flows are enabled when deployed via a package. You can use the disable flows toggle option to deploy flows as disabled, so they exist in the target environment but do NOT run automatically.

The contents of a package cannot be changed after deployment.

7

Deploy the package

When you're satisfied that the content of the package is correct, click the deploy button - for example:

All flow versions in the package are deployed to the selected virtual environment, and you're returned to the list of packages.

8

Deploy the package to the next virtual environment (optional)

If you need to deploy a package to multiple virtual environments, repeat steps 2-7 for each virtual environment in turn.

PreviousComparing packagesNextUpdating a package

Last updated

Was this helpful?