# Dashboard

Use the Dashboard to review the measures selected for your role, read cards and charts on each tab,
and customize widgets when edit mode is available.

## What the Dashboard is

The Dashboard is a set of role-based tabs containing the cards and charts selected for your work.
Each tab is a separate view, so start with the one that matches the question you are reviewing.
The Dashboard includes the Dashboard and Principals Report views.

The standard Dashboard can include measures such as business development, sales pipeline, bookings,
accounts, teams, branches, and principals. Widget headings include Business development, Sales
Pipeline, Booking This Year, Accounts in Sales Pipeline, Teams Booking vs. Target, Teams Running
Offer, Branch Tendency to Target, Principals Tendency to Target, Branch Booking vs. Target This Year,
Principals Booking vs. Target This Year, Branch Running Offers, and Principals Running Offers.

The widget gallery covers 109 components. The Dashboard also has role-specific surfaces for Custom
Dashboard and Business Analysis, plus a principal-dashboard role variant. Use the overview below to
choose where to continue.

| If you need to… | Go to |
|---|---|
| Check what must be true before review or editing | [Before you start](#before-you-start) |
| Open the role's Dashboard | [Open the Dashboard](#open-the-dashboard) |
| Understand tabs, dates, widgets, and report sections | [Read dashboard content](#read-dashboard-content) |
| Find a widget and save a tab arrangement | [Find widgets and continue to customization](#find-widgets-and-continue-to-customization) |
| Choose between Custom Dashboard, Business Analysis, and Principals Report | [Use the dashboard variants](#use-the-dashboard-variants) |
| Resolve a missing Dashboard or unavailable subscription surface | [When the Dashboard is unavailable](#when-the-dashboard-is-unavailable) |
| Create or administer dashboards | [Dashboard settings](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-dashboard-settings) |
| Identify cards and charts by title | [Dashboard widget catalog](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-widget-catalog) |
| Review pipeline and status widget families | [Pipeline and status widgets](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/pipeline-and-status-widgets) |
| Review management report widget families | [Management report widgets](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/management-report-widgets) |

![Dashboard tabs and the business widgets available for the current role](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/c0412e66205334ca9d219c53758132ce.png)

## Before you start

The Dashboard is a signed-in, role-based review surface. Your account must be signed in, your role
must have dashboard tabs, and the subscription must include the Dashboard content and its embedded
widgets. The Dashboard does not require information changes before review.

**Prerequisites**

- Sign in with the account whose role you want to review.
- Confirm that the role has at least one Dashboard tab.
- Use a subscription that includes the Dashboard content and embedded widgets.

The Dashboard library appears when dashboard tabs exist. Only the active tab displays its content;
the other tabs remain available for selection. The subscription condition controls the Dashboard
content and embedded widgets. When edit mode is active, the header exposes **Widget** and **Save**,
and tab maintenance controls can include **Rename tab**, **Delete tab**, and **Remove widget from
tab**. Without a Dashboard, the page displays `Your role has no dashboard` and
`Kindly, Contact your administrator to define a dashboard`.

## Open the Dashboard

Open the Dashboard from the application's **Dashboard** menu entry.

**Prerequisites**

- You are signed in.
- Your role has a Dashboard.

**Steps**

1. Open the application's **Dashboard** menu entry.
2. Select the Dashboard tab you want to review.
3. Select the route that matches the role-specific surface when more than one destination is
   available.

   | If you need to… | Route |
   |---|---|
   | Open the standard Dashboard landing | `/dashboard` |
   | Open the principal-dashboard landing | `/principal-dashboard` |
   | Open the Business Analysis surface | `/dashboard/businessAnalysis` |
   | Open the Custom Dashboard surface | `/dashboard/customDashboard` |

4. Confirm that the Dashboard content or the role's unavailable-dashboard message is on screen.

![Dashboard landing with its visible tabs, date ranges, widgets, and sorting controls](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/92c84c4d1016e6185b3a63a6d8c80ec6.png)

**Result:** The selected Dashboard surface is open. Its active tab shows its available content, or
the page shows why the role has no Dashboard.

## Read dashboard content

The active tab is the view currently shown in the Dashboard grid. Select another visible tab for a
different role-selected view.

On the Dashboard, the date-range labels are Today, Next 10 days, and Last 10 days. The visible
 sorting controls are **Sort by Booking**, **Sort by Target**, and **Sort by Achievement**. Use the
widget heading to identify the measure before interpreting its
card or chart.

| What you are looking for | What to read |
|---|---|
| A current or upcoming time view | Today, Next 10 days, or Last 10 days |
 | A booking ranking | **Sort by Booking** |
 | A target comparison | **Sort by Target** |
 | An achievement comparison | **Sort by Achievement** |
| A sales or account view | **Sales Pipeline** or **Accounts in Sales Pipeline** |
| A team, branch, or principal comparison | The matching Teams, Branch, or Principals heading |

The **Principals Report** tab is a role-specific report view. Its report form has the required
**Report** field. When a report is ready and not generated, its navigation can include **Running
Jobs**, **Status of running firm offers**, **Status of running orders**, **Sales Overview**,
**Reasons for lost jobs**, **Status of submitted offers**, **Bookings over time**, **Deliveries over
time**, and **Overall Analysis**.

The report's outline fields are **Introduction :**, **Sales Analysis :**, **Lost Opportunities and
Competition :**, **Client Complaints and Difficulties :**, **Suggestions for Business Improvement
:**, **Booking Forecast :**, and **Conclusion :**. The columns shown in a principal report depend on
your role and report data, so read the column names currently displayed in that report.

![Principals Report tab with its report field and role-specific report content](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/a124454c600e2bdcb74df6cf64e6f891.png)

## Find widgets and continue to customization

Use this section to locate a card or chart already available to the Dashboard or add a selected
widget to the active tab. The widget picker is available from edit mode.

**Prerequisites**

- The Dashboard is open.
- Edit mode is available for the role.
- You know the widget title or a keyword to search for.

**Steps**

1. Choose the widget action that matches your task.

   | If you need to… | Select |
   |---|---|
   | Locate a widget already on the active tab | **Search for widget** |
   | Add a widget to the active tab | **Widget** |

2. For an existing widget, enter its title or keyword in the search field.
3. For a new widget, select **Widget** in the edit-mode header, then enter a title or keyword in
   **Keyword to search...** in the **Select widget** dialog.
4. Select **Search for widget** to filter the widget rows.
5. Select the action that matches the number of widgets you want.

   | If you need to… | Select |
   |---|---|
   | Add selected cards or charts | The row for each card or chart |
   | Add every available card or chart | **Select all** |

6. Select **OK** to confirm the widget selection.
7. Select **Save** to save the Dashboard tabs and exit edit mode.

8. Confirm that the selected widgets appear on the active tab.

Selected widgets are added to the active tab. A successful save displays
`Your request was completed successfully`. **New Tab** is required when the add-widget flow asks for
a new tab title. Tab maintenance can also provide **Rename tab**, **Delete tab**, and **Remove widget
from tab**. The Dashboard gallery contains 109 components.

**Result:** The selected widgets appear on the active tab after a successful save, and edit mode ends.

## Use the dashboard variants

The dashboard variants answer different review questions: Custom Dashboard groups selected measures,
Business Analysis provides a refreshable analysis surface, and Principals Report provides the
principal-focused report and its sections.

| Variant | Controls and choices |
|---|---|
| Custom Dashboard | **Over**, **Highlight**, **Interval**, **All**, and **Top 50** |
| Business Analysis | **Refresh** |
| Principals Report | **Report**, **Settings**, and **Introduction & Outline** |

For **Over**, the choices are **Clients**, **Projects**, and **Market Segments**. **Interval** has
**last 12 months**. **Highlight** initially offers
**All Clients** and **All Vendors**. Changing **Over** to another value
clears the **Highlight** list; returned client and vendor names depend on the records available to
the current role. When the result-range actions are available, select **All** or **Top 50** according to
the result range you need.

The Principals Report provides **Settings** and **Introduction & Outline**, together with the report
section links listed in [Read dashboard content](#read-dashboard-content). The selected principal-report
columns depend on the current role and report data. Use the choices and controls shown on the current
surface when the available defaults or Highlight values differ.

## When the Dashboard is unavailable

An unavailable Dashboard has a specific meaning when the page shows the role message. If the page
shows `Your role has no dashboard`, the role has no dashboard defined. The accompanying message is
`Kindly, Contact your administrator to define a dashboard`; contact the administrator who defines
role dashboards.

The subscription branch replaces Dashboard content and embedded widgets when the Dashboard
subscription is not included. Follow the subscription-upgrade surface provided by your deployment.
If **Widget** or **Refresh** is absent, use the controls available on the current role's page or
contact the administrator.

| What you see | What it means | What to do |
|---|---|---|
| `Your role has no dashboard` | No Dashboard is defined for the role. | Contact the administrator who defines dashboards. |
| `Kindly, Contact your administrator to define a dashboard` | The page is directing the role to dashboard administration. | Ask the administrator to define a Dashboard for the role. |
| The subscription-upgrade surface | The Dashboard subscription is not included. | Follow the subscription-upgrade route provided on screen. |
| A variant surface without **Refresh** or **Widget** | The control is not available on the current visible surface. | Continue with the controls that are visible or contact the administrator. |
| `An error occurred while processing your request` | The Dashboard request returned the common processing error. | Review the current action and request conditions, then retry. |
| `Please choose one or more principals` | The principal report requires one or more principals. | Choose one or more principals before continuing the report action. |

## Continue to Dashboard settings

Dashboard customization is an administrative settings task. Use [Dashboard settings](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-dashboard-settings)
for the registered administrative page. Continue to [New dashboard setting](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-dashboard-settings-new)
to create a record or [Edit dashboard setting](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-dashboard-settings-edit-record) to
maintain one.

For detailed widget inventories, use the three focused widget catalog pages: [Dashboard widget
catalog](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-widget-catalog), [Pipeline and status widgets](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/pipeline-and-status-widgets),
and [Management report widgets](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/management-report-widgets). Individual widgets are grouped by
component family rather than given separate pages. Detailed principal-report settings, lists, charts,
and PDF generation belong to the separate principal-report task.
