# Flags

## Flags

Flags maintains named colour markers for sales jobs. Use a flag when your team needs a consistent
visual way to distinguish or group sales-job records.

| If you need to… | Go to |
|---|---|
| Understand what a flag is and when to use one | [Flags](#flags) |
| Check access, subscription, and record conditions | [Before you start](#before-you-start) |
| Open the list and identify its actions | [Find Flags](#find-flags) |
| Learn what the list and popup contain | [Understand the Flags list and form](#understand-the-flags-list-and-form) |
| Add or change a named colour marker | [Add or edit a flag](#add-or-edit-a-flag) |
| Remove a flag or export flag data | [Delete or export flag data](#delete-or-export-flag-data) |
| Resolve a validation or deletion message | [When flag maintenance goes wrong](#when-flag-maintenance-goes-wrong) |
| Open another company reference list | Continue with the company configuration |

Flags is available when the company subscription includes flag maintenance. Create a named flag and
select its colour so the same marker has the same meaning across your sales jobs.

## Before you start

Flags maintenance depends on the company subscription and on the permissions available to your
account. The screen can show different actions, or an upgrade surface instead of the list, according
to those conditions. When access is available, open the list with the actions described in the next
section.

| Condition | What you see |
|---|---|
| The flag-maintenance subscription is not included | A subscription-upgrade surface replaces the grid. |
| Your account cannot create a flag | **New** is hidden. |
| Your account cannot edit flags | The row edit control is unavailable. |
| Your account cannot delete flags | The row delete control is unavailable. |
| Your account cannot export flag data | Export controls are unavailable. |
| Your account cannot import flag data | Import controls are unavailable. |

The delete action also depends on the number of records: deletion is performed only when the list
contains more than one item. A single-item list cannot be reduced further.

## Find Flags

Open the Flags page to view the list of flags.

**Prerequisites**

- Your account has access to the Flags screen.

**Steps**

1. Open the Flags page.
2. Confirm that the page title is **Flags**.
3. Confirm that the list contains four rows.
4. If you can create a flag, confirm that **New** is available.

![The Flags page, its four-row list, and the New action](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/38c687d3276e60a4cea7e82240dbce44.png)

**Result:** The **Flags** list is open. You can identify **New** when your account can create a flag.

## Understand the Flags list and form

The list displays **Name** and **Color** columns. The new-flag popup contains **Name**, **Color**,
and **OK**. The list can also display **Refresh** and **Settings**.

![The Flags list with Name and Color columns and its list actions](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/90bd54a1463e0395e287b50c8b509c59.png)

Work from the **Name** and **Color** headers visible in your list.

The row edit and delete controls depend on your account permissions. If the subscription feature is
unavailable, the subscription-upgrade surface appears instead of the grid. Use these controls to
maintain a flag, as described next.

### Fields

| Field | Type | Reader action | Visibility and rule |
|---|---|---|---|
| **Name** | Text box | Enter the flag name. | Visible in the form and required. |
| **Color** | Select box | Select a colour. | Visible in the form and required. |
| System-managed fields (3) | — | None | Hidden and stored without reader entry. |

The **Color** choices display each option's name and save its colour value. Use the visible **Name**
and **Color** headers to identify the list columns.

## Add or edit a flag

Use this procedure to add a new flag or change an existing one. **Name** and **Color** carry required
markers in the live popup.

**Prerequisites**

- The company subscription includes flag maintenance.
- Your account can create or edit flags.

**Steps**

1. Select the starting action:

   | If you want to… | Select… |
   |---|---|
   | Create a flag | **New** |
   | Change an existing flag | The edit control in the row you want to change |

2. Enter the flag name in **Name**.
3. Select the flag colour in **Color**.
4. Choose how to leave the popup:

   | If… | Select or do this… |
   |---|---|
   | The popup is ready to save | Select **OK**. |
   | The popup remains open after you select **OK** | Correct the required fields or forbidden characters. |
   | You do not want to save | Select **Cancel** to leave without saving. |

**New** creates an item and opens the new-item popup. The edit control copies its row into the edit
popup. The new-item popup is titled **New Flags** and displays **OK**.

![The New Flags popup with the required Name and Color fields](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/0725629b2da54c33bc6b235bc2870253.png)

When the operation succeeds, the application uses `Data saved Successfully` for a new item and
`Data updated Successfully` for an update.

**Result:** The popup closes after a successful operation. If you select **Cancel**, it closes without
saving. To remove or export a flag, continue with the next section.

## Delete or export flag data

Use the row delete control only when deletion is available and more than one flag exists. Use **Export**
when you need flag data in a selected format.

**Prerequisites**

- Your account has delete permission for the row you want to remove, or export permission for the data you want to extract.
- More than one flag exists before you delete a row.

**Steps**

1. Select the data action:

   | If you want to… | Select… |
   |---|---|
   | Remove a flag | The delete control in the row you want to remove |
   | Export flag data | **Export** |

2. If you selected **Export**, select a format in the export options.

If the Flags list contains one item, deletion is blocked and the application shows
`Must have at least one item`. A successful deletion uses `Data Deleted Successfully`. A failed
deletion can show `Failed to Delete` or `Related to Saved data, Can't be deleted`.

**Result:** The selected delete or export action has been requested. If a message prevents the action,
use the next section to correct it.

## When flag maintenance goes wrong

Use the message on screen to identify what to correct before trying the action again. After the action
succeeds, continue with another company reference list.

| Message | What to do |
|---|---|
| `Name is required` | Enter a value in **Name**. |
| `Color is required` | Select a value in **Color**. |
| `Forbidden characters detected. Please remove them and try again.` | Remove the forbidden characters from **Name**, then try saving again. |
| `Must have at least one item` | Keep at least one flag in the Flags list before deleting. |
| `Failed to Delete` | Do not continue deleting the row; review the deletion condition and try again. |
| `Related to Saved data, Can't be deleted` | Do not delete the related flag; retain it for the saved data that uses it. |

## Continue with company configuration

Open a sibling company reference-list page when you need to maintain another list.

Continue with the company reference lists for:

- Company branches
- Company product types.
- Company currencies.
- Company market segments.
- Company item categories.
- Company departments.
- Company reactivation reasons.
- Company product categories.
