Filters in a widget

The Filters tab of the widget builder decides two things: which dates the widget covers, and which sales (or tickets, or bookings) it counts. This is for venues whose sidebar shows Reporting — see Build a widget for the rest of the builder.

Filters decide what counts, never what's shown. A rule like "Category is Mains" leaves out everything that isn't Mains; it does not put categories along the bottom of your chart. To show one bar per category, put Category on the X-axis (or in Break down by) on the Chart tab instead.

Dates

Pick a period — Today, Yesterday, Last 7 days, Last 4 weeks, Last 12 months, This week, This month, This year — or Custom to choose your own start and end dates.

Tick Compare with the period before to draw the previous period in grey beside it, then choose The period before or Same time last year.

Dates follow your trading day: if your business day runs past midnight, a sale at 1:30am counts on the night before.

On a dashboard, the dashboard's own time frame and comparison (in the bar at the top of the page) take over, so every widget on it covers the same period.

Only include … where

Under the dates is the line Only include sales where (it names the kind of data your widget is built on). Below it, add rules.

1. 1

   Press Add a rule

   Pick what the rule is about — Category, Product, Staff, Site, Payment type, Station and so on.

2. 2

   Choose is any of, or is none of

   is any of keeps only what you tick. is none of keeps everything except what you tick.

3. 3

   Tick the values

   Search the list and tick up to 50. The rule then reads as a sentence, like "Category is any of Mains, Starters".

Press a rule to change it, or its cross to remove it. A widget can hold up to ten rules, one per grouping. With none, it reads Counting everything.

All rules match, or any

With two or more rules, choose between:

• All rules match — a sale must pass every rule (Mains and paid by card).
• Any rule matches — passing one is enough (Mains or paid by card).

Rules on Site sit apart, under Sites always apply: whatever you choose above, the widget only ever counts the sites in those rules.

Filtering bill numbers by product or category

Some numbers belong to a whole bill (how many bills, how many guests), and some belong to each item on it. A rule on Product, Category or Staff is about the items, so a bill number changes meaning under it — and the builder tells you how, in a line under your rules.

• Counts of bills keep working, and say so. With the rule "Category is Mains", you will see Transactions now counts bills that contain Mains. Bills with no Mains on them are left out; bills with one Mains and three drinks count once. If you renamed the number in the widget (say to "Bills", with Name on the chart), the line uses your name: Bills now counts bills that contain Mains. The chart and its table do too.
• Net sales and Sales can't be filtered by product. Both are worked out for the whole bill, the way your classic reports add them up (Net sales takes refunds and VAT off the bill as a whole), so neither can be cut down to the Mains part of a bill. The builder says Net sales can't be split by category and offers a button, Use Item sales, that swaps it for Item sales in one click, keeping its colour and scale.
• Item sales is what each item sold for after its share of the bill's discount, VAT in, tips left out — so it can be filtered, grouped or split by product, category or staff. It is what the classic Product performance report calls Revenue.
• Discounts and Returns have no item-by-item version, so the builder just says they can't be split by product. Take the rule off, or take that number off the widget.

Item sales only shows for venues with Reports Plus.

When a rule isn't offered

A grouping is greyed out, with the reason under it, when one of your numbers can't be counted by it — for example Not in Wastage when you mix wastage into a widget and pick a grouping wastage doesn't have. See Mixing kinds of data.

If a value you picked has since been renamed or deleted, the rule shows No longer listed for it. Open the rule and untick it.