Updating a virtual environment version

Introduction

Once a virtual environment version is deployed, it cannot be edited. Any updates to the current (i.e. deployed) configuration for a virtual environment must be made in a draft version, and then this version must be deployed.

If you're not familiar with the lifecycle of a virtual environment configuration version, please refer to Understanding virtual environment versions.

The steps

1

Access virtual environments

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

2

Select the required virtual environment

Click the name associated with the virtual environment that you want to access - for example:

3

Access the DRAFT version

If a draft version exists, access it now - for example:

If there isn't a current draft version, you can create a new one from scratch. Alternatively, you can use the create draft from version option to copy the setup for an existing inactive or deployed version to a draft version.

4

Update the configuration

Update replacement components as needed:

Don't forget that you can add notes for the current draft version (any notes added here stay with this version throughout its lifecycle):

5

Test the updated configuration

Having completed required updates, you can test them against your master process flows. For more information, please refer to Testing a process flow against a virtual environment.

6

Deploy the configuration

Your updated configuration will be applied after it's deployed.

Creating a new virtual environment draft version

When a virtual environment is first created, a draft version is added automatically, ready for you to update. Similarly, when a draft version is deployed, a new draft is created. With this in mind, a draft version will typically be available when you access an existing virtual environment.

However, there may be times when you need to create a new draft version - for example, you may have lost track of what changes have been made in the current draft and want to start again from scratch, or you might want to start again based on the setup for an existing deployed or inactive version.

If you're not familiar with the lifecycle of a virtual environment configuration version, please refer to Understanding virtual environment versions.

Creating a new draft from scratch

1

Access the relevant virtual environment

If you're not already working in the required virtual environment, log in to the dashboard and select virtual environments | overview from the left-hand navigation menu, then select the environment to update.

2

Select the required virtual environment

Click the name associated with the virtual environment that you want to access - for example:

3

Delete the existing DRAFT version

Move down to the configuration versions panel and delete the existing draft version - for example:

For more information about deleting virtual environment versions, please refer to Deleting a virtual environment.

4

Create a new draft

Click the create button:

The create button is only displayed when no draft version exists

5

Configure the draft version

A new draft version is created, and you can configure replacements as needed:

6

Deploy the configuration

Your updated configuration will be applied after it's deployed.

Creating a new draft based on an existing version

If you want to use an existing deployed or inactive version as a starting point for editing, you can create a draft using the create draft from version option.

1

Access the relevant virtual environment

If you're not already working in the required virtual environment, log in to the dashboard and select virtual environments | overview from the left-hand navigation menu, then select the environment to update.

2

Select the required virtual environment

Click the name associated with the virtual environment that you want to access - for example:

3

Access options for an existing inactive or deployed version

Move down to the configuration versions panel and click the ellipsis icon associated with the inactive or deployed version that you want to use as the starting point for your draft - for example:

4

Create draft from version

Select the create draft from version option:

If a draft version exists when this option is used, it gets overwritten with the configuration from the selected version - in this case, the version number is NOT incremented. If no draft version exists, a new one is created with the configuration from the selected version.

5

Update draft version

You can now access the draft version and configure replacements as needed.

6

Deploy the configuration

Your updated configuration will be applied after it's deployed

Last updated