# Reports

## Reports overview

A report widget is a report panel that displays report content. A report tab is a saved
grouping of report widgets, and the active report tab is the grouping you are currently
reviewing. A widget chooser is the area for choosing widgets for a tab. Reports is the hub
where you review these widgets, change their reporting period, and organize the widgets shown
on a tab. It also provides search and time-frame controls.

| If you need to… | Go to |
|---|---|
| Reach the reporting workspace | [Open Reports](#open-reports) |
| Recognize the active tab and its widgets | [Understand the Reports screen](#understand-the-reports-screen) |
| Change the period used by report widgets | [Choose a report time frame](#choose-a-report-time-frame) |
| Open or close several widgets | [Review and organize report widgets](#review-and-organize-report-widgets) |
| Diagnose an unavailable report surface or validation message | [Handle report branches and errors](#handle-report-branches-and-errors) |
| Check a missing control or unexpected result | [When Reports does not show what you need](#when-reports-does-not-show-what-you-need) |
| Read the wider dashboard workspace | [Dashboard](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-overview) |
| Identify available dashboard widget groups | [Dashboard widget catalog](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-widget-catalog) |
| Review management-report widget details | [Management report widgets](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/management-report-widgets) |
| Configure report settings | [Reports settings](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-reports-settings) |

The tabs and widgets depend on the reports prepared for the current dashboard, the active tab,
and the selected widget state. Use the related pages for the broader dashboard, widget
catalogue, management-report detail, or report configuration.

> **Note:** A report widget is available only when its report-tab and widget conditions are
> satisfied. A page that has loaded can therefore contain a different set of report content
> from another user's page.

![Report tabs, the active report area, and the Time Frame control](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/e18500c16bd669c9bde120c6f7d0fc4f.png)

## Before you start

The Reports screen is assembled from available dashboard tabs and the tab that is active.
These conditions determine which area you can use:

| What determines availability | What you see when it applies |
|---|---|
| Dashboard tabs are available | The Reports library is shown when dashboard tabs exist. |
| No dashboard is available | A no-report message branch is used instead of the library. |
| The subscription includes the report area | Report tabs and their active report tab can be shown. |
| The subscription does not include the report area | A subscription alternative is shown instead of the report library. |
| A visible tab is active | The active tab's report content can be shown. |
| The active tab has selected widgets | The widget body can be shown. |
| A widget is opened | That widget's content can be shown. |
| A time-frame dialog uses **Definite year** | The year field is required, with a minimum of `2024` and a maximum of the current year. |

Before you start, sign in and know which period you want to review. The available report
content depends on the tabs and widgets prepared for your dashboard, so the page may show a
different library or widget set for another account.

## Open Reports

Reports is the signed-in reporting workspace at `/reports`. When it loads, look for the page
title **Reports**, report tabs, and report content such as a report widget.

**Prerequisites**

- You are signed in.

**Steps**

1. Open `/reports`.
2. Confirm that the page title is **Reports**.
3. Confirm that report tabs and report content are visible.

**Result:** The Reports hub is open with the available report tabs and report content. The
**Time Frame** control is available on the loaded page.

## Understand the Reports screen

The widget area contains the selected widgets in the active report tab.

| Screen area or control | What it is for | When it appears |
|---|---|---|
| Report library | Holds the available report tabs and report-tab content | When dashboard tabs exist |
| Report tabs | Switches between available tab groupings | When the subscription and library conditions allow them |
| Active report tab | Identifies the tab whose widgets are being reviewed | When a tab is active |
| Widget area | Shows the selected report widgets | When selected widgets exist |
| Widget body | Shows an opened widget's content | When the widget is opened |
| Widget chooser | Lets you choose widgets for a tab | In the popup for choosing dashboard widgets or changing a widget |
| Search field | Narrows the widgets in the active visible tab | When the subscription, active-tab, and widget conditions allow search |
| **Time Frame** | Opens the report-period choices | When the page is not in edit mode |

The search field is available only when the subscription permits the area, a visible tab is
active, and that tab has widgets. The tab title field is required in both the add-tab and
edit-tab popups.

The active tab can expose the tab actions **Extend all** and **Collapse all**. The report
screen also groups popup states for adding a tab, choosing dashboard widgets, editing a tab,
choosing a time frame, changing a widget, and editing a month-based report.

## Choose a report time frame

The report time frame tells the report area which period to use while you review its widgets.
Use the **Time Frame** control when you need to inspect another supported period.

**Prerequisites**

- Reports is open.
- The **Time Frame** control is available.

**Steps**

1. Select **Time Frame**.
2. In the dialog, choose a period from this table.

   | If you need to review… | Select |
   |---|---|
   | The current year | **This year** |
   | A specific year | **Definite year** |
   | The preceding twelve-month period | **last 12 months** |

3. If you selected **Definite year**, enter a year from `2024` through the current year in
   the year field.
4. Select **OK**.
5. Check the value shown by **Time Frame**.

**Result:** The dialog closes after confirmation, and the **Time Frame** area shows the
selected period when the change is applied.

![The Time Frame dialog with its period choices](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/99253ca35296af90587b0dcb0eebf873.png)

![The Reports page after the time-frame interaction](https://atloriaassets.blob.core.windows.net/assets/a438221c-c1af-407c-b9e6-a56c986db846/99253ca35296af90587b0dcb0eebf873.png)

## Review and organize report widgets

Review the report panels in the active tab in the normal tab view. Organize them only when the
applicable tab, widget, or edit mode exposes the action.

**Prerequisites**

- Reports is open with an active visible tab.
- The active tab contains selected widgets for widget review.

**Steps**

1. Use the applicable action in this table.

   | If you need to… | Do this |
   |---|---|
   | Open all selected report widgets | Select **Extend all**. |
   | Close the opened report widgets | Select **Collapse all**. |
   | Narrow the widgets in the active tab | Enter text in the search field. |
   | Choose widgets for the tab | Open the widget chooser. |
   | Select every widget shown in the chooser | Select **Select all**. |
   | Prepare to remove a widget in edit mode | Open the widget menu. |
   | Remove a widget in edit mode | Select **Remove widget from tab**. |
   | Change the active tab's title in edit mode | Select **Rename tab**. |
   | Complete the active tab's title change | Complete the required tab-title field in the edit-tab popup. |
   | Remove the active tab in edit mode | Select **Delete tab**. |

**Result:** The active tab shows the widget expansion, collapse, search, selection, rename,
or deletion result associated with the action that was available. **New Tab** uses the
required tab-title field when a new tab is added.

## Handle report branches and errors

Reports can show a different branch when dashboard, subscription, widget, tab, or popup
conditions differ from the normal loaded screen. Use the visible branch to choose the next
reader action.

| What the branch means | What is available |
|---|---|
| No dashboard is available | The no-dashboard message branch appears. |
| The subscription does not include the report area | The subscription alternative appears, with **Back** available in that branch. |
| A tab is not active | Its report-tab content is not selected for display. |
| No widgets are selected | The widget body is not shown. |
| A widget is closed | Its widget body is not shown until the widget is opened. |
| A widget chooser popup is active | The chooser is shown for choosing dashboard widgets or changing a widget. |
| A shared popup is active | The popup may offer **Save**, **Cancel**, **Don't Save**, **Upload**, **No**, **Yes**, or **Ok**, according to its popup type. |

The report-tab template does not mount cash-position or cash-flow widget components in the
listed report-tab area. **Global view** and **Single view** are not available as mounted
choices in this screen. The report screen therefore follows the active tab, widget, and
popup branches rather than presenting those choices as general Reports controls.

## When Reports does not show what you need

Start with the condition that matches the missing surface, then check the message if the
screen asks for a value.

| What you see | What to check | Message or next action |
|---|---|---|
| The report library is absent | Dashboard tabs and subscription availability | The library requires dashboard tabs; the subscription alternative uses its own branch. |
| A widget body is absent | An active tab, selected widgets, and whether the widget is opened | Open the applicable widget or use the widget chooser when that surface is available. |
| The tab-title field is empty | The add-tab or edit-tab popup | The required-field message is `This Field Is Required`. |
| **Definite year** has no year | The year field in the time-frame dialog | The validation message is `Required`. Enter a year from `2024` through the current year. |
| A request succeeds | The action's completion message | `Your request was completed successfully` |
| A request fails | The request error message | `An error occurred while processing your request` |

Reports can show report content without the subscription alternative. When a report widget is
selected and opened, use its widget-specific controls in that widget's report area.

## Continue from Reports

Continue to the related page that matches your next task:

| If you need to… | Continue to |
|---|---|
| Work in the broader dashboard workspace | [Dashboard](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-overview) |
| Identify available widget groups | [Dashboard widget catalog](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/dashboard-widget-catalog) |
| Review management-report widget detail | [Management report widgets](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/management-report-widgets) |
| Configure report settings | [Reports settings](https://pams-doc-test-fresh.atloria.app/p/pams-doc-test-fresh-N9B4TwWn3Q/user/configuration-reports-settings) |
