---
title: "Report Category List Dashboard"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28380010/Report%20Category%20List%20Dashboard"
format: markdown
---
# <span style="color: #003366">Overview</span>

The **Report Category List Dashboard** contains a set of standard reports; the available reports depend on your user security settings. These reports have been built and published to Frameworks so you can export them, as required or on a user-defined schedule, to a range of different **Output** types (EXCEL, CSV, CSV-UTF8, or PDF). Once a report has been run, you will receive a [notification](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378350) or email allowing you to click the hyperlink to view the report.

Depending on user security, Frameworks also allows you to define your reports via the [Report Definition](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401648) option. 

> ✅ Refer to the [Community Query Library](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28380068) for additional reports that have been shared by other Frameworks users.

# <span style="color: #003366">Accessing the Report Category List Dashboard</span>

1. To access the **Report Category List** Dashboard, click the **Report Category List** **Dashboard** icon from the top middle section of the Frameworks screen.
2. The list of valid reports you can run is displayed on the screen.

![image](media://17e03577-91f0-4f78-b1a5-2ad61e35adfb)

# Searching for a Report

Use the filter options to locate specific reports and to perform other grid functions. 

> ✅ Refer to [Advanced Grid Features](https://sterlandsupport.atlassian.net/wiki/spaces/fwksproau/pages/30509842) for further information.

![image](media://3663a98c-000f-4e0b-a6fe-325a50794396)

> **Example**
> 
> To locate a Customer Sales report, type **Sales** in the **Category** field and **Customer** in the **Name** or **Description** fields.
> 
> To view all reports, remove all wording from the filter boxes, then click <**enter**>.

# Running a Report

To run or schedule a report, from the **Report Category List** Dashboard perform the following:

1. When you click the applicable **Name** link, a **Report Scheduler** tab will open with the report name. On the **Report Criteria** page, the report name and brief description are displayed at the top.
  
2. Select an output option from the **Output To** drop-down menu. You have the option to output any report to EXCEL (XLS), CSV, CSV-UTF8, or PDF types.

> ⚠️ The CSV-UTF8 function is only available with Frameworks Reporting version 4.7.1.2 (Query 53).

![image-20250507-043623.png](media://7cd0d557-61a8-4051-a80f-7fea3cf09050)


3. Enter the required **Parameters** for the report you have chosen to run.

> ℹ️ The parameters on the **Report Criteria **tab within the Report Scheduler tab vary for each report.

When entering the report Parameters you can:

- Enter directly into the field.
- Click on the **Search** icon to open the corresponding **finder** window.
- Click on the **Date Finder** icon to open the **date picker**

> Macro (include)

![image](media://ec835648-9897-462e-a6b6-bd0f9fd1cb78)

> ✅ Refer to [Report Definition](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401648) for more information on defining the layout and parameter field default values.

4. Click the **Schedule** tab to schedule when you want the report to run, if required, and also how you would like to be notified.

> Macro (include)

The Notification Options you have are:

- **Send Notification**: When you enable this checkbox, after the report job has completed, a notification will be added to your Home screen's **Notifications** section.
- **Send Email**:  When you enable this checkbox, after the report task has completed, you will be able to add **email addresses** and modify the email **Subject** and **Message** in the email detail area. The email notice will have the report output attached.

> ℹ️ By default, the report is set to run **One Time. **So, you can skip to the next step if you don't need to schedule the report and don't want an email notification.

![image](media://2e313c24-3af0-4f18-ba82-d85929d3e0d7)

> ✅ Refer to [Scheduled Task - Scheduling and Output ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28402256)for more information on scheduling reports

5. Click **Submit** to run the report.
6. <span style="color: #333333">When the report is set to run, the </span>**<span style="color: #333333">Output </span>**<span style="color: #333333">tab displays the results of the completed task and a </span>**<span style="color: #333333">link to download</span>**<span style="color: #333333"> the selected report </span>**<span style="color: #333333">Output</span>**<span style="color: #333333">, under the </span>**<span style="color: #333333">Generated Reports</span>**<span style="color: #333333"> section.</span>

![image](media://46d3b87f-6c94-4446-8a60-b7163e28cd0f)

<span style="color: #333333">If the report was run on a schedule, you will receive an email and/or </span><span style="color: #333333">[notification](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378350)</span><span style="color: #333333"> on your Home page allowing you to click the hyperlink to view the report.</span>

> ✅ Refer to [About Notifications ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28378350)and [Task Scheduler Queue](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401732) for further information on how to access a report that has been run.

# Additional Information

> ✅ Refer to [Report Definition ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401648)for further information on creating a new report and defining the layout and parameter field default values.