# Attachment categories

Attachment categories is a reference list under **Attachment settings** in
**Configuration**. Use it to maintain the names assigned to attachments.

## Attachment categories

Attachment categories is the reference list where you maintain named categories for
attachments. It sits under **Attachment settings** in the **Configuration** area.

The page currently presents the **Attachment categories** heading, the **Attachment settings**
parent, and the **Configuration** context. It is a reference list rather than
a category lifecycle: the page does not define workflow stages for these entries.

| If you need to… | Go to |
| --- | --- |
| Check the list layout and available fields | [Understand the list and form](#understand-the-list-and-form) |
| Open the list or start a new entry | [Find the attachment categories list](#find-the-attachment-categories-list) |
| Add a category | [Create a category](#create-a-category) |
| Review an existing row | [Review a category](#review-a-category) |
| Change a category name | [Change a category](#change-a-category) |
| Remove a category | [Delete a category](#delete-a-category) |
| Open the shared export action | [Export the list](#export-the-list) |
| Return to configuration navigation | [Configuration](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-home) |
| Continue with sibling reference-list work | [Reference list](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/reference-list-data) |

## Before you start

**Prerequisites**

- Confirm that the Attachment feature is included in your subscription.
- Confirm that **New** is available when the new-entry control is not hidden.
- Confirm that delete permission is available before removing a row.
- Have the category name ready. **Name** is required in the entry form.

| Situation | What you see or can do |
| --- | --- |
| Attachment is included in the subscription | The list, configuration, and actions load. |
| Attachment is excluded from the subscription | A subscription-upgrade surface appears instead of the list. |
| New-entry control is not hidden | **New** is shown. |
| Delete permission is available | The row delete menu is shown. |

After checking these conditions, find the list under **Attachment settings**.

## Find the attachment categories list

Open the Attachment categories reference list from **Attachment settings**.

**Prerequisites**

- The Attachment feature is included in your subscription.

**Steps**

1. Open **Configuration**.
2. Open **Attachment settings**.
3. Select **Attachment categories**.

   ![The Attachment categories entry in Attachment settings and the list it opens](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/966d89a6b974f0114241d0d071611ce3.png)

4. Select **New** to open the new-entry surface.

The new-entry surface is the form titled `New Attachment categories`; it opens without
changing the route.

**Result:** The Attachment categories list or its `New Attachment categories` form is open.

Next, check the column, field, and list controls.

## Understand the list and form

The list identifies each category by **Name**, and the form provides **Name** as the category
field. **Name** is the only visible list column. It accepts filtering, but it does not
support sorting or direct list editing.

| Surface | What is available |
| --- | --- |
| List column | **Name** is the only visible column. |
| List actions | **New**, **Refresh**, and **Settings** are visible. |
| Filtering | **Name** accepts filtering. |
| Sorting and list editing | **Name** does not accept sorting or direct list editing. |
| Form field | **Name** is the only visible form field and is required. |
| Hidden declared fields | `DisplayOrder`, `Id`, and `CompanyID` are not shown in the form. |

![The Name column and visible list controls](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/e0c40ee61c9a7cb17ebdc066f57d5504.png)

Use the maintenance path that matches the change you need:

| If you need to… | Follow |
| --- | --- |
| Add a named entry | [Create a category](#create-a-category) |
| Locate an existing entry | [Review a category](#review-a-category) |
| Remove an entry | [Delete a category](#delete-a-category) |
| Export the list | [Export the list](#export-the-list) |

## Add, review, and remove a category

The form uses **Save** for a new entry. The deletion menu uses **Cancel** and **Delete**.

### Create a category

Create a category when the attachment category name is not already in the list.

**Prerequisites**

- The Attachment feature is included in your subscription.
- **New** is visible.
- You have the category name ready.

**Steps**

1. Select **New** in the Attachment categories list.
2. In `New Attachment categories`, enter a value in **Name**.
3. Select **Save**.

   ![The required Name field on the New Attachment categories surface](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/5964562efe41b8c7ae99bc7cb7d5dd65.png)

If the create operation succeeds, the product message is `Data saved Successfully`.

**Result:** The category name is submitted through **Save**.

### Review a category

Review a category by locating its name in the list.

**Prerequisites**

- The Attachment categories list is open.
- An existing category row is visible.

**Steps**

1. Review the category name in the **Name** column.

**Result:** The existing category is identified in the list.

### Change a category

Change a category when you have edit permission and need to update its **Name**.

**Prerequisites**

- The Attachment categories list is open.
- Edit permission is available.
- The category row is visible.

**Steps**

1. Open the category's edit surface when edit permission is available.
2. Replace the value in **Name** on the edit surface.
3. Select **Save**.

If the update succeeds, the product message is `Data updated Successfully`.

**Result:** The changed **Name** is submitted through **Save**.

### Delete a category

Delete a category only when your account has delete permission and the category is not
needed by saved data.

**Prerequisites**

- The Attachment categories list is open.
- Delete permission is available.
- The deletion menu for the category is open.
- You have checked that removing the category is appropriate.

**Steps**

1. Read the confirmation prompt: `Are you sure you want to delete this item?`.
2. Select **Cancel** to keep the category, or select **Delete** to confirm removal.

The deletion result is shown by one of these product messages:

| Message | Meaning for the action |
| --- | --- |
| `Data Deleted Successfully` | The deletion succeeds. |
| `Related to Saved data, Can't be deleted` | Related saved data blocks deletion. |
| `Failed to Delete` | The deletion fails. |
| `Must have at least one item` | The last remaining item cannot be removed. |

**Result:** The deletion is cancelled or confirmed, and the displayed message identifies
the resulting deletion condition.

### Export the list

Open the shared export path when you need an export of the Attachment categories list.
The list has a shared toolbar with the **Export** action.

**Prerequisites**

- The Attachment categories list is open.
- **Export** is available in the shared toolbar.

**Steps**

1. Open **Export** in the shared toolbar.

**Result:** The shared export action is open.

## Handle surface variations

Use the condition that matches what is on screen:

| Variation | What changes |
| --- | --- |
| Subscription excludes Attachment | The subscription-upgrade surface replaces the list. |
| New is hidden | The **New** action is unavailable. |
| Delete permission is unavailable | The row delete menu is absent. |
| List columns differ | Work from the headers visible in your list. The list layout can build its columns from the current configuration. |
| Entry surface is shared | **Save**, **Cancel**, and other popup controls belong to the shared entry surface; use them only when they are visible. |
| Sibling reference tabs have no title | Do not assign a name to an unlabelled sibling tab. Return to the visible Attachment categories heading or entry. |
| Shared controls concern another entity | Follow the page that owns that entity rather than treating a generic control as Attachment categories maintenance. |

## When maintenance does not work

Use the message on screen to choose the next action.

| What you see | What to do |
| --- | --- |
| `Forbidden characters detected. Please remove them and try again.` | Remove the forbidden characters from **Name**, then select **Save**. |
| Parsed server error text | Read the displayed server error text and correct the value or request the required access. |
| `Related to Saved data, Can't be deleted` | Keep the category and resolve the related saved-data dependency before deleting. |
| `Failed to Delete` | Verify the row, permission, and current data condition before repeating the deletion. |
| `Must have at least one item` | Keep at least one category in the list. |

> **Note:** A successful-operation message confirms that the application accepted the
> maintenance request. Opening the entry surface alone does not confirm that a category was
> saved.

After maintenance, return to [Configuration](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-home) or continue with the
sibling [Reference list](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/reference-list-data) work.

## What to do next

Attachment categories is the entity owned by this page. The shared configuration area
also navigates among sibling reference lists, but their fields and actions belong to
their own pages.

- Return to [Configuration](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-home) to choose another configuration area.
- Continue with the sibling [Reference list](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/reference-list-data) work when you need
  another reference-list entity.
