# Product categories

## Product categories

Product categories organise your company's products into a hierarchy. A category
is a named grouping at the top level; a subcategory is a child grouping beneath it.
Use this page to maintain category names and product codes.

| If you need to… | Go to |
|---|---|
| Open the category list | [Find product categories](#find-product-categories) |
| Read the hierarchy and list actions | [Understand the category list](#understand-the-category-list) |
| Add or change a category | [Create or update a category](#create-or-update-a-category) |
| Add a child category | [Create a subcategory](#create-a-subcategory) |
| Remove a category | [Delete a category](#delete-a-category) |
| Narrow or export the list | [Filter or export the list](#filter-or-export-the-list) |
| Resolve a blocked action | [When category maintenance goes wrong](#when-category-maintenance-goes-wrong) |

![The Product Categories list with its toolbar, hierarchy columns, and category rows](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/6904939c9c21ce6614a8c72892dc08df.png)

## Before you start

Product-category maintenance is available to a signed-in user when the route can
authenticate the user and the company's Product Categories subscription is included.
The subscription determines whether the list is available; permissions determine
which maintenance controls appear.

| Before you start | Why it matters |
|---|---|
| Sign in to PAMS | The page requires authenticated access. |
| Have the Product Categories subscription included | The list and its authorization checks are available only with this subscription. |
| Have **New** permission | **New** appears for creating a category. |
| Have Edit permission | **Add New Sub-Category** and **Edit** appear for changing category data. |
| Have Delete permission | The delete control appears for removing a category. |
| Have Export permission | The shared export option is allowed. |

If the subscription is not included, the page displays the subscription-upgrade
component instead of the list.

> **Note:** The list and its maintenance controls appear only when the subscription
> and the permission for the action are available to your account.

## Find product categories

Open the product-category list after signing in.

**Prerequisites**

- You are signed in.
- The Product Categories subscription is included for the company.

**Steps**

1. Open the product-category list.
2. Confirm that the page shows the **Product Categories** screen.
3. Confirm that the category list is present.

The list is the starting point for the maintenance actions in the next sections.

**Result:** The **Product Categories** list is on screen with its available toolbar
and row controls.

![The supported product-category list entry point](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/92a1a457f559c098f4592f8d445b2ca2.png)

## Understand the category list

The list shows a two-level hierarchy: a category can have a subcategory beneath it.
The toolbar contains the following controls when they are available.

| Control | What it does |
|---|---|
| **Apply filter** | Applies the filter settings to the list. |
| **New** | Opens a new category form. |
| **Refresh** | Refreshes the list. |
| **Settings** | Opens the list settings. |

The grid shows **Category** and **Code**. **Category** identifies the category or
subcategory row. **Code** shows the product code. Select a row before using a
row-specific action: **Add New Sub-Category** creates a child beneath it, and
**Edit** opens it for changes. The delete control is available with Delete
permission.

After reviewing the list, use [Create or update a category](#create-or-update-a-category)
for a top-level entry or [Create a subcategory](#create-a-subcategory) for a child entry.

## Create or update a category

Create a category for a new top-level grouping. Update the selected category when
its name or product code needs correction.

**Prerequisites**

- The Product Categories subscription is included.
- You have **New** permission to create a category, or Edit permission to update one.
- You have the category name and product code ready.

**Steps**

1. Choose the action for the entry you want to maintain.

   | If you want to… | Select |
   |---|---|
   | Create a category | **New** |
   | Update an existing category | **Edit** on its row |

2. In the category form, enter the name in **Product category name**.
3. Enter a product code from 1 to 10 characters in **Product code**.
4. Use only the characters accepted by the form's no-special-character pattern in
   both text fields.
5. Select **OK**.

Both fields are required. Missing values use `This Field Is Required`; unsupported
characters use `Just '_'‘-''.' And '&' Characters Accepted`; and a product code over
the allowed length uses `Must have maximum 10 letters`.

**Result:** The category form is submitted. A successful save displays
`Data saved Successfully`.

![The new category form with Product category name, Product code, and OK](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/5e7e4aa49bdbaa6b6463ac0f18b1282a.png)

Continue with [Create a subcategory](#create-a-subcategory) if the hierarchy needs
a child entry, or [Delete a category](#delete-a-category) if an entry must be removed.

## Create a subcategory

Use a subcategory for a more specific grouping beneath an existing category.

**Prerequisites**

- The Product Categories subscription is included.
- You have Edit permission.
- The parent category row is visible in the list.
- You have the subcategory name and product code ready.

**Steps**

1. Select the parent category row.
2. Select **Add New Sub-Category**.
3. Enter the child name in **Sub product category name**.
4. Enter a product code from 1 to 10 characters in **Product code**.
5. Use only the characters accepted by the form's no-special-character pattern in
   both fields.
6. Select **OK**.

The subcategory name and product code are required. The same required-field,
character, and length messages apply: `This Field Is Required`,
`Just '_'‘-''.' And '&' Characters Accepted`, and `Must have maximum 10 letters`.

**Result:** The subcategory form is submitted. A successful save displays
`Data saved Successfully`.

Continue with [Delete a category](#delete-a-category) to remove an entry, or use
[Filter or export the list](#filter-or-export-the-list) to work with the list.

## Delete a category

Deleting removes the selected category through a confirmation path.

**Prerequisites**

- The Product Categories subscription is included.
- You have Delete permission.
- The category row to remove is selected.

**Steps**

1. Open the delete control for the selected category row.
2. Read `Are you sure you want to delete this item?`.
3. Choose what to do in the confirmation menu.

   | If you want to… | Select |
   |---|---|
   | Keep the category | **Cancel** |
   | Remove the selected category | **Delete** |

**Result:** After a successful deletion, the page displays
`Data Deleted Successfully` and the selected category is no longer available in the
list.

Continue with [Filter or export the list](#filter-or-export-the-list) to work with
the remaining rows.

## Filter or export the list

Use the list toolbar to narrow the rows or prepare an export.

**Prerequisites**

- The category list is open.
- You have Export permission for export actions.

**Steps**

1. Open the filter controls from **Apply filter**.
2. Apply the filter settings to the category list.
3. Select **Export**.
4. Choose an export format.

   | Format | Control |
   |---|---|
   | Excel file | **Export to Excel** |
   | PDF file | **Export to PDF** |

The export area can display `Under Development`.

**Result:** The selected filter is applied to the list, or the selected export
choice is ready to run.

Continue with [When category maintenance goes wrong](#when-category-maintenance-goes-wrong)
if a value, permission, subscription, or operation prevents you from continuing.

## When category maintenance goes wrong

Use the message on screen to identify whether the form needs a value, a different
character, or a shorter product code.

| What you see | What it means | What to do |
|---|---|---|
| `This Field Is Required` | A required category or code field is empty. | Enter a value in **Product category name**, **Sub product category name**, or **Product code**, as applicable. |
| `Just '_'‘-''.' And '&' Characters Accepted` | A text value contains an unsupported character. | Replace the character and keep the value within the accepted pattern. |
| `Must have maximum 10 letters` | **Product code** is longer than 10 characters. | Shorten the product code to 10 characters or fewer. |
| `Required Field can not be Empty Spaces` | A required field contains blank spaces instead of usable content. | Replace the spaces with a category name or product code. |
| `Please Enter the Required Field` | The required-field check still needs a value. | Enter the required value, then select **OK** again. |
| The list is replaced by the subscription-upgrade component | The Product Categories subscription is not included. | Ask an administrator to review the company's subscription. |
| A maintenance control is not available | The permission for that action is not granted to your account. | Ask an administrator for the matching New, Edit, Delete, or Export permission. |

If a server error occurs while an operation is processed, keep the category data
unchanged and ask an administrator to review the operation rather than assuming it
was saved.

## What to do next

This screen changes the company's product-category names, hierarchy, and product
codes. It does not represent a business-stage or status transition.

After maintaining category data, continue to the registered **Products** page to use
product data. For related company configuration, open **Product types** or **Item
Categories**.
