# Edit dashboard setting

## What a dashboard setting is

A dashboard setting defines the tabs and widgets that a role sees on its dashboard.
Customize it when the role needs a different working view, such as an additional widget,
another tab, a principals report, or Eagle View. The saved setting feeds the active role
dashboard that opens for that role.

| If you need to… | Go to |
|---|---|
| Understand the dashboard that opens after you save | [Dashboard overview](doc:dashboard-overview) |
| Choose a widget for a dashboard tab | [Dashboard widget catalog](doc:dashboard-widget-catalog) |
| Work with the principals report | [Principal report](doc:principal-report) |
| Open a saved dashboard setting | [Configuration dashboard settings](doc:configuration-dashboard-settings) |

## Before you start

Before changing a dashboard setting, have the existing dashboard record ready and work in edit
mode. The edit actions are available in that mode, while **Last Modifications** requires a saved
dashboard identifier.

Prerequisites

- Open an existing dashboard setting from the configuration dashboard list.
- Confirm that the dashboard is in edit mode before selecting an edit action.
- Have a dashboard identifier available if you need **Last Modifications**.
- The report and Eagle View areas appear only when their subscription and active tab
  conditions are met.
- The report tables use the columns available in your dashboard setup.

## Find and open a dashboard setting

The configuration dashboard list is where you choose the saved role dashboard setting to edit.
The list has the columns **Role**, **Tabs**, **Widgets**, **Users**, and **Last modified**.

![Use the dashboard list headers to identify the saved role setting you want to open.](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/7da8144c27e58dc4f0629ed4fd3e47bd.png)

Prerequisites

- You are on the configuration dashboard list.
- You know which role dashboard setting you need to customize.

Steps

1. Find the role dashboard setting in the list using the **Role**, **Tabs**, **Widgets**,
   **Users**, and **Last modified** columns.
2. Select the edit link for that row.

**Result:** The existing dashboard setting opens for editing, with the edit actions available
when the record is in edit mode.

## Understand the dashboard-setting screen

The dashboard-setting screen combines dashboard editing actions with conditional dashboard areas.
Read the action bar first, then work through the area that matches the change you need.

The edit action bar contains these controls:

| What you want to change | Control |
|---|---|
| Add a widget | **Widget** |
| Add a blank tab | **Blank Tab** |
| Import dashboard content | **Import From** |
| Add or open a principals report | **Principals Report** |
| Add or open Eagle View | **Eagle View** |
| Save the current changes | **Save** |
| Save the changes and leave the screen | **Save and Close** |

The import area contains **Another role dashboards**. After a source dashboard with tabs is
selected, **Select tab(s)** and the tab-selection control appear. The Eagle View area contains
Analyze, **Over**, **Highlight**, and **Interval**, together with **All** and **Top 50**.

The principals report has a required **Report** field. Its other controls include the time-frame
options, date and period values, chart selectors, list controls, client and product-type
selectors, and font choices. Use the label shown beside each control.

The screen also provides **Last Modifications** when the dashboard has an identifier. Use it to
review the dashboard's audit history after maintenance.

## Customize and save the dashboard

Customize a dashboard setting by choosing the area that matches the change, then save the
setting so the role dashboard uses the new arrangement.

Prerequisites

- The existing dashboard setting is open in edit mode.
- You know whether you are adding a widget, adding a tab, importing content, or configuring a
  report area.

Steps

1. Select the control that matches the dashboard change.

   | Control | Action |
   |---|---|
   | **Widget** | Add a widget to the dashboard. |
   | **Blank Tab** | Add a blank tab. |
   | **Import From** | Prepare an import from another role dashboard. |
   | **Principals Report** | Add or open the principals report area. |
   | **Eagle View** | Add or open the Eagle View area. |

2. Select **Save** to remain on the screen, or select **Save and Close** to close the edit screen.

   | Control | Action |
   |---|---|
   | **Save** | Save the dashboard setting and remain on the screen. |
   | **Save and Close** | Save the dashboard setting and close the edit screen. |

**Result:** The dashboard setting is submitted. A successful save displays
`Your request was completed successfully`.

## Choose the dashboard branch

Each branch is a different dashboard area. Choose one according to the work you need to do,
rather than expecting every area to appear at the same time.

| If you need to… | Choose | What appears |
|---|---|---|
| Copy content from another role dashboard | **Import From** | **Another role dashboards**; after a source with tabs is selected, **Select tab(s)** |
| Work with the principals report | **Principals Report** | The report area, including **Settings** and **Introduction & Outline** |
| Configure the report period | **Settings** or the time-frame option | Chart, list, time-frame, client, product-type, and font controls as applicable |
| Read or edit the report introduction | **Introduction & Outline** | The introduction and outline fields, then **Ok** to close the popup |
| Analyze an Eagle View dashboard | **Eagle View** | Analyze, **Over**, **Highlight**, **Interval**, **All**, and **Top 50** |

The report's time-frame fields are required when their time-frame branch is active. Date values
appear for the date-range choice, and a period value appears for the period choice. The chart
controls appear when their chart is enabled. The report's **Report** field is required.

## When saving or loading goes wrong

Use the exact message on screen to decide what to do next.

| What you see | What it means | What to do |
|---|---|---|
| `An error occurred while processing your request` | The request was not completed successfully. | Check the change you made and select **Save** again. |
| `You already have this tab in this dashboard` | The tab you are adding is already present in the dashboard. | Return to the existing tab instead of adding another copy. |
| The edit actions are unavailable | The dashboard is not in edit mode. | Return to the editable dashboard setting before selecting **Widget**, **Blank Tab**, **Import From**, **Principals Report**, or **Eagle View**. |
| **Last Modifications** is unavailable | The dashboard does not have the identifier required for the audit-history area. | Save the dashboard record before opening its modifications. |

The principals report has a separate message, `Please choose one or more principals`, for its
report-generation flow. Use [Principal report](doc:principal-report) when that message appears.

## After saving the dashboard setting

Saving a dashboard setting applies its tab and widget arrangement to the role dashboard. Use
**Save and Close** when you have finished the change and want to leave the edit screen. Use
**Last Modifications** when you need to review the dashboard's audit history.

Prerequisites

- The dashboard setting is open and has no further changes to make.

Steps

1. Select **Save and Close**.
2. Read `Your request was completed successfully`.
3. Open **Last Modifications** when you need to review the saved dashboard changes.

**Result:** The dashboard setting is saved, the edit screen closes, and the dashboard's
modification history is available from **Last Modifications**.
