# FAQ

The **Home** surface is the signed-in dashboard at `/home`.

## FAQ overview

| If you need to… | Go to |
| --- | --- |
| Confirm what the signed-in dashboard is and where it opens | [FAQ overview](#faq-overview) |
| Check the access condition for the dashboard | [Before you open the home surface](#before-you-open-the-home-surface) |
| Open Home and identify the dashboard entry point | [Find the home surface and report](#find-the-home-surface-and-report) |
| Recognize the visible time ranges and comparison controls | [Understand the visible controls](#understand-the-visible-controls) |
| Choose a booking, target, or achievement comparison | [Choose the comparison view](#choose-the-comparison-view) |
| Check the dashboard editing controls | [Edit the home surface](#edit-the-home-surface) |
| Identify the dashboard readouts | [Check the report result](#check-the-report-result) |
| Find a broader dashboard explanation | [Dashboard](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-overview) |
| Find widget details | [Dashboard widget catalog](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-widget-catalog) |
| Find an exact product error message | [General error messages](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/general-error-messages) |
| Find recurring issue guidance | [Common issues and solutions](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/common-issues-and-solutions) |
| Find broader support triage | [Getting help](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/getting-help) |

![The signed-in Home dashboard with its readouts and comparison controls](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/92c84c4d1016e6185b3a63a6d8c80ec6.png)

## Before you open the home surface

When you are signed in, the dashboard appears. When you are signed out, PAMS shows the
login screen. The **Home** route is protected by its sign-in check.

| Session condition | Surface shown |
| --- | --- |
| Signed in | Dashboard |
| Signed out | Login screen |
| Opening `/home` | A route protected by the sign-in check |

When you are signed in, continue to [Find the home surface and report](#find-the-home-surface-and-report).

## Find the home surface and report

The Home dashboard entry point is `/home`. When it is available, **Dashboard** is visible
and **Log in to PAMS** is absent.

Use [Dashboard](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-overview) for the broader dashboard surface.

![The Home route after the Dashboard entry point loads](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/0204f63edda4fb604281c56ffed4df6d.png)

## Understand the visible controls

The signed-in dashboard presents readouts and charts with three comparison controls. The
visible time ranges are:

| Dashboard item | What appears |
| --- | --- |
| Current range | **Today** |
| Forward range | **Next 10 days** |
| Previous range | **Last 10 days** |
| Booking comparison | **Sort by Booking** |
| Target comparison | **Sort by Target** |
| Achievement comparison | **Sort by Achievement** |

Use the named comparison controls above when you want to change the dashboard view. To
use one, continue to [Choose the comparison view](#choose-the-comparison-view).

## Choose the comparison view

Choose a booking, target, or achievement comparison to inspect the dashboard readouts
from that perspective.

**Prerequisites**

- The **Dashboard** is visible at `/home`.

**Steps**

1. Select the comparison that matches your question.

   | If you want to compare by… | Select |
   | --- | --- |
   | Booking | **Sort by Booking** |
   | Target | **Sort by Target** |
   | Achievement | **Sort by Achievement** |

2. Check the named dashboard readouts in [Check the report result](#check-the-report-result).

**Result:** The dashboard remains on its named readouts in the selected comparison view.

For editing options, continue to [Edit the home surface](#edit-the-home-surface).

## Edit the home surface

Dashboard editing includes **Widget**, **Save**, and **New Tab**. The editing controls
have conditions: **Widget** and **Save** are in edit mode; **New Tab** is in the add-tab
or edit-tab popup; **Rename tab** is for an active editable tab in edit mode; and
**Delete tab** is for an active visible tab in edit mode.

| Control | Condition |
| --- | --- |
| **Widget** | Edit mode |
| **Save** | Edit mode |
| **New Tab** | Add-tab or edit-tab popup; required text field |
| **Rename tab** | Active editable tab in edit mode |
| **Delete tab** | Active visible tab in edit mode |

The dashboard header also provides **Restore Standard Tabs**, **Cancel**, **Restore**, and
**Add New Widget** while the dashboard is being edited.

### Add a widget to the active dashboard tab

Use this procedure to add an available card or chart to the tab you are editing.

**Prerequisites**

- The dashboard is in edit mode.

**Steps**

1. Select **Add New Widget**.
2. In the **Select widget** dialog, select a widget row.
3. Select **OK**.
4. Select **Save**.

**Result:**

The selected card or chart is added to the active tab, and the dashboard tab arrangement
is saved.

To find a card or chart that is already on the active tab, use **Search for widget** and
search by its title.

After a successful dashboard save, the dashboard stores the changes and exits edit mode
after a short delay. For the resulting readouts, continue to [Check the report result](#check-the-report-result).

## Check the report result

The Home dashboard combines a sales report with readouts about booking, pipeline,
offers, branches, principals, and teams. Identify each readout by its label.

| Area | Dashboard readout |
| --- | --- |
| Report | **Sales Pipeline** |
| Yearly booking | **Booking This Year** |
| Pipeline accounts | **Accounts in Sales Pipeline** |
| Team comparison | **Teams Booking vs. Target** |
| Team offers | **Teams Running Offer** |
| Branch tendency | **Branch Tendency to Target** |
| Principal tendency | **Principals Tendency to Target** |
| Yearly branch comparison | **Branch Booking vs. Target This Year** |
| Branch offers | **Branch Running Offers** |
| Principal offers | **Principals Running Offers** |

## When the answer is not available

Report choices depend on the current report data. Dashboard editing options depend on
your dashboard setup.

### If no dashboard is configured

If the page says `Your role has no dashboard`, contact your administrator to define a
dashboard for your role. If the page says `Kindly, Contact your administrator to define a
dashboard`, contact your administrator to define one for your role.

For a message that does appear, match it to the condition below.

| Condition | Message |
| --- | --- |
| Login username validation | `User Name is Required` |
| Login password validation | `Password Required` |
| Verification-code validation | `code is required` |
| Verification-code error | `Verification code not correct or expired` |
| Common success response | `Your request was completed successfully` |
| Common error response | `An error occurred while processing your request` |
| Principal report validation | `Please choose one or more principals` |
| Generic required validation | `This Field Is Required` |

### Out of scope messages

The **Login** page handles `Incorrect username or password`.

## Get help with messages and lists

For an exact product message, continue to [General error messages](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/general-error-messages).
For a recurring issue, continue to [Common issues and solutions](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/common-issues-and-solutions).

## Know where to continue

Continue with the page that answers your next question:

| Your question | Continue with |
| --- | --- |
| What dashboard widgets mean or contain | [Dashboard widget catalog](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-widget-catalog) |
| How the broader dashboard works | [Dashboard](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-overview) |
| What an exact error message means | [General error messages](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/general-error-messages) |
| How to handle a recurring issue | [Common issues and solutions](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/common-issues-and-solutions) |
| Where to start broader support triage | [Getting help](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/getting-help) |
