> ## Documentation Index
> Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Reporting — User Guide

> Feature: Report Library & Viewer, Export Pipeline Spec: PF-12 Phase 5 & 6 Last Updated: 2026-03-15

**Feature:** Report Library & Viewer, Export Pipeline\
**Spec:** PF-12 Phase 5 & 6\
**Last Updated:** 2026-03-15

***

## Overview

The Reporting system lets you run saved reports, view results in an interactive table, manage who can access reports, and export results to CSV, Excel, PDF, or JSON.

## Key Capabilities

* **Result Table** — Sort, filter, and paginate report results using the DataTable
* **Cache Indicator** — See when results are cached vs fresh; refresh on demand
* **Permissions** — Control who can view, run, edit, or schedule each report
* **Multi-format Export** — Export to CSV, Excel, PDF, or JSON with download links

## Prerequisites

| Permission     | What You Can Do                            |
| -------------- | ------------------------------------------ |
| `can_view`     | See report and results                     |
| `can_run`      | Execute the report                         |
| `can_edit`     | Edit report definition, manage permissions |
| `can_schedule` | Create/edit scheduled runs                 |

## How To

### Run a Report

1. Navigate to **Reports** from the sidebar
2. Select a report from the library
3. Configure parameters (date range, filters) if prompted
4. Click **Run Report**
5. Results appear in the interactive table

### Use the Result Table

* **Sort:** Click any column header to sort ascending/descending
* **Filter:** Use the filter input above each column to narrow results
* **Pagination:** Choose 25, 50, or 100 rows per page; navigate with page controls

### Check Cache Status

After running a report, look for the **Cached** badge showing when results were last fetched. Click the **Refresh** button to force a fresh execution.

### Manage Permissions

1. Open a report you own (or have `can_edit` access to)
2. Find the **Permissions** section
3. Click **Add Permission** to grant access to a specific user or role
4. Toggle individual flags: View, Run, Edit, Schedule
5. Click the trash icon to remove a permission

### Export Results

1. After running a report, click the **Export** dropdown
2. Choose a format: CSV, Excel, PDF, or JSON
3. The file is generated and uploaded to secure storage
4. A download link opens automatically (valid for 24 hours)
5. Re-download from the run history if needed

## Troubleshooting

| Issue                  | Solution                                                 |
| ---------------------- | -------------------------------------------------------- |
| Download link expired  | Re-export the report or find the run in history          |
| Export button disabled | Result set exceeds 10,000 rows — apply filters to reduce |
| Cannot see Permissions | You need `can_edit` access or org admin role             |
| Report shows "Cached"  | Click Refresh to get latest data                         |

## References

* [PF-12 Spec](../../specs/pf/specs/PF-12-reporting-engine.md)
* [PF-12 Phase 5/6 Expansion](../../specs/pf/specs/PF-12-PHASE-5-6-EXPANSION.md)
* [Admin Guide](reporting-admin-guide.md)
