Tickett Enterprises Limited
Custom Reports
Clover App User Guide v1.14
2-10-2017
Contents
First Time Use .................................................................................................................................................................... 2
Fields ............................................................................................................................................................................. 2
Buttons .......................................................................................................................................................................... 3
Screengrabs of the popups that can be displayed ........................................................................................................ 4
How to Set Up a Report .................................................................................................................................................... 5
Customised Grouping.................................................................................................................................................... 5
Top level groups generally employee information ....................................................................................................... 5
Second level groups: Item information......................................................................................................................... 6
Second level groups: Payment information .................................................................................................................. 7
Notes on the Limitations of Customised Grouping ....................................................................................................... 7
Future Groupings .......................................................................................................................................................... 8
Preloaded Report .............................................................................................................................................................. 9
Example of the Preloaded Report Settings ................................................................................................................... 9
Reading the Preloaded Report .................................................................................................................................... 10
Other Report Examples ................................................................................................................................................... 11
1
First Time Use
When you first open the Custom Reports App you will be greeted with the screen shown below:
1: First Time Use Display Screen
Fields
Merchant ID and API Token:
This is the merchant that the Report will be run for, they are populated by the get MID + Token
button.
Device:
Device should default to “All devices”, it is a drop down so you can also select a device off its name
or serial and report only on that device.
Start Date:
The start date is the day that the report will be run for. Click the date to open the calendar and pick
a date to run a report.
2
Group1:
Group1 is the top level of grouping for the report. It defaults to Employee Name when first opened.
This means that all orders are going to be grouped up by the Employee who processed the order.
Group2:
This second level of Grouping allows for a more detailed breakdown. There is group2a and group2b
available for use. Information on the defaults are below, for more detailed information please see
the “Customised Grouping” section.
Group2a defaults to Item name, with quantity price and total in brackets next to the name, this will
group the items by their name. Then provide details on quantity and price alongside it.
Group2b defaults to Payment tender, again providing details on quantity and total, this provides the
number of transactions the employee made, whether they were cash, card etc.
Buttons
Get MID + Token:
Get MID + Token will load the merchant ID and API Token for the current user.
Load Settings:
Load Settings will display a box to load a previously saved Merchant ID, API Token, Group1 text,
Group2a text and group2b text by choosing a profile name.
Save Settings:
Save Settings will display a box to save the Current Merchant ID, API Token, Group1 text, Group2a
text and group2b text under a profile name.
Reload Devices:
Reload Devices will reload devices attached to the Merchant ID.
Run Report:
Run Report will build and display a report on Screen with the current selected settings.
Print Report:
Print Report will print the currently displayed Report.
3
Screengrabs of the popups that can be displayed
4: Pop up shown when saving a profile
2: The calendar shown when clicking on start date
3: Popup shown when loading a profile
4
How to Set Up a Report
To set up a report the first step is to set up the Merchant ID and API Token. For Information in finding your
merchant ID and setting up an API Token please see the previous ‘First Time Use’ section.
Customised Grouping
Custom Reports provides numerous ways of sorting your reports by replacing certain key values with
information from clover. Below is a full list of Key values that are replaced with information from Clover:
Top level groups: Generally Employee Information
#ont: This is replaced by a ‘y’ or an ‘n’ depending on if the order had an order note attached.
Uses: Used to display whether or not a note was attached to an order. Needs to be used in conjunction with
another key value. It does affect grouping so will separate orders with and without notes.
%ont: This is replaced by the note attached to the order.
Uses: Used to display the contents of a note on the order.
%ena: This is replaced by the employee name the order is attached to.
Uses: Used to display employee name, this affects grouping so each unique name will be a separate group.
%enn: This is replaced by the employee nick name that the order is attached to.
Uses: Used to display employee nickname, this affects grouping so each unique nickname will be a separate
group.
%eid: This is replaced by the employee id that the order is attached to.
Uses: Used to display employee ID, this affects grouping so each unique id will be a separate group.
%erl: This is replaced by the employee role that the order is attached to.
Uses: Used to display employee role. , this affects grouping so each unique role will be a separate group.
Top Level Groups: Date and Time
%dtXX/XX/XX%: This is used to show the date or time, depending on what follows %dt (see below).
These MUST be closed by a % once opened. Each variable can be separated by ‘.’ or ‘/’.
%dtd%: This is used to show the date the order was made.
Example: if it was made on the 10th Feb, the number ‘10’ would be shown.
%dtKa%: This is used to show the hour the order was made in AM/ PM.
Example: if it was made at 1pm (13:00), ‘1pm’ would be shown.
%dtK:ma%: For a more precise outcome – shows as 1:12pm.
%dtE%: This is used to show the day the order was made.
Example: if it was made on a Friday, ‘Fri’ would be shown.
%dty%: This is used to show the year the order was made
Example: if it was made in 2017, 2017 would be shown.
5
%dtw%: This is used to show the week within the entire year that the order was made.
Example: If it was on w/b 6th Feb, it would be the 6th week.
%dtW%: This is used to show the week within the month the order was made.
Example: If it was on w/b 6th Feb, it would be the 2nd week.
%dtM%: This is used to show the month of the year that the order was made.
Example: If the order was made in February, ‘2’ would be shown.
%dtz%: This shows the time zone for the area the order was made.
Example: If the order was made in Great Britain, ‘GMT + 00:00’ would be shown.
Second level groups: Item information
%mod: This is replaced by item modifications on an item.
Uses: by default modifications are shown as separate items, %mod will instead put the modifications on an
item in one block.
%inm: This is replaced by the item name in the order.
Uses: Used to display the name of each item in an order. This will affect grouping, so each unique item name
will be a separate group.
%ibn: This is replaced by the item bin name in the order.
Uses: Used to display the bin name of each item in an order. This will affect grouping so each unique bin
name will be a separate group.
%ipr: This is replaced by the item price in the order.
Uses: Used to display the price of each item in an order. This will affect grouping so each unique price will be
a separate group.
%iut: This is replaced by the unit quantity of the item.
Uses: used to display the unit quantity of each item in an order, this will affect grouping so items with
different unit quantities will be displayed as separate groups.
%itot: This is placed by the total cost of items.
Uses: Used to display the total cost of items. This does not affect grouping and needs to be used in
conjunction with another %i key value *this will be removed in 1.15 – changed to %tot
%iqty: This is replaced by the number of items.
Uses: Used to display the total quantity of items. This does not affect grouping and needs to be used in
conjunction with another %i key value. *this will be removed in 1.15 – changed to %qty
%ilb: This is replaced by the item’s label.
Uses: Used to display the labels of items. For example if a cup of coffee was sold with the label ‘Hot Drinks’
applied, then Hot Drinks would show up.
6
%ict: This is replaced by the item’s category.
Uses: Used to display categories of items that have been sold. For example if some cake was sold under
‘Dessert’, Dessert would be shown.
Second level groups: Payment information
%pam: This is replaced by the payment amount for the order.
Uses: Used to display the payment amount in an order. This will affect grouping so each unique amount will
be a separate group.
%pta: This is replaced by the tax amount for the order.
Uses: Used to display the tax amount for each payment in an order. This will affect grouping so each unique
tax amount will be a separate group.
%ptn: This is replaced by the tender type for the order.
Uses: Used to display the tender for each payment in an order. This will affect grouping so each unique
tender will be a separate group.
%ptot: this is replaced by the payment total.
Uses: Used to display the total payment. This does not affect grouping and needs to be used in conjunction
with another %p key value. *this will be removed in v1.15 – Changed to %tot
%pqty: this is replaced by the payment quantity.
Uses: Used to display the quantity of payments. This does not affect grouping and needs to be used in
conjunction with another %p value. *this will be removed in 1.15 – changed to %qty
%tot: This is replaced by the total of payments and items.
Uses: Used to display the total of payments and items.
%qty: This is replaced by the total of payments and items.
Uses: Used to display the quantity of payments and items.
Special groups:
%smo: Combine Modifiers
Uses: This displays the modifiers all as one item. For example if somebody buys a pizza with 5 extra
toppings, the subtotal of those toppings will be displayed as one item.
%sta: Split out Tax
Uses: Used to display tax as a separate
%stp: Splits out Tips.
Uses: Used to display individual tips, and if they have been refunded or not, in addition to the rest of the
.
money paid.
7
Notes on the Limitations of Customised Grouping
A limitation of building a custom report is imposed due to the nature of how data is stored by clover. It is not
possible for us to support a report grouped by item information at the top level and payment information on the
second level.
This is because it is possible to have both multiple items and multiple payments linked to a single order. We can link
items and payments back to the order they are attached to, but we cannot link a specific payment to a specific item
and vice versa.
Another implication of this is reporting on refunds. Refunds only contain information for the original payment or
item that was refunded. This means that for item refunds we cannot accurately report which payment they are
associated with, likewise if a payment is refunded we cannot accurately report which items were refunded.
The final limitation is that refunds do not store their own tender information. While we await assistance from clover
with this issue we advise that refunds are issued in the same tender as the original order to ensure accurate
reporting.
For assistance on building the custom report that best suits your needs please enquire at [email protected].
Future Groupings
We are always looking to expand the list of fields we support in custom reports, if there is a field you would like to
see on this list please send enquiries to [email protected]
8
Preloaded Report
Custom Reports has a standard preloaded report that comes preloaded that also runs if the group fields are left
blank.
Example of the Preloaded Report Settings
The preloaded report uses the settings:
Group1: Employee: %ena
Group2: %inm (%iqty x %ipr = %itot)
Group2: %pqty x %ptn (%ptot)
The image on the left is an extract from the report,
at the top it displays “Employee: Joe Bloggs”
Group1: Employee: %ena.
%ena was replaced with the employee name on every order for the day.
This means that every order joe blogs is responsible for is on this extract.
Group2: %inm (%iqty x %ipr = %itot)
%inm was replaced by the item name and %ipr by the item price.
This means that every Tea sold for £1.25 appears on the same line.
%iqty and %itot were replaced with quantity and total, the ‘ ( x ) = ‘ were
not replaced, this is what produced the line Tea (2 x £1.25 = £2.50) Only
the key values have been replaced. Everything else has remained in
place.
Group2: %pqty x %ptn (%ptot)
%ptn has been replaced with the tender (cash, check, card)
%pqty and %ptot were replaced with the quantity and total, while like
before ‘ x ( ) ’ were not replaced leading to the line 4 x Cash(£8.75) Like
before only the key values are replaced allowing for customised display.
9
Reading the Preloaded Report
Using the same extract again. The first section tells us the employee who
carried out the orders.
The next section breaks down the items. We can see one burger was sold
for £8.50, one coffee for £1.25, two pancakes for £5.00 etc.
The next section shows us the total number of items sold and the total 9
items for a total of £26.75 the total number of items refunded and the
total price 0(-£0.00) finally it displays a grand total sold – refunded.
The next section breaks down the payments taken 4 cash payments for a
total of £8.75, 1 check for a total of $7.75 and a credit card payment of
£10.25
The final section for the Employee shows the total payments 6 payments
for a total of £26.75 the total of refunded payments 0, and finally a grand
total of taken – refunded.
The last section is not part of the Employee section it’s the total amount
and Quantity for the entire report.
10
Other Report Examples
Below are a few examples of reports that can be generated using different combinations of key codes.
5: In the above report the %mod key has been used to add the modifications to the item.
11
6: In this report %mod was excluded so modifications are treated as separate items.
12
7: In this report our group1 was %inm and group2a %ena(%iqty). This shows us that ham was sold a total of 3 times, once by Jane Doe and
twice by Tickett enterprises.
13
8: In this report you can see the day shown, as well as the updated %qty and %tot.
14
9: In this report you can see the tax, tips, and total are separated by using %stp and %sta within the special field.
15