# Users

Users is the administration surface for company-user records. Use it to find a record, review its
information areas, or choose a path for creating a company user or a principal user.

## Users overview

The Users list is the starting point: it shows company-user rows and opens the company-user form
when you select a record. The form is the record screen for identity, contact, responsibility,
branch, warehouse, and approval-limit information.

The list also provides **New company user**. Use the separate pages for principal-user
administration, roles, teams, attached-file management, and the shared files workspace unless a
Users action opens a shared surface.

| If you need to… | Go to |
| --- | --- |
| Find a company-user record or start a user task | [Find and open a user](#find-and-open-a-user) |
| Read the identity, contact, branch, warehouse, and approval areas | [Understand the user screen](#understand-the-user-screen) |
| Review the areas on an editable saved user | [Review the administration areas](#review-the-administration-areas) |
| Review or change user information | [Review or update user information](#review-or-update-user-information) |
| Create a company user | [Create a user](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/create-user) |
| Administer principal users | Principal users |
| Administer roles or teams | Roles or Teams |
| Manage attached files and libraries | [Libraries](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/libraries-files) |

![The Users list with its create actions, visible rows, and list controls](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/6cb206b08a1a45dc4ef762ca292bd209.png)

## Before you start

Users administration requires a signed-in account for both the Users list and the company-user
form. Leaving the edit form with unsaved changes is protected, so keep the information ready
before you begin a change.

| Before you start | Why it matters |
| --- | --- |
| Signed-in access | Both Users screens use signed-in access. |
| New-user access | **New company user** and **New principal user** require new-user access. |
| Available subscription count | The two create actions also require an available subscription count. |
| Existing-user edit access | Existing users use the edit permission for the form. |
| Selected layout and delete access | **Delete** is available only when a layout is selected and the account has delete access. |
| Required information | **Login Email**, **First Name**, **Last Name**, **Display Name**, and **Mobile** are required on the new-user form. |

New-user access and existing-user edit access are separate conditions. A user who can open the
list may therefore see a different set of actions from a user who can create or edit records.

Use these access conditions when you open the list and choose a path.

## Find and open a user

The Users list is the row-and-layout view of company users. Use it to inspect the selected layout,
open an existing company-user record, start a new company-user record, or choose the separate
principal-user creation path.

**Prerequisites**

- You are signed in.
- Your account has the access needed for the action you plan to take.

**Steps**

1. Open the Users list from the security administration area.
2. Review the rows and paging controls in the Users list.
3. Read the visible headers in order: **Full name**, **Display name**, **Active**, and **Email**.

   ![The Users list with the visible column order and paging controls](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/350084aeea966966b6531a41028b736e.png)

4. Select a user row to open its company-user record.
5. Choose the path that matches your task.

   | If you need to… | Select |
   | --- | --- |
   | Start a company-user record | **New company user** |
   | Start a principal-user record | **New principal user** |
   | Remove the selected user | **Delete**, when a layout is selected and delete access is available |

6. Select **Export** to open the export action.

**Result:** The Users list is open after loading. You either have an existing company-user record
open, have opened the company-user creation form, have opened the principal-user creation path, or
have opened the export action.

Use the open form to identify the information areas and controls available for the selected record.

## Understand the user screen

The company-user screen groups information by what it controls: the user's identity and contact
details, responsibility choices, branch and warehouse access, and approval amounts. The new-user
form shows **Save**, **Save and Close**, **User Information**, **User Roles**, **Branches**,
**Inventory**, and **Approval Limit**.

| Area or control | What to review |
| --- | --- |
| **User Information** | Login, identity, contact, and account fields. |
| **Login Email** | The user's login email; required on the new-user form. |
| **Position** and **Title** | The user's position and title. |
| **First Name**, **Middle Name**, **Last Name**, and **Display Name** | The user's displayed identity; **First Name**, **Last Name**, and **Display Name** are required on the new-user form. |
| **Cloud Account** and **Mobile** | The cloud account and mobile contact; **Mobile** is required on the new-user form. |
| **Responsible** and **Active** | Select department responsibilities and set whether the user is active. |
| Branch selection and **Accessible branches** | The company branch and the branches the user can access. |
| **Warehouse** | The warehouse choice when warehouse choices are available. |
| Approval amounts and **Unlimited** | A limit amount or the corresponding unlimited choice for sales, LGs, purchasing, and invoicing. |

On the list, **Refresh**, **Table Layout**, and **Settings** are available as list controls. The
headers you see are the headers for the selected layout; use the visible headers rather than
assuming that every Users installation uses the same column set.

![The new-user form with its information areas, fields, and required markers](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/658fbc7dbd020fb12f6d1a1d24191f75.png)

### Review the administration areas

An editable saved user can expose several administration areas. They separate ordinary user
information from role, branch, inventory, approval, and audit information.

| Area | What it contains |
| --- | --- |
| **User Information** | Contact and account fields. |
| **User Roles** | Role choices when edit access is granted. |
| **Branches** and **Inventory** | Branch selection, accessible branches, and conditional warehouse choices. |
| **Approval Limit** | Sales, LGs, purchasing, and invoicing limits. |
| **Last Modifications** | The audit-log tab for an existing saved user. |

**Last Modifications** appears only for a saved user. Role and approval areas are edit-only areas,
so their availability depends on edit access and the record state.

Use these areas when you review or update the user information.

## Review or update user information

Review or change company-user information as follows. To create and save a new company-user record,
use [Create a user](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/create-user).

**Prerequisites**

- You are on a company-user form.
- For an existing user, you have edit access.
- You have the required identity and contact information.

**Steps**

1. In **User Information**, review or enter **Login Email**, **First Name**, **Last Name**,
   **Display Name**, and **Mobile**.
2. Review or enter **Position**, **Title**, **Middle Name**, and **Cloud Account**.
3. Review **Responsible** and select one or more visible department responsibilities.

   Select one of the visible choices listed below.

   | Responsibility choice | Value |
   | --- | --- |
   | **Procurement responsible** | Select Procurement responsible. |
   | **PM responsible** | Select PM responsible. |
   | **Warehouse responsible** | Select Warehouse responsible. |
   | **Top management** | Select Top management. |
   | **Quality control** | Select Quality control. |

4. Review **Active** and select the appropriate company branch.
5. Review **Accessible branches** and choose from the branch choices returned for the company.
6. If warehouse choices are available, review **Warehouse** and choose the appropriate
   warehouse.
7. Review each approval area and either enter an amount of at least `0` or select its matching
   **Unlimited** choice.
8. Choose the save action that matches what you want to do.

   | If you need to… | Select |
   | --- | --- |
   | Validate and save while staying on the form | **Save** |
   | Validate and request leaving the form | **Save and Close** |

**Result:** The selected save action validates the form first. **Save** keeps the form open when you
choose to remain on the form. **Save and Close** requests leaving the form. The available validation,
success, or error message identifies the next result to handle.

If the form differs from these steps, check the screen variations before troubleshooting a message.

## Handle user-screen variations

The company-user screen changes with available choices, input context, edit access, and whether the
user is an existing editable user.
Use the controls that are present on your screen and use the owning page for a neighbouring
administration surface.

| Variation | What you see |
| --- | --- |
| Warehouse data | **Warehouse** appears when warehouse choices are loaded. |
| Input context | **Accessible branches** is read-only when the form opens through an input context. |
| Edit access | **User Roles** and **Approval Limit** are edit-only areas. |
| Password blocks | **Password** and **Repeat Password** are not shown on this form. |
| Two-factor area | The **2-factor Authentication** tab is not shown on this form. |
| Existing editable user | **Resent mail password** is a developer-only action. |
| List columns | The selected layout supplies the column set, so the headers are a layout choice rather than a fixed list. |
| Subscription limit | The upgrade dialog belongs to the separate subscription surface. |

The controls shown depend on the conditions in the table, including whether warehouse choices load,
whether the form opens through an input context, and whether edit or developer access is available.

For an existing editable user, if **Resent mail password** is available, select it. The action
reports `An e-mail was sent to <email>`.

Use the message text next when a user-administration action is interrupted.

## When user administration goes wrong

Use the message text to identify the type of interruption. The messages below belong to validation,
filtering, save, delete, and password conditions in the Users area.

| What you see | What to do |
| --- | --- |
| `This Field Is Required` | Enter the missing required value, including **Login Email**, **First Name**, **Last Name**, **Display Name**, or **Mobile** where it applies. |
| `Email is invalid` | Correct the email value. |
| `Just '_' '-' And '.' Characters Accepted` | Correct the value so it uses the accepted characters. |
| `Password is too short` | Enter a longer password when the password block is available. |
| `You must use a combination of letters, numbers and special characters in your password` | Enter a password that combines letters, numbers, and special characters when the password block is available. |
| `Password does not match` | Make **Password** and **Repeat Password** match when those controls are available. |
| `Check required field(s)` | Review the required fields before selecting a save action again. |
| `Forbidden characters detected. Please remove them and try again.` | Remove the forbidden characters from the list filter. |
| `Error: Please check the required fields and try again.` | Review the required fields and correct them before saving again. |
| `Error: This Email or User Name Already Exists` | Use a different email or user name. |
| `Error: Please fill in all required fields (e.g., Department)` | Complete the required fields, including the field identified by the message. |
| `Error: Server Error` | Retry the action after checking the form values. |
| `Data Deleted Successfully` | The delete action reports success. |
| `You can not delete yourself` | Select a different user; the signed-in account cannot be deleted. |
| `Data saved Successfully` | The save action reports success. |
| `Data saved Successfully .. An E-Mail was sent to this User` | The save action reports success and the message reports that an email was sent. |
| `Data saved Successfully .. This User Password has been Changed .. Please check E-Mail` | The save action reports success and the message directs you to check email after a password change. |
| `An e-mail was sent to &lt;email&gt;` | The resend action reports that an email was sent to the displayed address. |

Leaving the form with unsaved changes is protected.

For subjects outside the Users form, continue with the separate administration surface.

## Out of scope

Use the following shared or neighbouring administration surfaces for these subjects:

| Separate subject | Continue with |
| --- | --- |
| Attached-file upload, download, linking, renaming, tagging, and library management | [Libraries](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/libraries-files) |
| Log-history filter controls and registration details | The **Last Modifications** area on the saved user, then its owning history surface |
| Subscription upgrade dialog | The subscription surface |
| Principal-user administration | Principal users |
| Roles and teams administration | Roles or Teams |
| Files-workspace success message `Your request was completed successfully` | [Libraries](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/libraries-files) |

After choosing the separate surface, continue with the next registered user-administration task.

## After reviewing a user

The Users list is the starting point for the next registered user-administration task. A saved user
can expose **Last Modifications** for audit review.

| Continue with… | Go to |
| --- | --- |
| Company-user creation | [Create a user](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/create-user) |
| Principal-user administration | Principal users |
| Roles or teams administration | Roles or Teams |
| Attached files and libraries | [Libraries](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/libraries-files) |
