Installing a private blueprint

Introduction

Having published a new blueprint, it becomes available in your private marketplace immediately. If yours is a partner company, this will be visible to all 'child' companies that you manage.

The blueprint installation process has two key parts:

  • Install. To install the blueprint, switch to the required company profile and then run the install from the private marketplace.

  • Deploy flows. Once the installation is complete, the associated process flows must be deployed. How this is done depends on which option you set for the installation.

Having installed a blueprint for a company and deployed the associated process flows to all required environments within that company, any subsequent updates to the blueprint can be promoted automatically.

Need to know

When a blueprint is installed, the current active version is used. For a new blueprint, the active version is always the initial version; however, the active version is likely to change if the blueprint is subsequently updated.

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 install blueprints. However, for testing purposes, you might choose to install a new blueprint 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 required blueprint

Click the blueprint tile that you want to install. For example:

The blueprint manifest is displayed so you can see all flows and associated resources that will be 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

Add connector instances

Move down to the connectors section and add your required instances for each connector. For example:

For general guidance on adding connector instances, please refer to Adding a connector instance. Providing credentials for instances here means that process flows will be installed with all required setup. If you don't add an instance (or select an existing one) here, you will need to create them after the installation, then manually update connector shapes in process flows.

5

Install the blueprint

Click the install 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

The blueprint is installed, but the associated process flows are not deployed. Use this option if virtual environments are not implemented for target company profiles.

Package flows

The blueprint is installed and the associated process flows are added to a new package - however, the package is not deployed. When this option is selected, a new package is created. The package name is set to the blueprint name, followed by the version and creation date. For example: Do not use this option if virtual environments are not implemented for target company profiles. A package must be deployed to a virtual environment - it can't be deployed to no environment. In this scenario, you should select none instead.

Package and redeploy

This option is intended for use when updating a blueprint that's already installed - it should not be used if you are installing a blueprint to a company for the first time. Do not use this option if virtual environments are not implemented for target company profiles. A package must be deployed to a virtual environment - it can't be deployed to no environment. In this scenario, you should select none instead.

The default setting is determined when the blueprint is built, but can be changed for each installation.

7

Post-install actions

If you selected none in the previous step, process flows will be installed but not deployed. You should access each installed process flow and deploy it manually

If you selected package flows in the previous step, you should access the new package and then deploy it to all required environments. The package and redeploy option is not appropriate for new installations but if you did select it, you should access the new package and then deploy it to all required environments.

PreviousBuilding & publishing a private blueprintNextUpdating a private blueprint

Last updated

Was this helpful?