Report definitions allow you to run a single report in multiple ways without having to create custom reports.

Each definition defines the grouping as well as the parameters. Definitions are generally named by the grouping for which they are defined. For example, "By Category" or "By Location By System."

Manage Report Definitions

You can add, edit, and delete your report definitions from Report Explorer.

To add a report definition, click New under Definition.

You can also add a report definition by right-clicking the report and clicking New > Report Definition.

Report Definition Sections

The Report Definition form for all reports always has two sections: Grouping and Parameters. Some reports will also have a Sorting tab.

Grouping helps you display data in the report by specific criteria such as location, system, and category.

In the example report definition for the Proposal with Images report shown below, the definition is "By Location By Category," and the Location and Category groupings were chosen from the dropdown options.

The Parameters tab has various built-in options for how you would like the report to be generated.

Each stock report in SI has its own set of parameters.

On the Report Definition form, you can choose between two options:

Default Report Criteria - only one definition can have this box checked. This is the definition that will generate if you choose to run the report vs. running a specific definition.
Update Parameters to All Report Definitions: This option applies any changes you make to a selected definition to all definitions for that report.

You will see the current grouping and parameter selections under Definition Criteria Summary on the form.

Definition Parameters Example

In this example, we will analyze the parameters for the "By Location By Category" report definition of the "Proposal with Images" report.

The following are the parameters.

Parameter	Description
Show labor by phase in the summary?	If charging for labor on a per-item basis using phases (see Labor Considerations), then rather than having one line item in the Project Summary section of the proposal, each phase will be displayed as well, and a combination of all phases' "Management" and "Design" labor will be displayed on separate lines. The default is unchecked.
Show Page Headers and Footers in report?	Unchecking will remove the page headers and footers on the report. The default is checked.
Show Labor Items in report?	If you choose to display labor items in the body of the report, their prices will not be displayed. The default is unchecked.
Show Labor Hours for Labor Items in report?	This will replace the quantity of the labor items with the labor hours assigned to the labor item. You must choose the "Show Labor Items in report?" parameter above for this parameter to display the labor hours. The default is unchecked.
Summarize Packages?	The options are "All,""None," and "Item." The default is "Item." The "Item" option respects each package's setting for whether or not to summarize the package. Check out this article for more details.
Summarize Accessories?	The options are "All,""None," and "Item." The default is "Item." The "Item" option respects each "parent" item's setting for whether or not to summarize the accessories. Check out this article for more details.
Show Manufacturer?	When unchecked, the Manufacturer field will not be displayed on the report. The default is checked.
Show Model Number?	When unchecked, the Model Number field will not be displayed on the report. The default is checked.
Show Part Number?	When checked, the Part Number field will not be displayed on the report. The default is unchecked.
Show detail prices?	When not summarizing accessories and packages in a report, the price of the accessories and the price of the individual items in the package are not displayed. Check this box if you want their prices to display. The default is unchecked.
Show item prices?	When unchecked, the price of the items will not be displayed on the report. The default is checked.
Show product price (do not include accessory price)? You must also check 'Show detail prices.'	By default, the price of the "parent" product is displayed alongside its accessories. Check if you want the "parent" item's price to not include the price of its accessories. The default is unchecked. You must also check the "Show detail prices" parameter, or your project price will not include accessory pricing.
Use Theme?	This will use the selected report theme for the report. The default is checked.
Keep together group?	This setting will start a new page on proposals when all of the items in a group don't fit on the current page. The default is checked.
Hide Cover Page?	This allows you to not display the cover page on proposals. This is handy when using report groups. The default is unchecked.
Show Discount Amount in project summary section?	This will display product discounts applied via the Price tab and Package discounts on a separate line in the Project Summary section of the proposal. The default is unchecked.
Show full amount (non discounted for each) item	This will show the item's actual price, even though it has been set at a discounted price. The default is unchecked.
Show dynamic group section totals?	This displays the subtotal for each grouping on the proposal. The default is checked.
Hide optional items?	Allows you to hide optional items on the proposal.
Hide alternate items?	Allows you to hide alternate products on the proposal.
Hide project summary section?	Allows you to hide the Project Summary section of the proposal.
Show equipment and labor subtotal separately?	This will display two values instead of one if you have the "Show dynamic group section totals?" parameter checked. The default is unchecked.
Show labor hours in summary?	This will display the labor hours in the Project Summary section. The default is unchecked.
Show change order history hours	This will display the labor hours of the items in change orders if you have chosen to include change order history in the report. Check out this article for more details. The default is unchecked.
Show Scope of Work?	The options are "After cover page,""End of report," and "Hide." The default is "Hide."