# Regret reasons

## Regret reasons at a glance

Regret reasons are Sales configuration data used to describe why an offer reaches the
**Regretted to Offer** sales outcome. The shared reference screen is titled
**Regret Reasons**.

| If you need to… | Go to |
|---|---|
| Find the list and open its new-entry form | [Find the regret reasons list](#find-the-regret-reasons-list) |
| Identify the field and stored values used by the form | [Understand the list and form](#understand-the-list-and-form) |
| Choose the right maintenance path | [Add or maintain a regret reason](#add-or-maintain-a-regret-reason) |
| Add a new reason | [Add a new reason](#add-a-new-reason) |
| Change an existing reason | [Change an existing reason](#change-an-existing-reason) |
| Close a form without submitting it | [Leave a form without saving](#leave-a-form-without-saving) |
| Review related Sales reference lists | [What to do next](#what-to-do-next) |
| Return to the surrounding sales workflow | [Missed, regretted, and cancelled jobs](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/missed-regretted-and-cancelled-jobs) |
| Read the broader stage flow | [Sales jobs lifecycle](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/sales-jobs-lifecycle) |

## Before you start

Sign in before opening the Sales configuration list. The available actions depend on your
subscription, permissions, and saved list layout.

| Check before you begin | What it changes |
|---|---|
| The Sales subscription includes this feature | **New** is available only when the subscription is included and the new-button condition allows it. |
| Editing is allowed for your account | The row edit action is available only when editing is allowed. |
| The selected item and a visible form column are available | The edit form requires a selected item and a column that is visible in the form. |
| The visible tabs | Use the tabs shown on the screen to choose an available reference list. |

Use the visible page and tabs to choose what your account can open.

## Find the regret reasons list

**Prerequisites**

- You are signed in.
- Your account can open the Sales configuration area.

**Steps**

1. Open **Configuration**.
2. Open **Sales**.
3. Select **Regret Reasons**.
4. Confirm that the list shows the **Name** column.
5. Confirm that **New**, **Refresh**, and **Settings** are visible.
6. Select **New**.

The new-entry form is titled **New Regret Reason**.

![The list with New, Refresh, Settings, and the Name column](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/d97c67d2559d1c82b7a8caa1a84788ea.png)

![The form titled New Regret Reason](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/50adaf65da5033078bfd6f1ca5fcece5.png)

**Result:** The **New Regret Reason** form is open over the regret-reason list.

## Understand the list and form

The list identifies regret reasons through the **Name** column. The form uses the same
Name value as a required text box, while the other stored fields remain hidden from
editing.

The columns shown depend on your saved list layout. **Name** is a visible list column. The
form field appears only when the form is open, an item is selected, and the column is
visible in the form.

| Form or list value | What you see |
|---|---|
| **Name** | A required text box in the edit form and a list column. |
| `DisplayOrder` | Hidden and not editable. |
| `ReasonID` | Hidden and not editable. |
| `CompanyID` | Hidden and not editable. |
| `StatusID` | Hidden and not editable. |
| `ReasonTypeID` | Hidden and not editable. |

The open form shows the required **Name** field and **OK**. While the form is open,
the list retained **New**, **Refresh**, and **Settings**.

![The required Name field in the open form](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/50adaf65da5033078bfd6f1ca5fcece5.png)

![The open form with the OK control](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/50adaf65da5033078bfd6f1ca5fcece5.png)

## Add or maintain a regret reason

Choose a maintenance path from the list.

| If you need to… | Use this path |
|---|---|
| Start a new reason | Select **New**, then follow [Add a new reason](#add-a-new-reason). |
| Change an existing reason | Use the icon-only edit action on the reason row when editing is allowed, then follow [Change an existing reason](#change-an-existing-reason). |
| Leave without submitting | Select **Cancel**, then follow [Leave a form without saving](#leave-a-form-without-saving). |
| Export the list | Use **Export** when the shared display and subscription conditions allow it. |

### Add a new reason

Use this procedure to open the new-reason form and complete its required field.

**Prerequisites**

- The regret-reason list is open.
- **New** is visible.
- The Sales subscription includes this feature and the new-button condition allows the action.

**Steps**

1. Select **New**.
2. Confirm that the form title is **New Regret Reason**.
3. Enter the reason in the required **Name** text box.
4. Confirm that **OK** is visible.

![The OK control beneath the required Name field](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/50adaf65da5033078bfd6f1ca5fcece5.png)

**Result:** The **New Regret Reason** form remains available with a completed required
**Name** field and **OK** visible.

### Change an existing reason

Use the icon-only edit control to change the **Name** of an existing regret reason when
editing is allowed.

**Prerequisites**

- The regret-reason list is open.
- Editing is allowed for your account.
- The selected item and a visible form column are available.

**Steps**

1. Select the icon-only edit action on the reason row.
2. Change the value in **Name**.
3. Confirm the changed value in **Name**.

**Result:** The edit form contains the changed **Name** value.

### Leave a form without saving

Select **Cancel** to close the open form without submitting its data.

**Prerequisites**

- The regret-reason form is open.
- The form's **OK** control is visible.

**Steps**

1. Select **Cancel**.
2. Confirm that the form's **OK** control is absent.
**Result:** The form is closed without a visible dialog, and its **OK** control is no
longer visible.

## Delete a reason

## Handle access and setup variations

The shared configuration screen can show different actions and fields for different
subscriptions, permissions, and saved column layouts. It serves multiple reference
entities, so the visible entity list and tabs belong to the shared screen.

| Variation | What changes |
|---|---|
| Subscription inclusion and the new-button condition | **New** is available when both conditions allow it. |
| Editing permission | The row edit action is available when editing is allowed. |
| Form state and column visibility | A form field appears when the form is open, an item is selected, and the field is visible in the form. |
| List layout | The columns shown depend on your saved list layout. |
| Shared screen | Visible tabs can navigate to sibling reference lists. |

If a field or action is absent, check the subscription, editing permission, and saved
column layout before treating the data as missing.

## When maintenance does not work

The form responds to forbidden characters with a validation message. A loading indicator
can remain visible while the list is loading.

| What you see | What to do |
|---|---|
| `Forbidden characters detected. Please remove them and try again.` | Remove the forbidden characters from **Name**, then try the form action again. |
| A loading indicator remains visible | Refresh the page and check the list again. |

Work from the headers visible in the list because its columns come from the current column
configuration.

## What to do next

The screen's visible tabs can take you to sibling reference lists.

| Continue with… | Open |
|---|---|
| Lost-reason reference data | [Lost reasons](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-sales-lost-reasons) |
| Cancellation-reason reference data | [Cancellation reasons](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-sales-cancellation-reasons) |
| Order-cancellation reference data | [Order-cancellation reasons](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-sales-order-cancellation-reasons) |
| Missed, regretted, and cancelled sales jobs | [Missed, regretted, and cancelled jobs](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/missed-regretted-and-cancelled-jobs) |
| The complete sales lifecycle | [Sales jobs lifecycle](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/sales-jobs-lifecycle) |

**Result:** The visible tabs provide a route to related Sales configuration and workflow
pages. The form is not submitted.
