¶¶Òõ

Skip to main content

Report Designer

The Report Designer utility is used to create and customize reports that track and evaluate daily operations of a site.

Report Designer Form Overview

XBO_Report_Designer_Final.png

1

Report Designer Search

Look for reports based on Report Name.

2

Add New Report

Add new reports.

3

Report Name

Identifies the Name of the report.

4

Report Type

Identifies the Type of report.

5

3-Dot Menu

Use to Change, Copy, or Delete reports.

Add New Report - Form Overview

Create_Report_Form_Overview_Annotated.png

1

Report Attributes Section / Type of Report

Displays the name and type of the report.

Note: The title Report Attributes actively changes to match the entry in the Name field.

2

General

This category contains the General Attributes and Items to Hide fields.

3

Columns/Lines

This category contains a table that manages the Columns or Lines of the report.

See Column and Line Glossary for details on the types of Columns and Lines.

4

General Attributes

Make changes to the General Attributes fields.

Note: See Report Types for details on the available fields of each report.

5

Items To Hide

Make changes to the Items to Hide fields.

Note: See Report Types for details on the available fields of each report.

6

Cancel

Cancel all unsaved changes and return to the Report Designer homepage.

7

Save

Save all unsaved changes and return to the Report Designer homepage.

Add New Report

Utilities → Report Designer

To add a new Report:

  1. From the upper-right of the Report Designer screen, select Add New Report.

  2. From the New Report drop-down field, select the type of report and select Add.

  3. From the General Reports Attributes screen, define the required fields.

  4. From the left side of the Report Attributes Section, select Columns or Lines.

  5. From the Column or Line Type drop-down, select a Column or Line type.

  6. From the lower-right of the Add Column or Line window, select Add.

  7. From the selected Column or Line Type window, fill out the applicable fields in each category.

    To see an overview of the categories and attributes, see Column and Line Types.

  8. From the lower-left of the Column or Line Type window, select OK.

  9. From the upper-left of the Report Designer screen, select Save.

Managing Reports

Perform the following actions by selecting the 3-Dot Menu:

Action

Steps

Change

To make changes to a report:

  1. From the 3-Dot Menu drop-down, select Change.

  2. From the Report Page, make changes to the report as needed.

  3. From the upper-right, select Save.

Copy

To make a copy of a report:

  1. From the 3-Dot Menu drop-down, select Copy.

  2. From the Report Page, make changes to the report as needed.

  3. From the upper-right, select Save.

Delete

To delete a report:

  1. From the 3-Dot Menu drop-down, select Delete.

  2. From the Delete Report? window, select Yes.

Managing Columns/Lines

To manage the columns/lines in a report:

  1. From the Report Designer List, select the Report to edit.

  2. From the Report page, select Columns/Lines.

  3. From the 3-Dot Menu, select one of the following actions:

    • Change: Make changes to the Column/Line.

    • Insert Above: Insert a Column/Line above the selected Column/Line.

    • Insert Below: Insert a Column/Line below the selected Column/Line.

    • Delete: Deletes the selected Column/Line.

  4. From the the upper-right, select Save.

Report Types

There are four (4) types of reports:

Column Report - Comparative

The Column Report - Comparative displays management levels or sales of a site compared to similar reporting items from other sites.

This report displays the following fields:

Section

Description

General Attributes

Name - Define the name of the report.

Print Options - From the drop-down list, select the print format.

Landscape - Toggle Yes to print the report in a landscape orientation. Toggle No to print the report in portrait orientation. [Optional]

Font Size - From the drop-down list, select the font size. [Optional]

Store Name Format - From the drop-down list, select to print the report using the Store Name, Store Number, or Store Number & Name.

Limit Store/Group Width - Toggle Yes to set a size limit for the site/group column(s). Toggle No to have no defined size limit of the site/group column(s). [Optional]

Inches - Only available if Limit Store/Group Width is toggled Yes, enter the maximum size of each site/group column. [Optional]

Report Timeout, ms* - Enter the amount of time before the report generation times out.

Include Store Group Detail - Toggle Yes to include the site group details. Toggle No to not include site group details. [Optional]

Items to Hide

Report Total - Toggle to hide the report average.

Report Average - Toggle to hide the report average.

Report Comp. Total - Toggle to hide the report comparative total.

Report Comp. Average - Toggle to hide the report comparative average.

Group Total - Toggle to hide the group total.

Group Average - Toggle to hide the group average.

Group Comp. Total - Toggle to hide the group comparative total.

Group Comp. Average - Toggle to hide the group comparative average.

* Fields only available for ¶¶ÒõAdministrators.

Line Report - Comparative

A Line Report Comparative displays management levels or sites compared to reporting items.

This report displays the following fields:

Section

Description

General Attributes

Name - Define the name of the report.

Print Options - From the drop-down list, select the print format.

Landscape - Toggle Yes to print the report in a landscape orientation. Toggle No to print the report in portrait orientation. [Optional]

Font Size - From the drop-down list, select the font size. [Optional]

Store Name Format - From the drop-down list, select the format for the store name on the report.

Inches - Only available if Limit Store/Group Width is toggled Yes, enter the maximum size of each site/group column. [Optional]

Report Timeout, ms* - Enter the amount of time before the report generation times out.

KPI Mobile Report* - Toggle to enable availability of reports on the Mobile App Report.

Custom Export Format - Toggle to enable export of reports in different formats.

Include Store Group Detail - Toggle Yes to include the site group details. Toggle No to not include site group details. [Optional]

Items to Hide

Report Total - Toggle to hide the report average.

Report Average - Toggle to hide the report average.

Report Comp. Total - Toggle to hide the report comparative total.

Report Comp. Average - Toggle to hide the report comparative average.

Group Total - Toggle to hide the group total.

Group Average - Toggle to hide the group average.

Group Comp. Total - Toggle to hide the group comparative total.

Group Comp. Average - Toggle to hide the group comparative average.

* Fields only available for ¶¶ÒõAdministrators.

Column Report - Trend

The Column Report - Trend displays the sales over a period of days. The first column lists the dates chosen for the report. If the level chosen for the report was site, a page is produced for each site chosen.

This report displays the following fields:

Section

Description

General Attributes

Name - Define the name of the report.

Print Options - From the drop-down list, select the print format.

Landscape - Toggle Yes to print the report in a landscape orientation. Toggle No to print the report in portrait orientation. [Optional]

Font Size - From the drop-down list, select the font size. [Optional]

One Report per Store/Group - Toggle to generate separate reports for each site/group.

Limit Store/Group Width - Toggle Yes to set a size limit for the site/group column(s). Toggle No to have no defined size limit of the site/group column(s). [Optional]

Inches - Only available if Limit Store/Group Width is toggled Yes, enter the maximum size of each site/group column. [Optional]

Report Timeout, ms* - Enter the amount of time before the report generation times out.

Items to Hide

Report Total - Toggle to hide the report average.

Report Average - Toggle to hide the report average.

Report Comp. Total - Toggle to hide the report comparative total.

Report Comp. Average - Toggle to hide the report comparative average.

* Fields only available for ¶¶ÒõAdministrators.

Line Report - Trend

A Line Report - Trend displays the level of management (or site) performed on Daily Reporting Items or calculated items over a range of time.

This report displays the following fields:

Section

Description

General Attributes

Name - Define the name of the report.

Print Options - From the drop-down list, select the print format.

Landscape - Toggle Yes to print the report in a landscape orientation. Toggle No to print the report in portrait orientation. [Optional]

Font Size - From the drop-down list, select the font size. [Optional]

One Report per Store/Group - Toggle to generate separate reports for each site/group.

Report Timeout, ms* - Enter the amount of time before the report generation times out.

Include Store Group Detail - Toggle Yes to include the site group details. Toggle No to not include site group details. [Optional]

Items to Hide

Report Total - Toggle to hide the report average.

Report Average - Toggle to hide the report average.

* Fields only available for ¶¶ÒõAdministrators.

Column/Line - Report Attributes

Many of the Column and Line types listed in Column and Line Glossary share common categories and attributes. Below are common categories and attributes found in each report type:

Category

Attribute

Description

General

Top Title* / Title

Enter title displayed at the top of the column/line.

Bottom Title*

Enter title displayed at the bottom of the column/line.

Print

Toggle Yes to allow the report to export in a print format.

Percent Type

Select the type of percent.

Totaling Type

Select the method of totaling.

Width

Select the value for the width of the column/line.

Justification

Select the alignment of the data points.

Decimals

Select the number of decimals to display in each entry.

Commas

Toggle Yes to display commas in the values where applicable.

Hide Total

Toggle Yes to hide or show totals.

Hide Average

Toggle Yes to hide or show averages.

Total Equal To Average

Toggle Yes to enable the Total to equal the average.

Number Format

Select the format for the data points.

Time Frame

Select the time frame of the data points.

Comp Stores Only

Toggle Yes to only show comp sites.

Thresholds

Critical Range

Enter the Bottom and the Above Range that determine the critical range.

Warning Range

Enter the Bottom and the Above Range that determine the warning range.

Normal Value

  • Select Use Transparent to display normal ranges with a transparent background.

  • Select Use Green to display normal ranges with a green background.

Drill-Thru

Drill-Thru Report Type

Select the type of Drill-Thru report.

Drill-Thru Report

Select the data to display in the Drill-Thru report.

*: Only available on Column Reports.

Column and Line Glossary

There are many types of columns and lines. The list below describes the different types of columns and lines and which report type they can be used in:

Column/Line Type

Available for Report Type(s)

Description

Accumulative

Column Report - Trend, Line Report Trend

Displays the accumulated trends of the selected column or line.

Actual Usage

All Report Types

Actual usage is the amount of an inventory item that was actually used over some specified time frame.  It is calculated using the method: Beginning Inventory + Purchases +/-Transfers - Ending Inventory.

Blank Line

Line Report - Comparative, Line Report - Trend

Inserts a blank line in the report.

Calculated

All Report Types

Utilizes various equations to calculate the following:

  • # of Days in Month - Calculates the sum of the Number of Days in the Month.

  • Cash Sheet - Utilizes addition, subtraction, multiplication, or division to calculate a Cash Sheet Item over a specified time frame.

  • Constant - A fixed value in the report used in the calculation of the report.

  • Elapsed Days in Month - Utilizes addition, subtraction, multiplication, or division to calculate the Elapsed Days in a Month.

  • Prior - Utilizes addition, subtraction, multiplication, or division to calculate the chosen equation of a previously added column or line.

  • Reporting Item - Utilizes addition, subtraction, multiplication, or division to calculate a Reporting Item over a specified time frame.

  • Store Field - Utilizes addition, subtraction, multiplication, or division to calculate a solution for the Store Field.

  • Summation - Utilizes addition, subtraction, multiplication, or division to calculate the chosen equation of a previously added column or line.

  • Till Reconciliation - Utilizes addition, subtraction, multiplication, or division to calculate a Till Reconciliation Item over a specified time frame.

Cash Sheet

All Report Types

Displays a Cash Sheet Item in the report.

Deposit Detail

All Report Types

Displays the Deposit Detail in the report.

Ending Inventory

All Report Types

Displays the Ending Inventory Group/Items in the report.

Hourly Sales

All Report Types

Displays the Hourly Sales from a selected Time Frame in the report.

Ideal Usage

All Report Types

Displays the Ideal Usage Group/Items in the report.

Labor - Allowed %

All Report Types

Displays the Percent Allowed from the Previous Lane over a specified Time Frame in the report.

Labor - Department

All Report Types

Displays the Labor Department and Value Type over a specified Time Frame in the report.

Labor - Other Pay

All Report Types

Displays the Other Pay Type for Labor in a report.

Labor - Staffing Jobs

All Report Types

Displays the Staffing Job and Value Type over a specified Time Frame in the report.

Labor - Summary

All Report Types

Displays a summary of the Labor and Value Type over a specified Time Frame in the report.

Paid In/Out Account

All Report Types

Displays the Account and Type of Account in the report.

Product Mix

All Report Types

Displays the Data and Source Type in the report.

Projected Sales

All Report Types

Displays the Projected Sales Data over a specified Time Frame in the report.

Report Sales

All Report Types

Displays the Report Sales Value Type over a specified Time Frame in the report.

Reporting Item

All Report Types

Displays the Reporting Item in the report.

Solid Line

Line Report - Comparative, Line Report - Trend

Inserts a Solid Line into the report.

SOS

All Report Types

Displays the Stations and Data Types over a specified Time Frame in the report.

Store Field

All Report Types

Displays the Store Field in the report.

Till Reconciliation

All Report Types

Displays the Till Reconciliation Item in the report.

Time Punch Issues

All Report Types

Displays Issues with Time Punches in the report.

Waste/Promo

All Report Types

Displays the type of Waste/Promo and the Item Type in the report.

Report Examples

Report Designer allows users to create customized reports that track and evaluate daily operations of a site. The reports come in 4 base variations.

The examples listed below illustrate a basic view of each report type.

Column Report - Comparative

XBO_Column_Comparative_Original.png

Column Report - Trend

XBO_Column_Trend_Original.png

Line Report - Comparative

XBO_Line_Comparative_Original.png

Line Report - Trend

XBO_Line_Trend_Original.png