# Viewing current blueprint installations

## Introduction

The `installs` page shows all existing installations of a blueprint, with options to forcibly [promote/demote](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/rolling-out-blueprint-updates/bulk-blueprint-updates-force) a specific version, or the [active version](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/changing-the-active-version-for-a-private-blueprint), to selected installations. 

You can also drill down to the details of a bulk installation to [check the status of associated updates](#installation-details) (either during or after completion), and you can even [cancel pending updates](#cancelling-pending-updates).

## Accessing the installs page

{% stepper %}
{% step %}
**Log in to your own company profile**

Log in to the dashboard and (if you're managing multiple company profiles) ensure that you've [switched to your own profile](https://doc.wearepatchworks.com/product-documentation/company-management/multi-company-profiles/switching-in-and-out-of-a-linked-company).
{% 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 by users associated with your company profile.
{% endstep %}

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

Click the blueprint tile that you want to manage. 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. For example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2Fsrdbj67z1vtOWMTlvfXS%2Faccess%20installls%20page%201a.png?alt=media&#x26;token=246e73d8-ffce-4a8c-bc40-3cc5ef1151cb" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}
**Select view installs**

Click the ellipsis icon at the top of the page:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FJwmn749LIfFNAtKPbx4h%2Faccess%20installls%20page%202.png?alt=media&#x26;token=541aef56-2df0-43d9-8f42-7c3134854a3d" alt=""><figcaption></figcaption></figure>

Then select the `view installs` option:

<div align="left"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FMlOz6eOPhmh2G8OpoRko%2Faccess%20installls%20page%203.png?alt=media&#x26;token=01c2a1da-3f49-423e-84c4-41a86187aff6" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

## Understanding the installs page

The installs page has three key areas: [**(1)** installs panel](#the-installs-panel); [**(2)** buttons for update actions](#update-actions); [bulk installs panel **(3)**](#the-bulk-installs-panel):

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FSXxeopAjIvUliH7YSJY6%2Finstalls%20page%201.png?alt=media&#x26;token=6c0ec8fc-83ec-41e1-8df6-79753ddb3b9d" alt=""><figcaption></figcaption></figure>

### The installs panel

The `installs` panel lists all 'child' company profiles where any version of this blueprint is installed. For example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FqD7nyr11BohEPriEpUbW%2Finstalls%20page%201a.png?alt=media&#x26;token=71d25456-571b-465a-bc40-fc3fcffb14c6" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
If the blueprint is installed for your own company profile, this is also shown.&#x20;
{% endhint %}

The following details are displayed for each installation:

<table><thead><tr><th width="264.36328125">Column</th><th>Summary</th></tr></thead><tbody><tr><td>Company</td><td>The name of the company where this blueprint is installed.</td></tr><tr><td>Installed version</td><td>The currently installed version.</td></tr><tr><td>Installed on</td><td>The date and time the currently installed version was installed.</td></tr><tr><td>First installed</td><td>The date and time this blueprint was first installed.</td></tr></tbody></table>

#### Search & filter options

Over time, your list of installations will grow. If necessary, you can use the `search` field to find the installation for a particular company name (or partial company name). You can also filter the list of installations by a selected version.

{% columns %}
{% column %}
**Search**

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F0eyhlb4xocLdkPxTlZbb%2Finstalls%20page%201b.png?alt=media&#x26;token=b158d895-a0fc-44ca-a8e7-a3ee382da925" alt=""><figcaption></figcaption></figure>
{% endcolumn %}

{% column %}
**Filter**

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FUEnUZEdvovBoqlcCgTgS%2Finstalls%20page%201c.png?alt=media&#x26;token=c745a6ed-3fd5-4b79-983f-43f6069ef72b" alt=""><figcaption></figcaption></figure>
{% endcolumn %}
{% endcolumns %}

### Update actions

When at least one installation is selected, buttons above the [installs list](#the-installs-panel) become active. For example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FQEtZVKH54F1ssnueF6jL%2Finstalls%20page%202.png?alt=media&#x26;token=094d3369-597a-488b-9074-7238705df482" alt=""><figcaption></figcaption></figure>

You can choose to:

* Promote the current [active version](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/changing-the-active-version-for-a-private-blueprint) of this blueprint to the selected installation.&#x20;
* Promote/demote the selected installation to a specific version

Please refer to [Bulk blueprint updates (force)](https://doc.wearepatchworks.com/product-documentation/blueprints/working-with-private-blueprints/rolling-out-blueprint-updates/bulk-blueprint-updates-force) for further information on these actions.

### The bulk installs panel

The `bulk installs` panel lists all 'bulk' updates that have taken place - i.e. all updates triggered using [update actions](#update-actions) on this page. For example:   &#x20;

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FLtaczHzvMidnIwYZj6vo%2Finstalls%20page%203.png?alt=media&#x26;token=f96bcc5b-9789-4f0a-876c-1f84a045ae61" alt=""><figcaption></figcaption></figure>

Bearing in mind that a single bulk update can include updates to multiple installations, the following details are displayed for each bulk update:

<table><thead><tr><th width="264.36328125">Column</th><th>Summary</th></tr></thead><tbody><tr><td>ID</td><td>The unique identifier associated with this bulk update.</td></tr><tr><td>Started</td><td>When a bulk update is triggered, the job is queued for processing. The <code>started</code> time is the time that the job is queued.  </td></tr><tr><td>Target version</td><td>The version to be applied in this bulk update. </td></tr><tr><td>Post-install action</td><td>The action selected when the <a href="bulk-blueprint-updates-force">bulk update was triggered</a>. Will be set to: <code>none</code>, <code>package_only</code>, or <code>package_and_redeploy</code>.</td></tr><tr><td>Progress</td><td>The number of selected installations updated in relation  to the total number selected for the bulk update.</td></tr><tr><td>Successes</td><td>The number of installations updated successfully from this bulk update.   </td></tr><tr><td>Failures</td><td>The number of installations that failed during this bulk update.</td></tr><tr><td>Status</td><td>The current status of the bulk update. Will be set to <code>running</code>, <code>completed</code>, or <code>failed</code>.</td></tr><tr><td>Actions</td><td>Click the <code>view</code> option for installation details, including target company profiles and the status for each one. For more information, please refer to the <a href="#installation-details">Installation details</a> section below.</td></tr></tbody></table>

## Installation details

The `bulk installs` panel shows one entry for each bulk update however, you can use the `view` action to drill down for detailed information for each entry:

<div align="left"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FCImSE4cokz7EBN1J59A9%2Fview%20install%20details%201.png?alt=media&#x26;token=682b8b8e-e32a-4a38-a3e2-69b6954cd3e0" alt=""><figcaption></figcaption></figure></div>

From here, the `batch items` page shows [general details](#batch-items-general-details) for the update, followed by a [breakdown of all company profiles included in this update](#batch-items-update-breakdown) (with the option to drill down for more information). 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%2FCB6tkdwGiVyrEuwTYcaK%2Fview%20install%20details%203a.png?alt=media&#x26;token=75ff549d-abde-4b01-91fa-9fba7de0eea4" alt=""><figcaption></figcaption></figure></div>

This information is especially useful if you need to investigate why a bulk update (or part of one) has failed.&#x20;

{% hint style="info" %}
If updates are pending, a `cancel` option (not shown in this screenshot) is available. For more information, see [Cancelling pending updates](#cancelling-pending-updates).
{% endhint %}

### Batch items - general details

General details for the associated bulk update are shown in the top panel - for example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FhTkKD6GX3BiGBZ4BOInp%2Fview%20install%20details%20-%20batch%20items%201.png?alt=media&#x26;token=79174941-bc19-4339-b6eb-3f92043d7611" alt=""><figcaption></figcaption></figure>

Available details are summarised below:

<table><thead><tr><th width="264.71484375">Item</th><th>Summary</th></tr></thead><tbody><tr><td>ID</td><td>The unique ID for the associated bulk update. </td></tr><tr><td>Started</td><td>When a bulk update is triggered, the job is queued for processing. The <code>started</code> time is the time that the job is queued. </td></tr><tr><td>Target version</td><td>The version to be applied in this bulk update. </td></tr><tr><td>Post-install action</td><td>The action selected when the <a href="bulk-blueprint-updates-force">bulk update was triggered</a>. Will be set to: <code>none</code>, <code>package_only</code>, or <code>package_and_redeploy</code>.</td></tr><tr><td>Progress</td><td>Each installation (i.e. company) selected for a bulk update is an update in itself - so if you selected 4 installations to update, there will be 4 updates to complete. You'll see the number completed in the context of the total, here. </td></tr><tr><td>Status</td><td>The current status of the bulk update. Will be set to <code>running</code>, <code>completed</code>, or <code>failed</code>.</td></tr></tbody></table>

### Batch items - update breakdown

In the lower panel, you'll find one entry for each installation/company profile selected for inclusion in the bulk update - for example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F4ROHMLGJ1WYxCWpZNyW7%2Fview%20install%20details%20-%20batch%20items%202.png?alt=media&#x26;token=b739407d-f6eb-4c0d-9cbb-23d2fc1fde2f" alt=""><figcaption></figcaption></figure>

Available options at the top of the breakdown pane are summarised below:

<table><thead><tr><th width="264.71484375">Item</th><th>Summary</th></tr></thead><tbody><tr><td>Search by name</td><td>Search for a specific installation/company by name or partial name (the search is not case sensitive).</td></tr><tr><td>Status filter</td><td>Use the dropdown list to filter the list of updates by current status.</td></tr><tr><td>Refresh</td><td>If a bulk update is running, information in this panel may change. Use the refresh button to update this page (including the <a href="#batch-items-general-details">general details pane</a>).</td></tr><tr><td>Close</td><td>Close this page and exit back to the main <a href="#understanding-the-installs-page">installs page</a>.</td></tr></tbody></table>

Available details for each installation/company are summarised below:

<table><thead><tr><th width="264.71484375">Item</th><th>Summary</th></tr></thead><tbody><tr><td>ID</td><td>The unique ID for the specific update.</td></tr><tr><td>Company</td><td>The company profile selected for update.</td></tr><tr><td>Status</td><td><p>When a bulk update runs, each specific update has its own status. This will be set to one of the following values:</p><ul><li><code>pending</code> (update has not started)</li><li><code>processing</code> (update is in progress)</li><li><code>installed</code> (update completed successfully)</li><li><code>already_up_to_date</code> (the version selected for installation was found to be installed already)</li><li><code>cancelled</code> (the <a href="#cancelling-pending-updates">user cancelled this update</a> when it was pending)</li></ul></td></tr><tr><td>Created</td><td> The date and time that the bulk update was triggered.</td></tr><tr><td>Updated</td><td> The last time this specific installation was updated.</td></tr><tr><td>Actions</td><td><p>Click the <code>view</code> option to view more details (including any error messages) for the associated update. For example:</p><p></p><p><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FiDtfWXJ6friwK6l3VoT3%2Fview%20install%20details%20-%20batch%20items%20with%20error.png?alt=media&#x26;token=c8e863a7-66d6-4f08-9ac2-36ba9637be3e" alt=""></p><p></p><p>Errors are unlikely, but if they do occur, the most likely cause is a configuration anomaly.  </p></td></tr></tbody></table>

{% hint style="info" %}
If updates are pending, a `cancel` option (not shown in this screenshot) is available. For more information, see [Cancelling pending updates](#cancelling-pending-updates).
{% endhint %}

### Cancelling pending updates

If you view details for a bulk install and the update is still running, you can choose to cancel any `pending` installations using the `cancel` button. For example: &#x20;

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FKcyA8iw0T5qAkwKfgpQ5%2Fbatch%20items%20-%20cancel%20pending%20c.png?alt=media&#x26;token=ebf751ba-7469-4ace-9897-90809ef1cd8f" alt=""><figcaption></figcaption></figure>

Any `pending` jobs will be cancelled. Any jobs that are currently set to a `processing` status will not be cancelled.&#x20;