Applying an active blueprint update manually

Introduction

When an existing blueprint is updated and set to active, an update available indicator is added to this blueprint in the private marketplace for any 'child' company profiles where it's installed.

The most efficient way to update multiple installations is to complete a bulk update via the installs page. However, if you only have one or two installations to update, you may prefer to do this manually, as described below.

Need to know

  • Any connector instances that you configured when the blueprint was first installed will persist following any update.

  • When you choose to update a blueprint, you can choose what should happen with associated process flows after the update is installed.

  • During the update process, existing process flows associated with the blueprint are 'un-deployed' and at the end, only flows included in the update package are redeployed. So, if an existing process flow has been removed from the blueprint version being applied, it remains in place but is not redeployed.

The steps

1

Log in and switch to the required company profile

Log in to the dashboard and (if you're managing multiple company profiles) switch to the required company profile.

These steps assume that you are installing a blueprint in a 'child' company.

As a partner company user, you will typically switch to a 'child' company to update blueprints. However, for testing purposes, you might choose to work with blueprint installations in your own company first (or have a dedicated 'child' company for testing).

2

Access private blueprints

Select marketplace from the left-hand navigation menu, then select blueprints and private tabs. Here you will see any blueprints that have been built from the 'parent' company, or from the child company itself.

3

Select the blueprint with a pending update

Select a blueprint with an update available flag - for example:

The blueprint manifest is displayed for the version that's currently installed. For example:

If necessary, you can choose to deselect items shown here. However, keep in mind that blueprints are designed and configured to work with the resources shown - you should only deselect items if you are confident that it's safe to do so.

4

Switch to the active version (optional)

If you want to review the contents of the active version, click in the version field and select the active version. For example:

5

Install the active update

Click the install active version button at the top of the page. For example:

6

Choose install options

Choose what should happen immediately after the installation has completed. For example:

Available options are summarised below:

Field
Summary

None

Process flows are installed from the blueprint but not deployed. Any existing deployed versions are unaffected. For existing flows, the blueprint version becomes the latest draft version.

Any new flows are installed but disabled and un-deployed.

Any existing flows that have been removed from the blueprint are disabled and un-deployed.

Package flows

Creates a package containing all process flows in the updated blueprint. The package name is set to the blueprint name, followed by the version and creation date. For example: When convenient, you should deploy this package to all required virtual environments.

During the update process, existing process flows associated with the blueprint are 'un-deployed' and at the end, only flows included in the update package are redeployed. So, if an existing process flow has been removed from the blueprint version being applied, it remains in place but is not redeployed.

Package and redeploy

Creates a package containing all process flows in the updated blueprint, then deploys this package to all virtual environments where a previous version exists (for the selected company profiles). During the update process, existing process flows associated with the blueprint are 'un-deployed' and at the end, only flows included in the update package are redeployed. So, if an existing process flow has been removed from the blueprint version being applied, it remains in place but is not redeployed.

7

Confirm the update

Having made your selections, click continue to start the update. For example:

8

Review detected changes

Any changes detected as a result of installing this update are displayed for review. For example:

If you're satisfied that these changes are correct, click proceed to perform the update:

9

Complete post-update actions

Action required after completing an update depends on which post-install action you selected in step 7. Guidelines are below:

Post-install action
Status after update
Action required

none

The previous draft version of any existing process flows associated with this blueprint becomes inactive. The blueprint version becomes the latest draft version. Any existing deployed versions are unaffected.

Deploy the latest draft version manually, via process flow settings. For more information, please refer to Deploying a process flow.

package flows

The updated set of process flows associated with the blueprint are added to a new package. Any existing deployed versions are unaffected.

Access the new package and then deploy it to all required environments.

package and redeploy

Any existing deployed versions are un-deployed. The updated set of process flows associated with the blueprint are added to a new package. The new package is deployed to all selected company profiles, and all applicable virtual environments for those companies. The latest set of process flows is enabled and deployed.

Review process flows in your selected companies to ensure the update has been applied correctly.

PreviousPromoting & demoting a blueprint update to existing installationsNextUploading custom connectors to your private marketplace

Last updated

Was this helpful?