# Edit user layout

## What a user layout is

A user layout is the saved definition of the columns used by a product list. Use
**Layout** to maintain that definition and its columns. Filtering and exporting belong
on the [User layouts](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-users-layouts-view) page.

| If you need to… | Go to |
| --- | --- |
| Open an existing layout | [User layouts](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-users-layouts-view) |
| Review the saved fields and status flags | [Record and layout fields](#record-and-layout-fields) |
| Compare the user layout with the default layout | [Parsed layout areas](#parsed-layout-areas) |
| Parse or reconcile the saved layout text | [Maintain the layout text and compare defaults](#maintain-the-layout-text-and-compare-defaults) |
| Add, edit, or remove a layout column | [Maintain layout columns](#maintain-layout-columns) |
| Maintain default layouts | [Default layouts](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-default-layouts) |

## Before you start

Open an existing user-layout record before maintenance begins. You need a live account
and an existing record.

## Find and open the layout

The **Users layouts** page is the list entry point for opening a saved user-layout
record. The list page text includes **Configuration**, **Default layouts**, **Users
layouts**, and **Tickets**.

**Prerequisites**

- You are signed in with access to the **Users layouts** list.
- A saved layout record is available in the list.

**Steps**

1. Open **Users layouts** from the configuration area.
2. Locate the saved layout record.
3. In that record's row, select the available edit action.

The edit action is available for records in the same branch as the account.

**Result:** The selected record opens on the **Edit user layout** page when its row has
the edit action.

## Understand the edit surface

The edit surface combines the record area, the saved layout text, two layout grids, and
column actions. The user layout grid helps you inspect the columns in the saved
definition. The default layout grid provides the comparison and reconciliation area.
Use the column controls to change a selected column. Confirm before removing a column.

| Surface | Reader job |
| --- | --- |
| Record area | Review the layout identity and status flags. |
| Layout text | Read or change the required **Layout** text. |
| Parsed user layout | Inspect and maintain the columns represented by the saved layout. |
| Parsed default layout | Compare the saved columns with the default columns and reconcile them. |
| Column settings | Change one selected column. |
| Deletion prompt | Confirm before removing the selected column. |

### Record and layout fields

The record fields identify the saved layout and supply its layout text. Identity fields
identify the saved layout; status fields show its state. Both groups are disabled.
**Layout** is the required text area used for layout maintenance.

| Field | Type | Required | Availability |
| --- | --- | --- | --- |
| **Name** | Text | Yes | Disabled |
| **List num** | Select | Yes | Disabled |
| **Is current** | Boolean | No | Disabled |
| **Is standard** | Boolean | No | Disabled |
| **Layout** | Text area | Yes | Used for layout text maintenance |

### List choices

The disabled **List num** field displays these choices. The column editor uses the
data-type and filter-operation choices shown after it.

| **List num** option | 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 |

For a column's **Type**, the editor offers `string`, `number`, `date`, and `boolean` as
the product's column data types. For **Selected filter operation**, it offers `contains`,
`Does not contain`, `Starts with`, `Ends with`, `Equals`, and `Not equals` as product
filter operations.

### Parsed layout areas

The user layout grid appears when it contains layout columns. It has the following
columns.

| Parsed user layout columns |
| --- |
| **Index**, **Field**, **Type**, **Caption**, **Visible**, **Width** |

The default layout grid appears when it contains layout columns. It has **Index**,
**Field**, **Type**, **Caption**, and **Visible**. The grid does not include a column for
numbering rows.

### Column editor fields and choices

The new-column and edit-column popup contains the following fields.

| Field or control | Type | Required | Rule or choice |
| --- | --- | --- | --- |
| Column text area | Text area | Yes | Required |
| **Index** | Text | Yes | Disabled |
| **Visible** | Boolean | No | Optional |
| **Field** | Text | Yes | Required |
| **Type** | Select | Yes | Required; use the four product data types above |
| **Caption** | Text | No | Optional |
| **Width** | Number | No | Optional; minimum `0` |
| **Filter value** | Text | No | Optional |
| **Selected filter operation** | Select | Yes | Required; use the six product filter operations above |

## Maintain the layout text and compare defaults

Use this section when the saved layout text needs to be inspected or reconciled with the
default layout. The two grids give you a row-based view of the layout; **Layout** remains
the saved text area.

**Prerequisites**

- You have opened an existing layout record.
- The **Layout** field contains the layout text you need to review.

**Steps**

1. Select **Parse** to display the **Layout** columns in the user layout grid.
2. Review the user layout columns.
3. Select **Stringfy** to copy the user layout grid back into **Layout**.
4. In the default layout area, select **Clean user layout** to remove duplicate
   or unmatched user columns.
5. Select **Update user layout** to add missing default columns and update matching
   column metadata.
6. Review the two layout grids again.

**Result:** **Layout** contains the user layout grid after **Stringfy**. The comparison
actions clean or update the user columns according to the selected action.

## Maintain layout columns

Use the column actions when a layout needs a new column, a change to a selected column,
or removal of a selected column.

**Prerequisites**

- You have opened a parsed user or default-layout grid.
- You know which row and column property you need to maintain.

**Steps**

1. Select the row's **Edit column** action to open the column editor.
2. In the column editor, enter or choose the required values.
3. Select **Save** in the column editor.
4. To remove a selected column, select its **Delete column** action and choose an
   outcome at `Are you sure?`.

   | If you need to… | Select |
   | --- | --- |
   | Keep the column | **No** |
   | Confirm removal | **Yes** |

**Result:** The updated column appears in the layout, or the column is removed.

## When maintenance goes wrong

Use the message text to match the problem to the action you just took.

| What you see | Condition or action |
| --- | --- |
| `This Field Is Required` | A required field has no value. Check **Layout** or the required column-editor fields. |
| `Your request was completed successfully` | The save request reports success. |
| `An error occurred while processing your request` | The request reports an error. |
| `Are you sure?` | A delete-column confirmation is open. Choose **No** or **Yes**. |

**Save** and **Save and Close** are available after a change. **Close** opens the exit
choices when changes exist and leaves directly when there are no changes.

## What to do next

When the layout is ready, choose the outcome that matches your next task.

**Prerequisites**

- You have finished reviewing the layout and its columns.
- You know whether the current changes must be saved.

**Steps**

1. Choose one outcome.

   | If you need to… | Select |
   | --- | --- |
   | Save the layout and remain on the page | **Save** |
   | Save the layout and leave the page | **Save and Close** |
   | Attempt to leave the page | **Close** |

2. If the exit popup appears after **Close**, choose an exit outcome.

   | If you need to… | Select |
   | --- | --- |
   | Leave without saving | **Don't Save** |
   | Keep the changes and close the popup | **Cancel** |

**Result:** **Save** saves the layout and keeps you on the page. **Save and Close** saves
the layout and leaves the page. **Close** attempts to leave the page. After a successful
save, the message is `Your request was completed successfully`.

Continue with [User layouts](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-users-layouts-view), [Default layouts](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-default-layouts),
or the related default-layout configuration.
