This article is a detailed guide on Reporting V2.

For a detailed list of Reports in Volante, please see: Reporting User Guide (PDF)

Accessing Reports

The Reports window can be accessed from the main page of the BackOffice.

Report Basics

The Volanté Reports window will be visible.

In previous builds of Volanté, this button was labelled with "Reports Ver.2" in order to distinguish it with Reports V1. In recent builds, this distinction was removed, and all new Reports are under Reports Version 1.

Left Side of Report Window:

Report Tree

Double-clicking any folder expands the tree structure and allows access to available reports.
- "My Reports" contains System Default Reports and Sample Reports (all Version 2 only).
  - Note that the System Default reports will consist of site-specific reports
- "System Reports" contains pre-defined reports created by Volanté.

Display Options

Select between 8.5" x 11" (A4) format or Receipt format.

Orientation Selection

Default Orientation - Will print to landscape view if there are more than 10 columns
Portrait - Will print to portrait view
Landscape - Will print to landscape view

This option is only applicable of 8.5 x 11 is selected

Report Style

User can select a report style template, which is provided by INetSoft report library. Default is "accounting"

Buttons

Generate: Generate and displays chosen report.
Expand: Expands Report Tree – use instead of double-clicking a folder
Refresh: Re-load Report Tree and Database. May be required to refresh while setting up customized reports
Store: Enables you to choose store in enterprise setting. Does not do anything in standalone or non-enterprise setting
Constraint: Mainly for debugging purposes. An user can open up this window to see constraint XML directly. User may print a report directly from this constriant XML, or an user may apply changed XML string to current report's setting.
Exit: Quit reporting module

Right Side of Report Window

Tabs

Across the top are tabs which can be used to create, filter, modify and run reports.

Main: Main default area for defining reports
Profit Center Filters: Tab used to create filters based on terminals, stores, employees and or customers
Menu Item Filter: Tab used to create filters based on menu items
Time Filters: Tab used to create filters based on time periods
Additional Options: Tab used for more options like group your report by employees, rearrange columns based on groups, export report to csv or pdf etc.
Customized Reports: Tab used to create customized reports

Main Tab

Report Time Chooser

Arrows: The up and down arrows will adjust corresponding time field
Date Field: Clicking a field (eg. "2011") will show a drop-down box with possible selections
"..." : Clicking the "..." beside 2011-09-27 will pop open a calendar allowing selection of a specific date
Day: Chooses 24-hours interval starting from current start time
Week: Chooses 7-days interval starting from current start time
Month: Chooses a month interval starting from current start time
Today: Chooses today's day start time as start time, and chooses 24-hours interval from then

Report Descriptions

Displays a detailed description of current report selected

For example, if the "System Summary > Net Sales > Grouped by Menu Items" report is selected, the following would be seen in the report description window

Available Report Settings

Displays enabled, selected filters, and/or grouped by options etc

Grayed out items are disabled options for currently selected report
Blue items are options selected
To view setting details of options selected click the Blue item and it will display more information in the "Setting Details" area

List By

Check box options that are the equivalent to "Group By" checkboxes in the "Additional Options" tab
Allow for reports to be listed or grouped by selected items

Profit Center Filters Tab

The Profit Center Filters tab is used to filter reports based on criteria like employees, terminals, stores, customers etc.

Create a Profit Center Filter Report

Choose your report.
Choose the options you wish to filter:
- Terminals: Filter between 1 or more POS terminal machines that are connected to your BackOffice software
- Stores: Only applicable on enterprise BackOffice servers. It allows you to filter by 1 or more stores.
- Employees: Filter by 1 or more employees
- Customers: Only applicable if you are using the CustomerDB module. It allows you to filter by 1 or more customers in your customer database.

Notes:

Default per area (Terminal, Stores, Employees, Customers) is the "All Selected" check box is selected – meaning that all items in the list are used in the report
If you select 1 or more items per area the "All Selected" checkbox is unselected and only the items selected are used in the report
Reselecting "All Selected" per area will empty current selection(s) and then all items on list are used in the report

Report Example:

Setup a report to filter based on 1 terminal, 1 store, a few employees, and all customers

Save a Profit Center Filter

You can choose to save a filter for easy re-use:

Select your desired filters
Click "Add New" and enter your desired name
Select "OK"

(Alternatively, you can "Add New" and then select desired filters, then "Save")

To view and re-use the saved filter click the down arrow and all filters will be listed, highlight and select:

Summary of a Profit Center Filter

Only saved Profit Centers will display summary information.

Select a saved Profit Center and then select the "Summary" Button. It will display a summary of the items selected in the profit center filter.

Notes:

Immediate changes are not displayed – to display immediate changes select save and then select the summary button
Areas that are have the "All Selected" checkbox do not display summary information.

Menu Item Filter Tab

The "Menu Item Filter" tab area allows for the filtering of reports by menu items.

Create a Menu Item Filtered Report

Select a report
Select Menu Items required in report
- By default all items are selected for reports – it is equivalent to selecting all
- Menu Item tree:
  - Organized via Root - Division - Group - Category - Menu Item
  - Selecting a parent item checks all of its children (i.e. Checking a category will check all menu items under that specific category)
  - Checking "Root" is equivalent to pressing "SelectAll" button,
  - Unchecking "Root" it is equivalent to pressing "ClearAll" button

Bottom Row of Buttons:

SelectAll: selects all menu items "ClearAll" Button clears all items
ClearAll: unselected all menu items
ExpandAll: expands all tree nodes (folder lists)
CollapseAll: collapses all tree nodes (folder lists)

Additional Note: In order to display report, you don't need to "Save" after changing your MI filter. It will apply changes immediately. (But changes do not save to the database automatically, unless you select "Save")

Save a Menu Item Filter

Select your desired filters
Click "Add New" and enter your desired name
Done

(Alternatively, you can "Add New" and then select desired filters, then "Save")

To view and re-use the saved filter click the down arrow and all filters will be listed, highlight and select.

Time Filters Tab

The Time Filter panel allows for the filtering of reports based on different time variables.

To create a time filtered report:

Select a report
Setup applicable "day part filter" and | or "day filter"
- Day part filter: creates a filter based on time(s) per day
- Day filter: creates a filter based on specific days
And if applicable, customize the time format

Day Part Filter

Create Set:

Type in a "Name"
Type in a "Description"
Click New Set

Create Day Part:

Click "Add New Day Part"
Pick desired time, and click "Ok"

Associate Set with Day Part

Select day part set
Select applicable day part definitions that you wish to include in that day part set.

Optionally

"Display each day in a new page" or "Display each day part in a new page".

Save Set Config

When done, you can display report, or if you want to re-use this filter, select the "Save Set Config" to save configuration of sets combined with day parts.
To re-use, simply select the Set and the associated day parts will automatically be selected.

Note: You can just select day part definitions without selecting day part set. This will behave as a "filter". Which means the report will be filtered by your selected day part time

Day Filter

Day filter is simply filtering per days of the week.

Selecting any one day filter by that specific day of week.

Note: Selecting nothing is equivalent to selecting everything

Customized Time Format

The time format area allows for the customization of how the time is displayed on the report.

For example:

Choosing the "yyyy-MM-dd HH:mm:ss" date and time format changes the format of Start Time column in the report.

Choosing the "hh:mm a" time format changes the format of Start Time column in the report

Common Date Short Forms:

Code	Translates to be	Examples
yyyy	4 digit year	"2011"
yy	2 digit year	"11"
MM	2 digit month	"01,02...12"
MMM	3 digit month	"jan,feb...dec"
d	1 digit day	"1,2...31"
dd	2 digit day	"01,02...31"

Common Time Short Forms:

Code	Translates to be	Examples
hh	2 digit hour (non-24 hour clock)	"01,02...12"
HH	2 digit hour (24 hour clock)	"01,02...24"
a	adds am or pm
mm	2 digit minute	"01,02...59"
ss	2 digit second	"01,02...59"

Advanced: In addition, a user may add their own time format.
- Open up Constraints WIndow
- Change time format field to something you want, and apply.
- This will update a time format checkbox with your definition.

Additional Options Tab

Additional options allows for non-standard, advanced customization of reports including:

Grouping By: Reports grouped by additional fields
Column Manage: Add additional columns, edit or delete columns, sort and limit # of records
Column Rearrange: Rearrange multiple value columns into single column
Data Customization: Allows for the addition of constraints and row grouping
Receipt View: Allows for moving around of grouped items on a receipt report.
Exports: Allows the exporting of reports to alternative formats like CSV, PDF, RTF, HTML
Advanced Options: Non-standard advanced report options, like "display PLU instead of Menu Item Name", "Remove Grand Total Row" etc.

Group By

Uses specified items to create report
You can choose items as many as you want.
Some reports may not allow grouping by certain criteria. If they are not allowed, checkbox will be gray out and you cannot choose.
There is a default order of group by columns. However, you can change the order from Column Management tab.

Example: Group By Terminal, Day Of Week and Group

Column Management

Column management allows for the ability to view, order, sort, add, edit and or delete columns displayed in reports.

Steps to use Column Management:

Choose report
Select Applicable Column Items
Modify Row Order

Choose a Report

Each report comes with predefined columns and rows.
By changing reports different editable columns and rows are displayed in the column management window.

Select Applicable Column Items

Column Name: shows the available column names per report you have selected and available for modifying
No Sort: if check box selected, this item would not be used in the sort order of the report
ASC: if check box selected, selected item is sorted by ascending order in the report
DESC: if check box selected, selected item is sorted by descending order in the report
Total: if check box selected, selected item is displayed with a total row in the report. If this field is not checked, total will not be calculated in "Grand Total" or grouping subtotal rows.

Note: There are two kinds columns display in the reports "Group Column" and "Fixed Column"

Group columns should come before fixed columns. You are not allowed to move fixed column before group columns
By default group columns are sorted by "ASC" and arenot checked as a total column.
By default fixed columns are not sorted, and checked as a total column
Grouping supports only group columns. It is not encouraged to have no group column, this is because in default we support "merge same group rows", so there will be only one row unless in special circumstances

Example: Group By Terminal, Day Of Week and Group

Example: Net Qty and Net Sales moved front, showing top 5 rows sorted by Net Sales in descending order

Example: Created a new column named Avg Group Price, which is Net Sales divided Net Qty.
- Do not include a new report column as a total column. Report columns Discount, Tax are removed.

Add and Modify Rows/Columns

How to order report columns:

Highlight a "report column".
Click top, up, down or bottom button to arrange a "report column" location.

How to sort report columns:

Check "No Sort", "ASC" or "DESC" for desired "report column"

Note: If multiple "report columns" are sorted, the sort priority will go to the first "report column" which is sorted

How to limit number of rows:

Fill out a number in "Row Limit" text box
The report will show top # items. This will be useful when you want a report like "Top # groups based on Net Sales amount"

Note: If field is 0 or negative or empty, it will be ignored and display all

How to edit a report column:

Highlight a "report column"
Click "Edit" button. This will pop-up a new window.
Change report column configuration, and "Submit" to apply change

How to add a report column:

Click "Add New" button. A new "Add Column" window will pop-up.
Enter in the Column Name.
Set the Column Type.

Column Formulas

Users can customize the the data being displayed in each column using the Formula field. Users can make use of freemarkers or variables when writing formulas, indicated in square brackets. These act as placeholders for actual values, and can be used in conjunction with operator symbols to perform calculations.

If using freemarkers, take note of the following:

Users will need to know which fields are available from the report class in order to design your formula.
1. For example, users can use [Amount] variable, and a numerical value, such as ["1"]. This will use values from an existing "Amount" column, and the "1" will be indicated exactly as "1".
2. Users can then write formulas involving operators (such as +, -, etc.) to calculate the final value to be displayed.
Indicate the Symbol (i.e. currency marker or measurement) to be used with the value, if applicable.
Indicate the number of Decimal Places for the displayed value to be truncated to.
Change report column configuration, and "Submit" to apply all changes.
A new report column will be added at the end (indicated in the rows of available columns). Users may also rearrange newly created report columns from this listing.

Some formulas are only available when a group by customer is used. For formulas details see:
/wiki/spaces/IS/pages/63351202

Quantity/Total of Transactions

For example, a formula can be used to indicate the "Quantity of Transactions" of a specific transaction type.

How to remove a report column:

Highlight a "report column"
Click "Remove" button to remove a "report column" from a table

Note: Clicking "Reset" button will restore report default columns

Summary Col:

Summary col is Summary column and is basically a total column which works in column-wise. When this option is checked, there will be an extra column at the end which adds up all columns which is checked as "Total column".

Advanced: How to design a formula

Report column formula is a core of report customization
You can view formula by putting mouse pointer over on a specific report column name, or in "Edit" window
Acceptable column formula format is as follows:
- (Formula) = (Item) OR (Item)(Operator)(Formula)
- (Item) = (Column) OR (Constant) OR (Aggregate)
- (Aggregate)= sum[(Column_Name)] OR avg[(Column_Name)] OR min[(Column_Name)] OR max[(Column_Name)]

Where:
- (Operator) = + OR - OR * OR /
- (Column) = (Column_Name)
- (Column_Name) is any column name
- (Constant) = (Value)
- (Value) is any string surrounded by quote (ex. "1")

Note:

Constants and columns must be surrounded by square brackets in order for the reports to generate custom values (ex. ["Constant"] and ["Column_Name"])
If there are multiple operators, it strictly processes first one first (i.e. There is no "()" for prioritize calculation order)
-, *, / operators only works with NUMBERS. STRING types only work with + operator.
Example: col1 * "123" will result to empty string regardless of value of col1
NaN is shown as "N/A" (When any value is divided by 0)

Examples:

col1 + col2 is acceptable
col1 + col2 is unacceptable
col1 + "---" is acceptable
col1 / sumcol1 is acceptable
avgcol1 is acceptable

Special constant: ["LINE_BREAK"]

"LINE_BREAK" will put a line break within the report. That means, it will allow us to generate 2 line rows.
Take a look at System Reports > Transaction Listing > Transaction Payment Listing by TransID report for example

Column Rearrange

This option re-arranges report columns. To use this option, you must modify one of the following (you cannot choose both):

Rearrange Multiple Value Columns into Single Group Column

OR

Rearrange Single Group Column into Multiple Columns

Rearrange Multiple Value Columns Into Single Group Column

When this option is activated, all fixed column names form a new group column and the values of fixed columns are vertically arranged in single column.

For example, select the following:

Select Report = Grouped by Groups
Enable = 'Tick' (select check box)
New Grouping Label = "Grouping" or whatever you wish to call your new column
Run your report by clicking the "Generate" button

Original Report Looks like...

After "Rearrange Multiple Value Columns Into Single Group Column"

"Use Last Group Column As New Labels"

If this option is enabled, the report will use the last group column as new fixed column labels instead of just making one column. This is equivalent to swapping row and column labels.

For example, select the following:

Select Report = Grouped by Groups
Enable = 'Tick' (select check box)
New Grouping Label = "Grouping" or whatever you wish to call your new column
Select "Use Last Group Column As New Labels"
Run your report by clicking the "Generate" button

Original Report Looks like...

After "Rearrange Multiple Value Columns Into Single Group Column" + "Use Last Group Column As New Labels"

Rearrange Single Group Column Into Multiple Columns

When this option is enabled, the system picks one fixed column value "eg. Net Sales" and arranges the last group column as multiple fixed columns, so that you can view report as "group col 1 vs. group col 2"

For example, select the following :

Select Report = Grouped by Categories and Groups
Enable = 'Tick' (select check box)
Data Column Name = select one available from the drop down list like "Gross"
Run your report by clicking the "Generate" button

Original Report Looks like...

After "Rearrange Single Columns Into Multiple Column"

For Advanced Use Only

Column rearrange does not work if there are multiple rows for each unique set of group columns.
In that case, you can create a number label. A number label is an extra group column created temporary to make each set of group columns unique.
Optionally, you can check "Make Number Label Visible" option to count # of rows for each unique set of group columns.

Data Customization

In this area, filters can be added to:

Add constraints to reports
Group rows together within column
Add filters in Audit logs.

Adding Constraints

Select a report
Select the "enable" check and enter the constraints per line
- Pick a column which constraint is going to be applied
- Pick operator
- Enter a value to constraint.
Add up to 5 constraints at the same time

Available operators:

"h1. " : equal to
"!=" : not equal to
>= : greater than or equal to
> : greater than
<= less than or equal to
< : less than

Wildcards:

"*" matches 0 or more characters (any character)
"?" matches any 1 character
"@" removes case sensitivity (can be anywhere)

Note:

>=, >, <=, < only works with columns with type Integer, Double and Timestamp
In order to use or != constraint, you have to use format |Item||Item|...
To compare timestamp, you should enter time in following format - "MM-dd-yy HH:mm:ss.SSS"
- Example: 01-14-11 18:30:34.000 would be 2011 Jan 14, Hour 18 Minute 30 Second 34 Millisecond 000

For example, set the following:

Select Report = Payroll Employee
Set Constraints:

1. Shift Start is "less than or equal to" a TimeStamp ("MM-dd-yy HH:mm:ss.SSS")
2. Employee is "equal to" Employee Login Names ... in our example |Carlos Jaramillo|Janet Miranda|Eliot Lopez| (note the |bars| surrounding names)
3. Regular Hours is "greater than"to time period
4. Job Type is "not equal to" a Specific job type ... in our example using the name |Crew Member| (note the |bars| surrounding names)

Row Grouping

Select a report
Select the "enable" check and enter the constraints per area
- Pick the column which constraint is going to be applied. Only grouping columns are available to group
- Pick grouping value
- Pick values to be grouped

For example, set the following:

Select the report Net Sales > List of Terminals > Grouped by Categories
Set Constraints:

1. column to be grouped is Terminal, group as "StoreA", grouping the values "|pos1|pos2|
2. column to be grouped is Terminal, group as "StoreB", grouping the values "|pos3|Primary|
3. column to be grouped is Terminal, group as "StoreC", grouping the values "|testSuse10|

Original Report looks like:

After combining rows in the Terminal Column it looks like this:

Audit Log Filters

Allow for filtering of Audit Log Reports.

Select an Audit Log Report
Select the "Audit Log Filters" button (from the Additional Options tab).

Audit Log Report Filters available for selection. You can select any or all that you would like to filter by.
Click "Save & Close" to save selections and then proceed to run (generate) the report

Receipt View

In this view, you can configure which columns are to be used on receipt print view, and their display names.

For example, select the following:

Select the report
Look at "Original Column Name" which refers to a column name on Column Management tab and compare with the "Receipt Column Name" which is the column name used when printing on receipt format reports.
Change the Receipt Column Name by double-clicking the name and change from "Category" to "Cat"
Change the order by "Top", "Up", "Down", "Bottom" buttons.

Notes:

"Show All" - shows all available columns of the report
"Reset" - restores to default order of columns to print

Maximum Number of Columns Printed Per Report:

4 columns of information
5 columns Non-IP Printers and columns 2,3,4,5 are all numbers
6 columns Non-IP Printers and columns 1,2,3,4,5,6 are all numbers

(Non-IP printers are slightly wider paper output)

Receipt View Specific Flags

SHOW_ON_TOP - Show this column on top of each grouped-by entries
SHOW_ON_TOP_LB - Show this column on top of each grouped-by entries immediately following a newline
%DATA% replaces data
%NL% replaces newline
Example: Time And Attendance > Employee Shifts and Cash Float > Employee Shifts with Cash Float report

Exports

In this area you can setup export-related settings.

Export Options

Supported Formats:

CSV
PDF
RTF
HTML

Report Time:

Use Main Panel Report Time - uses the time selected on the "Main Tab" for basing report information
Continue From Last Export Time - continues from the last time period used for reporting information to selected time period.

Time choices are:

- Set time choices "1 Day", " 2 Days", "7 Days" or "1 Month"
- Until = which requires a manual end time period where the time format is MM-dd-yy HH:mm (For example 03-17-11 11:05)

Export File Name:

Enter file name of export
Append Time Stamp allows the ability to append a time stamp to the file name – requires a time format
Clicking a button "Update File Name Sample and Expected Report Time" will show you a sample file name generated and what will be next report time (if "Continue From Last Export Time" is selected)
"Hide Header Row" will not include header row (for CSV format only)
Exported files are stored in the export directory of volante home directory (For example windows = c:\volanteV4\Exports or linux = /home/volante/volanteV4/exports)

Note: In the "Export File Name" field "[REP]" is a token and replaces a report name replacing " " with "_".

For example, If a report name is "Free Pour" then "[REP]" replaces to "Free_Pour"

Export History

For each export, the system will generate an export history entry, which allows you to re-do previously executed exports. The system will show the 100 most recent history entries, sorted by generation time. To re-execute export, highlight a row, and hit "Export Previously Generated Report"

Notes:

By select "Export Previously Generated Report" this will NOT create an extra history entry
The file name timestamps, will be PREVIOUS generation time. (i.e. it will NOT be current timestamps)
History from previous version exports will not show in the list therefore you cannot export histories from PREVIOUS VERSION of export here.

Advanced Options

Advanced options are a set of configurable options. Certain options are only can be applied on certain type of reports. If they are available for the report selected the buttons will be enabled.

Show Options As Separate Entry as Item

Available in Sales ONLY
When this option is enabled, Option entries are shown as separate entry under group "Options". (ex. Salad 3.00 - Extra dressing(option) 0.50)
When this option is not enabled, Option entries are included in their parent items. (ex. Salad 3.50)
Users will not see the difference unless they group by or filter Groups/Categories/Menu Items

Use Separate Timestamps for Each Item

Available in Sales or Media Reports
When this option is enabled, we use enteredTime field for each transaction item instead of using transaction close time.

DEVELOPER NOTE: currently this takes extremely long because TI.enteredTime is not indexed – working on this process.

Use Server Information for Each Item

Available in Sales or Media Reports
When this option is enabled, we use enteredServerId field for each transaction item instead of using transaction serverId

Consider PMS (Property Management System) Transactions Only

Available in Sales Reports
Shows only transactions that went to hotel interface

Display Options

Transaction Details Reports Only
Displays the option items ordered per transaction

Show Only PMS (Property Management System) Transactions

Transaction Details Reports Only
Shows only transactions that went to hotel interface

Show Price Mods In Detail

Transaction Details Reports Only
Displays price modification details per transactions

Add PC and MI Name on Table

Customized Reports
This option will show PC / MI name on first group column. There will be only one entry because we can only choose one PC / MI at a time
For customized reports, we can put multiple reports together with different PC / MI selection, which will give a look like groupby.
Alternatively, there is a pre-defined report that lists by PC / MI (See System Reports - Net Sales)

Display PLU instead of Menu Item Name

This option will display PLU instead of MI Name

Display Both PLU and Menu Item Name

This option will display both PLU and MI Name.

Remove Grand Total Row

This option will remove a grand total row on bottom of a report

Remove Grouping Support

This option will remove grouping support. (No subtotals for each group columns)

Do Not Merge Same Group Rows

This option will not merge same group rows. By default, the report automatically merge report data if some rows have same group columns
If a report doesn't show any rows where it should show, checking this option may fix the problem.

An example of Net Sales grouped by terminals and groups:

An example of same row grouping configuration with "Do Not Merge Same Group Rows" flag on:

Remove Duplicated Group Entries

This option will remove duplicated group column entries.
This option is only relevant when "Do Not Merge Same Group Rows" option is enabled otherwise there won't be any duplicated group column rows

Report before applying option:

After:

Use Custom Rule File (Advanced Use Only)

This option enables you to use custom rule file to customize the report further
Once you set up a variable, it can be used continuously until the application is terminated
For multiple values, format is |VALUE1||VALUE2||VALUE3||....
Command List:
- SETVAR:<VARNAME>:<VALUE>
  - Assigns <VALUE> to <VARNAME>
  - Multiple entry using | accepted
- SETVAR:<VARNAME>:<MATCH_COL>:<ROW_NUM>
  - Assigns single value to <VARNAME>
- SETVARLIST:<VARNAME>:<DATA_COL>:<MATCH_COL>:<MATCH_VALUE>
  - Assigns list of values to <VARNAME>
  - <DATA_COL> is a name of target column to get data from
  - <MATCH_COL> is a name of column to apply match condition
  - <MATCH_VALUE> is a matching condition to get data
    - Wildcards accepted
    - Multiple entry using | accepted
- HEADER:<VALUES>
  - Writes column headers
  - Multiple entry using | accepted
- LABEL:<VALUES>:<START_COL_NUM>:<TARGET_ROW_NUM>
  - Puts labels on specified column and row
  - If there are more than one value, values will span multiple rows
  - <VALUES> is values to put
    - Multiple Entry using | accepted
- LABELACR:<VALUES>:<TARGET_COL>:<START_ROW_NUM>
  - Same as LABEL, but it will span across columns when there are multiple values
  - If there are more than one value, values will span multiple columns
  - <VALUES> is values to put
    - Multiple Entry using | accepted
- SINGLEMAP:<DATA_COL>:<MATCH_COL>:<MATCH_VALUE>:<COL_NUM>:<ROW_NUM>:<DEFAULT_VALUE>
  - Similar to MAP, however SINGLEMAP will behave as follows
  - <DATA_COL> and <MATCH_VALUE> cannot use wildcards
  - <DATA_COL> and <MATCH_VALUE> multiple entries show exactly in same order
  - Any unassigned value will be replaced with <DEFAULT_VALUE>. If it's not specified it will be blank
  - <DEFAULT_VALUE> is optional. It will be blank if not supplied
- MAP:<DATA_COL>:<MATCH_COL>:<MATCH_VALUE>:<COL_NUM>:<ROW_NUM>
  - <DATA_COL> - Column name that holds data
    - Wildcards are accepted
    - Multiple Entry using | accepted
    - When there are multiple results, it will span more than one columns
    - You cannot use column numbers
  - <MATCH_COL> - Column name that is being checked for conditions
    - Must be exactly one column
  - <MATCH_VALUE> - Value in <MATCH_COL> that is checked as condition. If condition matches then data is grabbed
    - Wildcards are accepted
    - Multiple Entry using | accepted
    - When there are multiple results, it will span more than one rows
  - <COL_NUM> - Column number that is maps value to
    - Could limit column range using #-# format (Ex. 3-5 will limit columns 3 to 5. Anything beyond column 5 will be discarded)
  - <ROW_NUM> - Row number that is maps value to
    - Could limit row range using #-# format (Ex. 3-5 will limit rows 3 to 5. Anything beyond row 5 will be discarded)

Customized Reports Tab

The Customized Report Tab allows for the configuration and customization of report sets.

All customized reports are seen under the folder "Report Tree" in the "My Reports" area. A blue tree node indicates a set of customized reports and beneath it all attached individual reports.
Customized report can be printed as a set or individually.

Basic Steps:

Create a Customized Report Set
Add Details - include 1 or more reports
Select or Configure Options as required – Profit Center, Menu Item Filter, Day Part, and or Page Breaks

Create Customized Report Set

Fill out customized report name and description (Report tree path can be blank).
Click "Add New" (Report tree should be refreshed)

Add Details

Add individual reports.
- Highlight any system report on the left panel Report Tree that you want to include
- Click transfer button (right-arrow button)

Configure Options if Required

Profit Center
Menu Item Filter
Day Part
Page Break (Six page break options)
- Default – Each report is display individually one after an other on the page
- No Break – Each report gets appended to the one above without a break. It is recommended that both reports have same number of columns
- Line Break – Similar to no break, but instead it puts a blank line between two reports
- New Page – Displays a report in a new page
- Append Columns – Append reports side by side
- Merge on Place – For advanced use only. Merge second report on top of first one. Default delimiter is ",". Used efficiently with custom rule files.

Once customizing is done, you can display report, or save for further use.

Related Articles

Page:

Report List - V.1454 and Lower
Page:

Reporting Module in BackOffice (V2)
Page:

Close Day Reports
Page:

Report List
Page:

Reporting Quick Guide
Page:

Media Reports
Page:

Report List - Version 1760+
Page:

Sales Reports
Page:

POS Web Services API - Reporting
Page:

Cash Drawer Reporting
Page:

Reporting User Guide (PDF)
Page:

Close Day Reports - Report Detail Calculations
Page:

Terminal Setup Guide (PDF)
Page:

Custom Formula Formating
Page:

Reports Reference Guide (PDF) - Reports Listing

See Also:

Troubleshooting Articles

Browser not supported