Skip to content
D
Documentation

Guarantee types

reference
7 min readUpdated

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 actionsBefore you start
Open the list or start a typeFind a guarantee type
Check the list column and form fieldUnderstand the list and form
Add, change, or remove a typeMaintain guarantee types
Use list toolsHandle permissions and list settings
Resolve an unavailable or unexpected actionWhen 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.

ActionPermission condition
NewCreate permission
Edit button at the end of each rowEdit permission
Delete menuDelete permission
Export menu itemExport permission
Import menu itemImport permission

Continue to 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
  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

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 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.

SurfaceWhat you can expect
Name columnFilterable and not sortable
GuaranteeTypeID data fieldHidden
GuaranteeTypeID action columnFiltering, editing, reordering, searching, sorting, exporting, resizing, and hiding are disabled
Guarantee formAppears after you select a guarantee type
Guarantee fieldThe form label for Name; the label is required
Grid editingUpdating, deleting, and adding are disabled in the grid declaration
Column chooserDisabled
PagingDisabled

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

Continue to 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 settingWhat it does or when it appears
RefreshRefreshes the list
Table LayoutTooltip for the layout button
SettingsTooltip for the settings button
ExportOpens the export-options surface when your account has export permission
ImportAppears when your account has import permission
Filter RowShows or hides the filter row
File pickerAppears 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.

    ControlAction
    RefreshReload the list
    Table LayoutOpen the layout control
    SettingsOpen the settings control
    Filter RowShow or hide the filter row
    ExportOpen the export-options surface
    ImportOpen the import surface
    File pickerSelect 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 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 seeWhat to check next
New is unavailableCheck that your account has create permission.
The Edit button at the end of each row is unavailableCheck that your account has edit permission.
Delete is unavailableCheck that your account has delete permission.
Export or Import is unavailableCheck the corresponding export or import permission.
To display the formSelect a guarantee type.
A save error appearsAsk your administrator to check the returned error.
A delete error appearsAsk your administrator to check the returned error.
The name is rejectedCheck the value in Name.
No success or error alert appearsCheck whether the action completed before repeating it.
A shared popup shows Don't Save, Save, Cancel, No, Yes, Ok, Upload, or BackUse the control only when it appears as part of the Guarantee Types action you started.

After resolving the action, return to Maintain guarantee types or 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.

Was this page helpful?

Need help using the product?