# Guarantee types

Maintain the guarantee types that sales staff select when they record a requested guarantee on a
sales record.

## Guarantee types at a glance

A guarantee type is a named option in the guarantee-type list. Each type has a required name.
Administrators maintain this list before sales staff record a requested guarantee.

The job-guarantee record keeps a reference to the selected guarantee type, so adding a type first
gives sales staff an option to select when they record the request.

| If you need to… | Go to |
|---|---|
| Check access and permitted actions | [Before you start](#before-you-start) |
| Open the list or start a type | [Find a guarantee type](#find-a-guarantee-type) |
| Check the list column and form field | [Understand the list and form](#understand-the-list-and-form) |
| Add, change, or remove a type | [Maintain guarantee types](#maintain-guarantee-types) |
| Use list tools | [Handle permissions and list settings](#handle-permissions-and-list-settings) |
| Resolve an unavailable or unexpected action | [When an action does not work](#when-an-action-does-not-work) |

## Before you start

Open the **Guarantee Types** page from the configuration area. The actions available to you depend
on your permissions.

| Action | Permission condition |
|---|---|
| **New** | Create permission |
| Edit button at the end of each row | Edit permission |
| Delete menu | Delete permission |
| **Export** menu item | Export permission |
| **Import** menu item | Import permission |

Continue to [Find a guarantee type](#find-a-guarantee-type) when you know whether you are locating
an existing type or adding one.

## Find a guarantee type

The **Guarantee Types** page is the list where you locate an existing type or open a new guarantee
type surface.

**Prerequisites**

- You can open the configuration area.
- You know whether you are locating an existing type or adding one.

**Steps**

1. Open the **Guarantee Types** page from the configuration area.
2. Confirm that the page title is **Guarantee Types**.

   ![The Guarantee Types page with the list and page title](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/f707db293010a0aa1e18c1591a885845.png)

3. To locate a type, enter a search term in **Keyword to Search...**.
4. To start a type, select **New**.

   ![The new guarantee type surface opened from the list](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/2bbbcabd54818a58351849699df253b6.png)

The new surface opens without changing pages. The list displays a **Name** column. Any displayed
row count and **Count** value are transient list data and can change.

**Result:** You are on the Guarantee Types list with a row to work on, or the new guarantee type
surface is open at the same route.

Continue to [Understand the list and form](#understand-the-list-and-form) to identify the fields
before maintaining a type.

## Understand the list and form

The list identifies each guarantee type by **Name**. After you select a guarantee type, the form
uses **Guarantee** as the label for that value.

| Surface | What you can expect |
|---|---|
| **Name** column | Filterable and not sortable |
| `GuaranteeTypeID` data field | Hidden |
| `GuaranteeTypeID` action column | Filtering, editing, reordering, searching, sorting, exporting, resizing, and hiding are disabled |
| Guarantee form | Appears after you select a guarantee type |
| **Guarantee** field | The form label for **Name**; the label is required |
| Grid editing | Updating, deleting, and adding are disabled in the grid declaration |
| Column chooser | Disabled |
| Paging | Disabled |

The new surface displays a required marker beside **Name**. Its visible action is **OK**; **Save**
and **Cancel** do not appear on that surface.

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

Continue to [Maintain guarantee types](#maintain-guarantee-types) when you are ready to add,
change, or remove a type.

## Maintain guarantee types

### Create a guarantee type

Add a type when the list does not contain the needed name.

**Prerequisites**

- You have permission for **New**.
- You have the name to enter in the required **Name** field.

**Steps**

1. On the Guarantee Types page, select **New**.
2. In the new surface, enter the type name in **Name**.
3. Confirm that the required marker remains satisfied for **Name**.
4. Select **OK**.

When the save succeeds, the alert is `Data saved Successfully`.

**Result:** The new guarantee type is ready for the Guarantee Types list after a successful save
alert.

### Edit a guarantee type

Change an existing guarantee type when its name needs updating.

**Prerequisites**

- An existing row is visible in the Guarantee Types list.
- You have edit permission.

**Steps**

1. Locate the row you want to change in the **Name** column.
2. Select the Edit button at the end of each row for the row you want to change.
3. Change the value in **Guarantee**.
4. Select the committing action shown on the edit surface.

The Edit button at the end of each row appears when your account has edit permission. If the
**Name** control is disabled, you cannot change the value.

**Result:** The selected guarantee type is open in its edit surface.

### Delete a guarantee type

Delete an existing guarantee type when it is no longer needed and your organisation permits its
removal.

**Prerequisites**

- The row to remove is visible in the Guarantee Types list.
- You have permission for the **Delete** menu.

**Steps**

1. Open the row's action menu.
2. Select **Delete**.
3. Read the confirmation prompt: `Are you sure you want to delete this item?`.
4. In the prompt, select **Delete**.

When deletion succeeds, the alert is `Data Deleted Successfully`.

**Result:** The delete operation has been submitted, with the success alert confirming completion
when it appears.

## Handle permissions and list settings

The list tools refresh the rows, change the list view, filter the rows, and open import or export
surfaces when your permissions allow them.

| Control or setting | What it does or when it appears |
|---|---|
| **Refresh** | Refreshes the list |
| **Table Layout** | Tooltip for the layout button |
| **Settings** | Tooltip for the settings button |
| **Export** | Opens the export-options surface when your account has export permission |
| **Import** | Appears when your account has import permission |
| **Filter Row** | Shows or hides the filter row |
| File picker | Appears beneath the import instructions in the import popup |

**Prerequisites**

- You are on the Guarantee Types list.
- For **Export** or **Import**, your account has the corresponding permission.

**Steps**

1. Select one of the controls in the table below.

   | Control | Action |
   |---|---|
   | **Refresh** | Reload the list |
   | **Table Layout** | Open the layout control |
   | **Settings** | Open the settings control |
   | **Filter Row** | Show or hide the filter row |
   | **Export** | Open the export-options surface |
   | **Import** | Open the import surface |
   | File picker | Select the file picker beneath the import instructions |

    After **Refresh**, the tooltip reads `Updated around a minute ago` or the dynamic message
    `Updated ` followed by minutes and ` minutes ago`.

**Result:** The selected list setting or permitted import/export surface is on screen.

Continue to [When an action does not work](#when-an-action-does-not-work) if the selected action
does not produce the expected surface.

## When an action does not work

Use these checks when an action is unavailable or its result differs from the expected surface.

| What you see | What to check next |
|---|---|
| **New** is unavailable | Check that your account has create permission. |
| The Edit button at the end of each row is unavailable | Check that your account has edit permission. |
| **Delete** is unavailable | Check that your account has delete permission. |
| **Export** or **Import** is unavailable | Check the corresponding export or import permission. |
| To display the form | Select a guarantee type. |
| A save error appears | Ask your administrator to check the returned error. |
| A delete error appears | Ask your administrator to check the returned error. |
| The name is rejected | Check the value in **Name**. |
| No success or error alert appears | Check whether the action completed before repeating it. |
| A shared popup shows **Don't Save**, **Save**, **Cancel**, **No**, **Yes**, **Ok**, **Upload**, or **Back** | Use the control only when it appears as part of the Guarantee Types action you started. |

After resolving the action, return to [Maintain guarantee types](#maintain-guarantee-types) or
continue with [related configuration](#continue-with-related-configuration).

## Continue with related configuration

The guarantee type is reference data for the sales-record workflow: job-guarantee records keep a
reference to the selected type. Add the type before sales staff record the requested guarantee.

For the next sales-record task, continue with the Sales job contacts, guarantees, and history
page. For other configuration areas, return to Configuration home.
