# Installing a private blueprint

## Introduction

Having published a new blueprint, it becomes available in your private marketplace immediately. If If you're managing multiple company profiles, it 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.&#x20;
* **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.

Once a private blueprint is installed for a company and the associated process flows are deployed to required virtual environments (if applicable), any subsequent [updates to the blueprint](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/updating-a-private-blueprint) can be [applied via a bulk operation (i.e. forced)](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/rolling-out-blueprint-updates/bulk-blueprint-updates-force) or [accepted by each child company manually](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/rolling-out-blueprint-updates/accepting-a-blueprint-update-manually).

## Need to know

When a blueprint is installed, the current [active](https://doc.wearepatchworks.com/product-documentation/blueprints/about-blueprint-versions#the-active-version), version is used. For a new blueprint, the `active` version is always the initial version; however, the [active version is likely to change](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/changing-the-active-version-for-a-private-blueprint) if the blueprint is subsequently [updated](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/updating-a-private-blueprint).

## The steps

{% stepper %}
{% step %}
**Log in and switch to the required company profile**

Log in to the child company dashboard.
{% endstep %}

{% step %}
**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.&#x20;
{% endstep %}

{% step %}
**Select the required blueprint**

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

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FJkF2b8NcqUR6edt7kxbk%2Finstall%20flow%201.png?alt=media&#x26;token=ae927bbd-dd2c-4494-9e84-b9601286382d" alt=""><figcaption></figcaption></figure>

The blueprint manifest is displayed so you can see all flows and associated resources that will be installed. For example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F5vu8O6B0cOMEAQfcicio%2Finstall%20flow%202.png?alt=media&#x26;token=a3448644-ba81-4b93-904c-89594f606c29" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
If necessary, you can 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.
{% endhint %}
{% endstep %}

{% step %}
**Add connector instances**

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

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FwV4cTlETq0FFNCgSq4CG%2Fadd%20instance.png?alt=media&#x26;token=1c053eea-69dd-49f9-94ef-f4ef97fd804a" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
For general guidance on adding connector instances, please refer to [Adding a connector instance](https://doc.wearepatchworks.com/product-documentation/connectors-and-instances/working-with-instances/adding-an-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.
{% endhint %}
{% endstep %}

{% step %}
**Install the blueprint**

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

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FyzzwQ3U3mHHcKpJccsJQ%2Finstall%20flow%203.png?alt=media&#x26;token=d6716cf1-721b-4a67-b653-478cc60f3be9" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Choose install options**

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

<div align="left"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FDAtE5sNJp1jeDe5Acmar%2Finstall%20flow%204.png?alt=media&#x26;token=543c5016-3568-4b84-be31-0c6618fea8b3" alt=""><figcaption></figcaption></figure></div>

Available options are summarised below:

<table><thead><tr><th width="253.90625">Field</th><th>Summary</th></tr></thead><tbody><tr><td>None</td><td>The blueprint is installed, but the associated process flows are not deployed. Use this option if <a href="../../virtual-environments/about-virtual-environments">virtual environments</a> are not implemented for target company profiles.</td></tr><tr><td>Package flows</td><td>The blueprint is installed and the associated process flows are added to a new <a href="../../virtual-environments/virtual-environment-packages">package</a> - however, the package is not deployed. <br><br>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:<br><br><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FbusPTR6Ascaq7QdlSXf5%2Finstall%20flow%205.png?alt=media&#x26;token=8a9c65b9-c296-4f0e-9f87-2804525d0d48" alt=""><br><br>Do not use this option if <a href="../../virtual-environments/about-virtual-environments">virtual environments</a> are not implemented for target company profiles. A <code>package</code> must be deployed to a virtual environment - it can't be deployed to <code>no environment</code>. In this scenario, you should select <code>none</code> instead. </td></tr><tr><td>Package and redeploy</td><td>This option is intended for use when <a href="updating-a-private-blueprint">updating a blueprint</a> that's already installed - it should not be used if you are installing a blueprint to a company for the first time. <br><br>Do not use this option if <a href="../../virtual-environments/about-virtual-environments">virtual environments</a> are not implemented for target company profiles. A <code>package</code> must be deployed to a virtual environment - it can't be deployed to <code>no environment</code>. In this scenario, you should select <code>none</code> instead. </td></tr></tbody></table>

{% hint style="info" %}
The default setting is determined when the blueprint is built, but can be changed for each installation.
{% endhint %}
{% endstep %}

{% step %}
**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](https://doc.wearepatchworks.com/product-documentation/process-flows/managing-process-flows/flow-deployment/deploying-a-process-flow-with-virtual-environments)

If you selected `package flows` in the previous step, you should [access the new package](https://doc.wearepatchworks.com/product-documentation/virtual-environments/virtual-environment-packages/accessing-packages) and then [deploy it to all required environments](https://doc.wearepatchworks.com/product-documentation/virtual-environments/virtual-environment-packages/managing-packages/deploying-a-package). \
\
The `package and redeploy` option is not appropriate for new installations but if you did select it, you should [access the new package](https://doc.wearepatchworks.com/product-documentation/virtual-environments/virtual-environment-packages/accessing-packages) and then [deploy it to all required environments](https://doc.wearepatchworks.com/product-documentation/virtual-environments/virtual-environment-packages/managing-packages/deploying-a-package).&#x20;
{% endstep %}
{% endstepper %}
