---
title: "Report Definition"
canonical: "https://kb.myframeworks.com.au/space/FRAM/28401648/Report%20Definition"
format: markdown
---
# Overview
The Report Definition module allows you to view and maintain your reports as well as [Publishing a Report ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28392124) that have been added or created using the query tool, and defining their layout and parameter field default values.
> ⚠️ Customers can create their own reports using **Query Developer**. However, if they are saved as **Owner = Sterland** then they will be overwritten with any subsequent upgrade.
# Navigating the Reporting Definition Screen
To access Reports, perform the following:
1. Click the **Frameworks Menu** and navigate to **System Administration > Screens & Menus > Report Definitions**.
## 1. Reports List
This section displays all of the Frameworks reports that are available to be used in the [Reporting Dashboard ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28380010). Clicking on the **Report Name** hyperlink will display the report's information and parameters.
Using the **Category **and** Owner **drop-down menu you can filter the results shown in the reports list. Once selected click on the **Find** button to update the list.
> ℹ️ To view more than 50 reports at one time, click the drop-down list and filter as needed.
> ℹ️
> ℹ️ 
## 2. Report Header Information
This section display information about the report including the **Name** of the report, a** description **of what the report does, which **category **the report will be grouped under on the reporting dashboard and the **Owner **of the report.
> ⚠️ Reports with the Owner as **Sterland** are the standard reports that have been created and publish by Sterland. These reports cannot be edited.
## 3. Report Parameters
In this section you can view the report parameters used by a **Sterland **created report or define the layout and parameter field default values used on the **Report Criteria **page.
> ℹ️ The Reports parameters are filters to help narrow down the information in the report you are running. How a report looks up (queries) the Frameworks database is defined in your **Query Repository **or created using the **Query Developer. **To create your own queries you will require a developers license from Sterland. To use one of the reports from the [Community Query Library](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28380068) you will need to have access to the Query Runtime tool, this may be located on your Frameworks server.
The Report Parameters are:
- **Seq**: This is the order in which is the report parameter is displayed on the **Report Criteria **page.
- **Parameter** **Name**: This is the name of your parameter from the query, for example: Company, Branch
- **Description**: This will be displayed to the user, on the **Report Criteria **page when running the report.
- **Data Type**: Available options are: **Integer**, **Decimal**, **Character**, **Logical**, **Date**
- **Lookup Activity**: This show which Frameworks activities are being looked up. The options are:
- **A finder**: *Frameworks.Finder.System.BranchFind*
> Macro (inline-media-image)
- **A drop down selection list**: *drop-down-list:Yes,No* or *drop-down-list:July,August,September,October,December,January,February,March,April,May,June*
- **A drop down pair list**: *drop-down-pairs-list:1,First,2,Second,3,Third*
For more information on commonly use Activity Definitions used in reports, click here.
| **Parameter** | **Data Type** | **Value** |
| --- | --- | --- |
| Branch | Integer | Frameworks.Finder.System.BranchFind |
| Company | Integer | Frameworks.Finder.System.CompanyFind |
| Customer | Integer | Frameworks.Finder.Receivables.Customer.CustomerFind |
| Customer Group | Character | Frameworks.Finder.Receivables.Customer.CustomerGroupFind |
| Product Group | Character | Frameworks.Finder.Inventory.ProductGroup.ProductGroupFind |
| Product Sub Group | Character | Frameworks.Finder.Inventory.ProductGroup.ProductGroupSubGroupFind |
| Sales Rep | Integer | Frameworks.Finder.Sales.RepFind |
| Supplier | Character | Frameworks.Finder.Payables.Supplier.SupplierFind |
Some parameters will not require an Activity Definition, the main examples of this are:
| **Parameter** | **Data Type** | **Value** |
| --- | --- | --- |
| Date To/From | Date | You will be able to enter a date range for a calendar icon |
| eg Month, Include zero balance, Financial Year, | Character | Anything requiring a drop down list can be manually entered into the "Lookup Activity" field, as long as conforms to the following format:
**drop-down-list: value1,value2,value3,value4** |
| GP eg minimum GP% | Decimal | Can leave blank and enter value manually as required |
| eg Till Number, Budget Number, | Integer | Leave blank in order to enter value manually |
- **Must Advise**: Ticking this makes the parameter a required field
- **Row Spacer**: Ticking this creates a row space on the report criteria page.
- **Column Spacer**: Ticking this creates a column space on the report criteria page.
- **Hidden**: Ticking this hides the report parameter from the report criteria page but still uses the default value when running the report.
- **Span Cols: **This allows the report parameter field to span across the number of columns it is set to, similar to merging cells.
- **Default Value**: You can define the default value the report parameter will be set to on opening the report. Variable text can be added used.
The current list of text variable options are:
- **@first: **First record of the finder
- **@last: **Last record of the finder.
- **@start_of_month**: First day of the current month
- **@end_of_month**: Last day of the current month
- **@start_of_year**: First day of the current calendar year
- **@end_of_year**: Last day of the current calendar year
- **@today**: Today's date
All the above date variables can have a + or - days, months, years added to them for example: @today + 5 days
- **New** **Row**: Ticking this will drop the report parameter to the next row on the report criteria page. Un-ticking will keep the parameter on the same row as the previous line
- **Width**: This value is defines the size of the field on the report criteria page.
- **Tool** **Tip**: This adds text to a popup box when you hover over the field.
## 4. Command Buttons
Using the buttons at the bottom of the screen you are able to publish **New **reports, from your **Query Repository Database, **and **Copy **allows you to copy the parameters of an existing reports, where the query is similar, allowing you to save time when defining the layout and parameter field default values.
> ⚠️ Only reports you have created can be deleted. For the standard reports the **Delete **button will not be available.
> ✅ Refer to [Publishing a Report ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28392124) to **Create a New Report** from an imported query.
# Enable User Security for Reports
You will also need to enable Security permissions to the newly created report. To do this, perform the following:
## 1. Run the Security Group Build Utility
You will need to run the **Security Group Build **utility to add the newly created reports to [Security Group Maintenance ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401628). To do this:
1. Click the **Frameworks Menu** then navigate to **Utilities > Security Group Build** from the navigation tree.
2. From the **Report Criteria** tab, click **Submit**.
## 2. Assign the Report to correct Security Group/s
Once the **Security Group Build **utility has been run the newly created reports will appear in [Security Group Maintenance ](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28401628) under the required security groups in the **Report Category List **menu.
> ✅ Refer to the [Maintain User Security Groups](https://sterlandsupport.atlassian.net/wiki/spaces/FRAM/pages/28404964) Administrator Guide for more information.