# Label management

## Introduction

Labels can be applied to [process flows](/product-documentation/process-flows/managing-process-flows/process-flow-labels.md), [virtual environments](/product-documentation/virtual-environments/implementing-virtual-environments/creating-a-virtual-environment.md), and [blueprints](/product-documentation/blueprints/the-anatomy-of-a-blueprint.md). 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](/product-documentation/process-flows/building-process-flows/process-flow-settings.md) 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="/files/eatdMeLoTQIv55gJwv5J" alt="" width="230"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}
**Access labels**

Select the `labels` option:

<div align="left"><figure><img src="/files/G4meOKDQ3hLeNgkTUfPh" alt=""><figcaption></figcaption></figure></div>

All existing labels are displayed on the `manage labels` page. For example:

<div align="left"><figure><img src="/files/iEAtoN4illzDm0s5hz45" 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="/files/puxZvSfmcz6n5eFM9vk4" alt=""><figcaption></figcaption></figure>

A new label form is displayed:

<div align="left"><figure><img src="/files/RFaXXnY6KUc2irhIGXCB" 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="/files/uguC2qCIGNVam5laytn0" 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](/product-documentation/process-flows/managing-process-flows/process-flow-labels.md), [virtual environments](/product-documentation/virtual-environments/implementing-virtual-environments/creating-a-virtual-environment.md), and [blueprints](/product-documentation/blueprints/the-anatomy-of-a-blueprint.md).
{% 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="/files/WA8vN9ntSX3ovFeLH5AI" alt=""><figcaption></figcaption></figure>

Label details are displayed. For example:

<div align="left"><figure><img src="/files/06XHspsCEkiwjzYyiQKt" 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="/files/nRPrKDvNasZYd0Ai6S2E" 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](/product-documentation/process-flows/managing-process-flows/process-flow-labels.md), [virtual environments](/product-documentation/virtual-environments/implementing-virtual-environments/creating-a-virtual-environment.md), and [blueprints](/product-documentation/blueprints/the-anatomy-of-a-blueprint.md), 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="/files/WA8vN9ntSX3ovFeLH5AI" alt=""><figcaption></figcaption></figure>

Label details are displayed. For example:

<div align="left"><figure><img src="/files/06XHspsCEkiwjzYyiQKt" alt=""><figcaption></figcaption></figure></div>
{% endstep %}

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

Click the `delete` button. For example:

<figure><img src="/files/A2RPcEAyUrjf1z219TEO" 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="/files/V6C9KdMCv6xO9kpTWrGW" alt=""><figcaption></figcaption></figure>
{% endstep %}
{% endstepper %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://doc.wearepatchworks.com/product-documentation/general-settings/label-management.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
