# Transfer reasons

## Transfer reasons

A transfer reason is a warehouse configuration record that names why a transfer is made. The
list is maintained in the Warehouse configuration flow.

| If you need to… | Go to |
|---|---|
| Check access, saved information, and approval boundaries | [Before you start](#before-you-start) |
| Open the list and identify its entry point | [Find the transfer-reason list](#find-the-transfer-reason-list) |
| Review fields and the new/edit form | [Understand the list and form](#understand-the-list-and-form) |
| Add, change, or remove a reason | [Add, edit, and remove a transfer reason](#add-edit-and-remove-a-transfer-reason) |
| Export the list | [Export the list](#export-the-list) |
| Resolve a blocked action or message | [When maintenance does not work](#when-maintenance-does-not-work) |
| Continue with another Warehouse reference list | [After maintaining transfer reasons](#after-maintaining-transfer-reasons) |

Open **Configuration**, then **Warehouse**, then **Transfer Reasons**.

![The Transfer Reasons list in the Warehouse configuration flow](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/a432a9dbb13fac42ef8ab52c62e8fcce.png)

## Before you start

Transfer-reason maintenance is available when your subscription includes the configured feature
and your account has permission for the action you need.

Prerequisites

- Confirm that your subscription includes the configured feature.
- Have the name for a new or replacement reason ready.
- Have permission to create a record before using **New**.
- Have edit permission before changing an existing row.
- Have delete permission before opening a row's delete menu.
- Follow your organisation's approval practice before saving or deleting a reason.

The product displays an upgrade surface instead of the grid when the subscription does not
include the configured feature.

## Find the transfer-reason list

The transfer-reason list is the Warehouse configuration reference list under **Warehouse**.
Transfer-reason rows appear under the **Name** column. The list also shows **New**, a refresh
button titled **Refresh**, and a settings button titled **Settings**.

**Prerequisites**

- Your account can open the Warehouse configuration surface.

Path: **Configuration** > **Warehouse** > **Transfer Reasons**.

Steps

1. Confirm that the list contains the **Name** column.
2. Identify transfer-reason rows by the values shown under **Name**.
3. Select **New** when you need to create a reason.

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

**Result:** The Transfer Reasons list is open, and **New** is available. Continue with
[understanding the list and form](#understand-the-list-and-form).

## Understand the list and form

The form has one entry field: the required **Name**. Ordering and identifier fields are not entry
fields.

| Surface | What you see | What it is for |
|---|---|---|
| List | **Name** | Identifies each transfer-reason row. |
| New/edit form | **Name** with a required marker | Enters the transfer-reason name. |
| New/edit form | **OK** | Submits the shared popup form. |
| End of row | Edit and delete actions | Maintains an existing row when your permissions allow it. |

The entity configuration includes **Name**, **DisplayOrder**, **ID**, and **CompanyID**. **Name**
is a required text box visible in the list and form. The other fields are hidden from the form.
No other transfer-reason fields or transfer-reason-specific select box, date box, number box, or
nested collection is declared.

The visible column set can come from the saved list configuration, so work from the headers that
appear in your list rather than assuming every possible column is visible.

![The new-record popup with the required Name field and OK control](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/c9f6793b353b46ed7d35c493b28f2d61.png)

The new-record surface is titled `New Transfer Reason`. It shows **Name** with a required marker
and **OK**.

## Add, edit, and remove a transfer reason

Use **New** for a new row, the action at the end of the row for a change, and the action at the
end of the row for removal. **Cancel** closes the delete menu, **Delete** confirms the removal
request, **Save** submits the edit popup, and **OK** submits the new-record form.

| If… | The available path is… |
|---|---|
| **New** is available and the subscription feature is included | Select **New**. |
| You have permission to change a reason | At the end of the row, select the action for editing. |
| You have permission to remove a reason | At the end of the row, select the action for removal to open the delete menu. |
| The list has more than one item | Deletion calls the API, removes the item, renumbers **DisplayOrder**, and shows a success alert. |
| The list has one item or fewer | Deletion does not call the API and shows `Must have at least one item`. |

Choose the procedure that matches the change you need.

### Add a transfer reason

Add a transfer reason when a new warehouse movement needs a selectable explanation.

Prerequisites

- The subscription includes the configured feature.
- **New** is available.
- You have the reason name ready.
- Your organisation's approval practice permits the change.

Steps

1. Select **New**.
2. Enter the reason name in **Name**.
3. Select **OK** on the new-record popup.
4. Select **Save** when the shared save action is available.
5. Correct **Name** and resubmit with **OK** or **Save** when a validation message appears.

The save path uses `Data saved Successfully` for a new item.

**Result:** The new transfer reason is submitted, or the displayed validation message identifies
the correction required. Continue with [editing or removing a transfer reason](#edit-a-transfer-reason)
or [exporting the list](#export-the-list).

### Edit a transfer reason

Edit a transfer reason when an existing row needs a different name.

Prerequisites

- The row already exists.
- Edit permission is available.
- Your organisation's approval practice permits the change.

Steps

1. At the end of the row, select the action for editing.
2. Change the value in **Name**.
3. Select **Save** in the shared edit popup.
4. Correct **Name** and resubmit with **Save** when a validation message appears.

The update path uses `Data updated Successfully` for an existing item.

**Result:** The edited name has been submitted through **Save**, or the displayed validation
message identifies the correction required. Continue with [deleting a transfer reason](#delete-a-transfer-reason)
or [exporting the list](#export-the-list).

### Delete a transfer reason

Delete a transfer reason when the row is eligible and your organisation's approval practice permits
the change.

Prerequisites

- Delete permission is available.
- The list contains more than one item.
- You have confirmed that removing the reason is appropriate.

Steps

1. At the end of the row, select the action for removal to open the delete menu.
2. Select the action that matches your decision.

   | If you want to… | Select |
   |---|---|
   | Close the delete menu without deleting the row | **Cancel** |
   | Approve the removal | **Delete** |
3. Apply the message-specific action in [When maintenance does not work](#when-maintenance-does-not-work)
   when deletion is blocked.

For a list with more than one item, the delete path removes the item, renumbers **DisplayOrder**,
and shows `Data Deleted Successfully`.

**Result:** The delete menu is closed, or an eligible row has been submitted for deletion. A row
with related saved data or the only remaining row stays in the list. Continue with
[exporting the list](#export-the-list) or [handling access and list-size variations](#handle-access-and-list-size-variations).

### Export the list

Export the transfer-reason list when you need it outside the current grid. **Export** opens the
export-options modal.

Prerequisites

- The transfer-reason list is open.
- Export access is available.

Steps

1. Select **Export**.

**Result:** The export-options modal opens.

Continue with [handling access and list-size variations](#handle-access-and-list-size-variations).

## Handle access and list-size variations

The same Warehouse route can show different maintenance surfaces because subscription coverage,
permissions, saved list settings, and the number of rows affect what appears.

| Condition | What changes |
|---|---|
| The subscription includes the configured feature | The grid and configuration actions are available. |
| The subscription excludes the configured feature | The subscription-upgrade surface appears instead of the grid. |
| **New** is available | Select **New** to open the new-record popup. |
| New permission is available and columns/data are loaded | The separator after **New** is available. |
| You have permission to change a reason | The action for editing is available at the end of the row. |
| You have permission to remove a reason | The action for removal is available at the end of the row. |
| The list has more than one item | The delete path can call the API, remove the item, renumber **DisplayOrder**, and show success. |
| The list has one item or fewer | The delete path is blocked with `Must have at least one item`. |
| Saved list settings supply dynamic columns | The visible columns and labels follow those settings. |

Use the rows and headers currently displayed in your account, then continue with
[When maintenance does not work](#when-maintenance-does-not-work) if an action is blocked.

## When maintenance does not work

Use the exact message on screen to choose the corrective action, then return to the relevant
maintenance procedure.

| Message | What it means | What to do |
|---|---|---|
| `Name is required` | The required **Name** value is empty. | Enter a name in **Name**, then select **OK** or **Save**. |
| `Just '_' '-' And '.' Characters Accepted` | The name fails the pattern rule. | Remove the forbidden characters, then select **OK** or **Save**. |
| `Forbidden characters detected. Please remove them and try again.` | The submitted value contains forbidden characters. | Remove the forbidden characters, then select **OK** or **Save**. |
| `Related to Saved data, Can't be deleted` | Related saved data prevents deletion. | Keep the transfer reason and review the related saved data. |
| `Failed to Delete` | The delete operation failed. | Stop and review the failure before repeating the request. |
| `Must have at least one item` | The list has one item or fewer. | Keep at least one transfer reason. |
| `Data saved Successfully` | The new-item save path completed. | Check the list for the new row. |
| `Data updated Successfully` | The existing-item update path completed. | Check the row's **Name** value. |
| `Data Deleted Successfully` | The delete path completed. | Check that the row is no longer in the list. |

## After maintaining transfer reasons

Transfer reasons are one Warehouse configuration reference list. Open the sibling list that
matches the reference data you need; do not treat a sibling list as part of the transfer-reason
rows.

- [Warehouses](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-warehouse-view)
- [Inspection documents](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-warehouse-inspection-documents)
- Base of inspection.
- Inspection checklist
- Stock Withdrawal and Valuation.
- Service Types
