# Label management

## Introduction

Labels can be applied to [process flows](https://doc.wearepatchworks.com/product-documentation/process-flows/managing-process-flows/process-flow-labels), [virtual environments](https://doc.wearepatchworks.com/product-documentation/virtual-environments/implementing-virtual-environments/creating-a-virtual-environment), and [blueprints](https://doc.wearepatchworks.com/product-documentation/blueprints/the-anatomy-of-a-blueprint). They are a useful way to tag/categorise these items into categories, particularly when you're managing lots of resources.

You can create and apply labels 'on the fly' whilst adding/updating a process flow, virtual environment, or blueprint - but if you have a significant amount of work to do on labels, it's simpler to do this from general settings.&#x20;

All labels are added to the same 'pool', irrespective of origin. For example, labels created for a process flow via [process flow settings](https://doc.wearepatchworks.com/product-documentation/process-flows/building-process-flows/process-flow-settings) can also be applied to virtual environments, and vice versa.&#x20;

## Need to know

* If you update the name and/or colour of a label, that change is immediately applied to any items where this label is already applied.
* If you delete a label from general settings, that label is immediately removed from any items where it was already applied.&#x20;
* A label cannot exceed 20 characters.

## Accessing labels

To access existing labels for your company profile, follow the steps below.

{% stepper %}
{% step %}
**Access general settings**

Select `settings` from the bottom of the left-hand navigation menu:

<div align="left"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FQlgseX2vfuTkkQvK0lhL%2Flabel%20management%201.png?alt=media&#x26;token=2b54eaae-76f6-49e4-94e7-24c46d3e94ef" alt="" width="230"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Access labels**

Select the `labels` option:

<div align="left"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FnTX4n0wfH7hHFDKlnRKS%2Flabel%20management%202.png?alt=media&#x26;token=8c628c71-f261-4263-bfc2-36c4e42971d0" alt=""><figcaption></figcaption></figure></div>

All existing labels are displayed on the `manage labels` page. 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%2Fh3tXM2U5FbGWQOgPDWdb%2Flabel%20management%203.png?alt=media&#x26;token=5658fdee-d4c9-45d4-83f7-b54df9902629" alt=""><figcaption></figcaption></figure></div>
{% endstep %}
{% endstepper %}

## Adding a label

To add new labels for your company profile, follow the steps below.

{% stepper %}
{% step %}
**Access labels**

Follow the steps [above](#accessing-labels) to access the `manage labels` page.
{% endstep %}

{% step %}
**Create a new label**

Click the `create label` button 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%2Fb4JYT47UqmhOpeYjy3dB%2Fcreate%20label%201.png?alt=media&#x26;token=3e8e6ad0-20d5-41bb-9d5e-5edf30ef8a13" alt=""><figcaption></figcaption></figure>

A new label form is displayed:

<div align="left"><figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FwKav51XoGrMhM7j7kWnh%2Fcreate%20label%202.png?alt=media&#x26;token=dad914bd-fd3e-4c32-a3e5-79223437e383" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Configure the label**

Enter a `name` for the label and select a `colour`; then click the create label button. For example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2F9w3lBWL5SHm507rOwwCt%2Fcreate%20label%203.png?alt=media&#x26;token=3bfe30c7-4dec-4d51-b598-e1b2f447e304" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
These selections determine how the label is displayed when it's applied to resources - the name will be shown exactly as defined here, with the selected colour.&#x20;
{% endhint %}

{% hint style="warning" %}
Label names cannot exceed 20 characters.
{% endhint %}
{% endstep %}

{% step %}
**Apply labels as needed**

The label is ready for use - it can be applied to [process flows](https://doc.wearepatchworks.com/product-documentation/process-flows/managing-process-flows/process-flow-labels), [virtual environments](https://doc.wearepatchworks.com/product-documentation/virtual-environments/implementing-virtual-environments/creating-a-virtual-environment), and [blueprints](https://doc.wearepatchworks.com/product-documentation/blueprints/the-anatomy-of-a-blueprint).
{% endstep %}
{% endstepper %}

## Updating an existing label

To update the name or colour for an existing label, follow the steps below:

{% stepper %}
{% step %}
**Access labels**

Follow the steps [above](#accessing-labels) to access the `manage labels` page.
{% endstep %}

{% step %}
**Access label settings**

Click the name of the label that you want to update. For example:&#x20;

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FVdIPWuz0InzhBPdnJB07%2Fupdate%20label%201.png?alt=media&#x26;token=67dbc56b-30ea-4a57-a365-d13b8ac348c7" alt=""><figcaption></figcaption></figure>

Label details are displayed. 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%2FZFqwDy6mwRvkgdSvcQam%2Fupdate%20label%201a.png?alt=media&#x26;token=acc9834b-55c2-4ecc-8fc1-69c884b36c37" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Update label settings**

Update the label `name` and/or `colour`; then click the `save` button. For example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FSmJhoKwId8Hxt9PkkKdr%2Fupdate%20label%202.png?alt=media&#x26;token=b960d742-ad9c-461f-9b8d-3fb27ec428a8" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Updates will be applied immediately, wherever this label is currently applied.
{% endhint %}

{% hint style="warning" %}
Label names cannot exceed 20 characters.
{% endhint %}
{% endstep %}
{% endstepper %}

## Remove an existing label

When a label is removed, it's no longer available for use. If you delete a label that's currently applied to [process flows](https://doc.wearepatchworks.com/product-documentation/process-flows/managing-process-flows/process-flow-labels), [virtual environments](https://doc.wearepatchworks.com/product-documentation/virtual-environments/implementing-virtual-environments/creating-a-virtual-environment), and [blueprints](https://doc.wearepatchworks.com/product-documentation/blueprints/the-anatomy-of-a-blueprint), it will be cleared from those resources immediately. To remove an existing label, follow the steps below:

{% stepper %}
{% step %}
**Access labels**

Follow the steps [above](#accessing-labels) to access the `manage labels` page.
{% endstep %}

{% step %}
**Access label settings**

Click the name of the label that you want to remove. For example:&#x20;

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FVdIPWuz0InzhBPdnJB07%2Fupdate%20label%201.png?alt=media&#x26;token=67dbc56b-30ea-4a57-a365-d13b8ac348c7" alt=""><figcaption></figcaption></figure>

Label details are displayed. 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%2FZFqwDy6mwRvkgdSvcQam%2Fupdate%20label%201a.png?alt=media&#x26;token=acc9834b-55c2-4ecc-8fc1-69c884b36c37" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Delete the label**

Click the `delete` button. For example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FZLbTLXJl7XNJYtOufiO7%2Fdelete%20label%201.png?alt=media&#x26;token=d32180ff-8273-4dc3-9e27-1fb9a697eaf8" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
Updates will be applied immediately, wherever this label is currently applied.
{% endhint %}

{% hint style="warning" %}
Label names cannot exceed 20 characters.
{% endhint %}
{% endstep %}

{% step %}
**Confirm this action**&#x20;

When prompted, confirm that you want to remove this label. For example:

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FtGH9KdvOO6YHsut16a6D%2Fdelete%20label%202.png?alt=media&#x26;token=43361658-5a06-4425-887a-6c59e15002a0" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}
