# User layouts

Use User layouts to find a user's list arrangement, review its settings, and open the
corresponding layout record for maintenance.

## User layouts at a glance

A user layout is the saved arrangement used for a user's list: it identifies the list,
stores the layout text, and carries the column settings. Administrators use this list when
they need to locate a user's arrangement and open its record for the administrator's branch.

| If you need to | Go to |
| --- | --- |
| Find a user's list arrangement | Find the User layouts list |
| Check fields, required rules, and available choices | Understand the list and its fields |
| Open and maintain a layout record | Choose and maintain a layout or the sibling User layout editor page |
| Return to the related configuration area | **Default layouts** in Find the User layouts list |
| Resolve a missing surface or message | Handle unavailable actions and messages |

The list presents user layouts and a user-name field. The editor stores the selected list
number, layout text, and column settings.

![The User layouts heading, related Default layouts link, and list area](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/2066e6e832ecba0345df5d350d1b63cf.png)

## Before you start

**Prerequisites**

- Have access to the Configuration area.
- Have the list layout you want to review selected.
- Have the user's name or other information you need to identify the row.

The list filters and list area appear only after a chosen layout exists. A chosen layout is
therefore needed before the list controls and table are available. Column actions
in the editor require a layout that has columns.

If the page shows `Data Loading Error`, the list does not provide usable rows or visible
columns. Continue only when the list has loaded enough information to identify a row, or
use the message in Handle unavailable actions and messages to diagnose the page.

> **Note:** A layout with no columns has no column edit or delete actions, and its column
> popup fields are not available until you open a column popup.

## Find the User layouts list

Use the User layouts list to locate a user's arrangement before opening the record editor.

**Prerequisites**

- Have access to the Configuration area.

**Steps**

1. Open **Default layouts** in Configuration.
2. Select **Users layouts**.
3. Confirm that the page heading is **Users layouts**.

**Result:** The **Users layouts** list is open.

![The Users layouts page with the Default layouts destination](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/eae413af4c5603f55e95de7746e0a124.png)

## Understand the list and its fields

The list identifies a user layout by list choice and user name; the editor then exposes the
saved layout and its column settings. Use the field tables below to distinguish the list
filters from the editor fields.

### List filters and table

| Surface | What to expect |
| --- | --- |
| Status list | An unlabelled list for the list's status value. |
| User-name field | An unlabelled text box for the user name. |
| List table | Its visible headers come from the chosen list layout. |
| Row control | Select it to open the record when the row is from the same branch. |

The list also provides paging, header filtering, row filtering, grouping, and export
surfaces. The current page can show an icon-only **Refresh** button.
If the list shows `Data Loading Error`, it has no
usable rows or visible list columns to inspect.

![The list area where the chosen layout supplies the visible columns](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/2066e6e832ecba0345df5d350d1b63cf.png)

### Editor fields

| Field | Type | Required | Availability |
| --- | --- | --- | --- |
| **Name** | Text | Yes | Always in the editor; read-only. |
| **List num** | Select | Yes | Always in the editor; read-only. |
| **Layout** | Text area | Yes | Always in the editor. |

When you edit or add a column, the popup provides these fields:

| Field | Type | Required | Rule |
| --- | --- | --- | --- |
| **Index** | Text | Yes | Read-only in the popup. |
| **Visible** | Boolean | No | Available in the column popup. |
| **Field** | Text | Yes | Available in the column popup. |
| **Type** | Select | Yes | Available in the column popup. |
| **Caption** | Text | No | Available in the column popup. |
| **Width** | Number | No | Minimum value is `0`. |
| **Filter value** | Text | No | Available in the column popup. |
| **Selected filter operation** | Select | Yes | Available in the column popup. |

Column popup fields appear only while the column-edit or add-column popup is open.

### Available options

The **List num** list provides the following values:

| Value | ID |
| --- | ---: |
| Activities (0) | 0 |
| Tasks (1) | 1 |
| Contract (2) | 2 |
| Registeration data (3) | 3 |
| Ticket - Running (4) | 4 |
| Ticket - Closed (5) | 5 |
| Layouts (6) | 6 |
| Pricing indicator (7) | 7 |
| Project (21) | 21 |
| Clients (22) | 22 |
| Principals (23) | 23 |
| Roles (26) | 26 |
| Users (27) | 27 |
| Account (29) | 29 |
| Contact (30) | 30 |
| Invoices all (31) | 31 |
| Payment (32) | 32 |
| Sales Leads(39) | 39 |
| Sales All(40) | 40 |
| Sales Inquiries (41) | 41 |
| Sales Offers (42) | 42 |
| Sales Orders (43) | 43 |
| Sales Delivered (44) | 44 |
| Sales Lost offer (45) | 45 |
| Sales Regretted (46) | 46 |
| Sales Deleted (48) | 48 |
| Sales Rejected orders (49) | 49 |
| Sales Missed Inquiries (50) | 50 |
| Sales Cancelled offer (51) | 51 |
| Sales Cancelled order (52) | 52 |
| Buyout All (53) | 53 |
| Buyout RFQ (54) | 54 |
| Buyout Offer (55) | 55 |
| Buyout Order (56) | 56 |
| Buyout Delivered (57) | 57 |
| Buyout Rejected offer (58) | 58 |
| Buyout Regretted (59) | 59 |
| Buyout Deleted (61) | 61 |
| Buyout Rejected order(62) | 62 |
| Buyout Cancelled offers (64) | 64 |
| Buyout Cancelled order (65) | 65 |
| Principal invoice (67) | 67 |
| teams (70) | 70 |
| Account managers (71) | 71 |
| Subscription Invoices (72) | 72 |
| Letter of guarantees all (73) | 73 |
| Products (74) | 74 |
| MRQ (75) | 75 |
| Procurement All (76) | 76 |
| Procurement RFQ (77) | 77 |
| Procurement Offer (78) | 78 |
| Procurement Order (79) | 79 |
| Procurement Delivered (80) | 80 |
| Procurement Rejected (81) | 81 |
| Procurement Regretted (82) | 82 |
| Procurement Deleted (83) | 83 |
| Procurement Rejected order (84) | 84 |
| Procurement Cancelled offers (85) | 85 |
| Procurement Cancelled orders (86) | 86 |
| Extension rejected offer (89) | 89 |
| Warehouse configuration (91) | 91 |
| Receiving shipment (92) | 92 |
| Inspection (93) | 93 |
| PM All (94) | 94 |
| PM Planned To Order (BOM) (95) | 95 |
| PM Ready To Order (MRQ) (96) | 96 |
| PM In Procurement All (97) | 97 |
| PM In Procurement Inquiry (98) | 98 |
| PM In Procurement Offer (99) | 99 |
| PM In Procurement Order (100) | 100 |
| PM In Procurement Stuck (101) | 101 |
| PM Products Receipt (102) | 102 |
| PM Product Rejected (103) | 103 |
| PM Stored (104) | 104 |
| PM Assembly (105) | 105 |
| PM Loss (106) | 106 |
| PM Ready For Shipment (107) | 107 |
| PM Delivered (108) | 108 |
| Stock (109) | 109 |
| Packages (110) | 110 |
| upcoming stock (111) | 111 |
| Production order (112) | 112 |
| Shipping order (113) | 113 |
| Issue goods note (114) | 114 |
| External service order (115) | 115 |
| Transfer order (116) | 116 |
| Return note (117) | 117 |
| Delivery note (118) | 118 |
| PM orders (119) | 119 |
| In-warehouse all (120) | 120 |
| PM Delivered orders (121) | 121 |
| Reference list by serial num. (122) | 122 |
| Job Profitabilty (123) | 123 |
| Job Cost Transaction (124) | 124 |
| Purchase Invoice (125) | 125 |
| Outgoing Paymnet (126) | 126 |

The **Type** list provides `string`, `number`, `date`, and `boolean`. The **Selected
filter operation** list provides these choices:

| Option |
| --- |
| `contains` |
| `Does not contain` |
| `Starts with` |
| `Ends with` |
| `Equals` |
| `Not equals` |

## Choose and maintain a layout

Use this procedure to move from a loaded list row to the layout record, review the text,
and maintain its columns. The available editor actions change what is stored in the layout
text and the parsed column settings.

**Prerequisites**

- Have a loaded User layouts list.
- Have a row from the administrator's branch.
- Have a layout with columns before using column edit or delete actions.

**Steps**

1. In a row from the administrator's branch, select the row control to open the layout record.
2. Select the editor action that matches your maintenance task.

   | If you need to | Select | Result |
   | --- | --- | --- |
   | Reload the record | **Recall** | The layout record is reloaded. |
   | Convert the layout text into the parsed layout | **Parse** | The parsed user layout is updated from the layout text. |
   | Copy parsed columns into the layout text | **Stringfy** | The layout text receives the parsed columns. |
   | Remove duplicate or non-default columns | **Clean user layout** | Duplicate or non-default columns are removed. |
   | Add missing default columns and align their type, caption, width, and index | **Update user layout** | Missing default columns are added and their settings are aligned. |

3. For a column, select the action that matches your task.

   | If you need to | Select | Result |
   | --- | --- | --- |
   | Review or change column details | The column edit control | The column details dialog opens. |
   | Remove a column | The column delete control | The **Delete column** confirmation dialog opens. |

4. Select **Save** to keep the editor open after saving, or select **Save and Close** to
   save and leave the editor.

**Result:** **Save** keeps the layout record open. **Save and Close** saves the layout and
leaves the editor.

![The row edit entry point for a user layout](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/2066e6e832ecba0345df5d350d1b63cf.png)

### If you selected **Save New Layout**

The available editor actions are **Save** and **Save and Close**. Use those named actions
for the layout record; no instruction for a control named **Save New Layout** is provided
on this page.

**Prerequisites**

- Have the layout record open.

**Steps**

1. Select **Save** or **Save and Close** according to whether you want to remain in the
   editor.

**Result:** The selected named save action is submitted. No approval step is specified
for saving.

### If you selected **Delete Current**

The column delete path begins with the delete icon when the layout has columns. It opens a
confirmation popup with the message `Are you sure?`.

**Prerequisites**

- Have the layout record open.
- Have a layout with at least one column.

**Steps**

1. Select the delete icon for the column you want to remove.
2. Read the confirmation message `Are you sure?`.
3. Select **No** to cancel the deletion.
4. Select **Yes** to remove the column.

**Result:** The **Delete column** confirmation popup remains open until you choose **No** or
**Yes**. Select **No** to cancel the deletion. Select **Yes** to remove the column; the popup
closes and the parsed user layout is updated.

### Delete a column

The column delete path begins with the column delete control when the layout has columns. It
opens a confirmation dialog titled **Delete column** with the exact message `Are you sure?`.

**Prerequisites**

- Have the layout record open.
- Have a layout with at least one column.

**Steps**

1. Select the column delete control for the column you want to remove.
2. Read the confirmation message `Are you sure?`.
3. Select **No** to keep the column.
4. Select **Yes** to remove the column.

**Result:** **No** closes the confirmation dialog without changing the column. **Yes** removes
the column from the parsed user layout and closes the confirmation dialog.

## Adjust the display and export the list

The User layouts list provides display features separate from layout-record editing:
paging, header filtering, row filtering, grouping, and export. The list can also
show an icon-only **Refresh** button.

**Prerequisites**

- Have a loaded User layouts list.

**Steps**

1. Use the available list surface that matches your task.

   | If you need to | Use |
   | --- | --- |
   | Move between pages | Paging |
   | Narrow values in a column | Header filtering |
   | Narrow rows | Row filtering |
   | Arrange rows by a value | Grouping |

2. Select **Export** to start the list export flow.

**Result:** The selected list display surface is active, or the export dialog opens with
**Export** and **Cancel**.

### If you selected **Filter Row**

Row filtering is a list surface. The filter controls appear only when a chosen layout
exists.

**Prerequisites**

- Have a chosen layout and a loaded list.

**Steps**

1. Look for the **Filter by:** control on the list.
2. If **Filter by:** appears, use it to narrow the list rows.

**Result:** The filter-row surface is available when a chosen list layout exists. If
**Filter by:** does not appear, no row-filter action is available.

### If you selected **Group Panel**

Grouping is a list surface for a loaded list.

**Prerequisites**

- Have a loaded list with rows and columns.

**Steps**

1. Open the grouping surface on the list.
2. Choose the grouping arrangement from the available list surface.

**Result:** The grouping surface is available for a loaded list. A list that shows
`Data Loading Error` has no loaded rows or columns with which to demonstrate grouping.

### If you selected **Export** to start an export

Use **Export** on the list to start the export flow.

**Prerequisites**

- Have a loaded User layouts list.

**Steps**

1. Select **Export** on the list.

**Result:** The export choices are requested. The export dialog has the actions **Export**
and **Cancel**.

### If you selected **Export** to close the choices

The export dialog displays **Exporting List:**, offers **Export to Excel** and **Export to PDF**,
and provides **Cancel** and **Export**.

**Prerequisites**

- Have the export dialog open.

**Steps**

1. Select **Cancel** to use the dialog's cancel choice.
2. Select **Export** to use the dialog's export choice.

**Result:** Select **Cancel** to close the export dialog without exporting. Select **Export**
to export the list in the selected format. If the list has no data, the page displays
`NO Data to Export` instead.

## Handle unavailable actions and messages

List features depend on the current layout and which popup is open. Use the condition table to
match an unavailable action to the state that controls it.

| If you see | Condition | What to do |
| --- | --- | --- |
| No list filters or list area | No chosen list layout exists. | Select a layout before expecting list controls or a list table. |
| No column edit or delete controls | The layout has no columns. | Open or prepare a layout that has columns. |
| No column popup fields | The column-edit or add-column popup is not open. | Open the appropriate column popup. |
| `Data Loading Error` | The list failed to load usable rows or columns. | Wait for a usable list before filtering, grouping, or exporting. |
| `This Field Is Required` | A required field is empty. | Complete the required field and submit the editor action again. |
| `Your request was completed successfully` | The editor reports a successful request. | Continue with the next editor action or close the record. |
| `An error occurred while processing your request` | A save or load request reports an error. | Review the record and request again when the page is available. |

The list's accounts lookup can show `Error loading accounts`. While `Data Loading Error`
is present, the list has no usable rows or visible list columns.

### Messages

| Message | When it appears |
| --- | --- |
| `This Field Is Required` | A required editor field is empty. |
| `Your request was completed successfully` | The editor reports a successful request. |
| `An error occurred while processing your request` | A save or load request reports an error. |
| `Are you sure?` | The **Delete column** confirmation dialog opens. |
| `Error loading accounts` | The accounts lookup in the list filter reports an error. |
| `Data Loading Error` | The list fails to load usable data. |

## What to do next

After reviewing the list, select the row control to open the user-layout record for maintenance. Select
**Default layouts** to return to the related configuration area.
