Report Property Sets
newspaper Report Property Sets drive the contents of all Reports and Live Insights. A Report Property Set specifies sub-sets of:
- Properties reported for each widgets Position in the display
- Aggregates (calculations performed across all positions in the display, such as Total Cost)
- Breakdowns, which report on percentages of properties in relation to some other parameter(s), in table, pie chart, and/or bar chart form
Users may define as many Report Property Sets as they wish. Admins may define public Report Property Sets, which all users can then use for reports. Non-admins may define private Report Property Sets that only they can use for reports.
Editing Report Property Sets
There are two ways into the editor:
- File → Export → Report, then the edit Edit Sets button above the list of sets.
- The edit button beside the Report Property Set dropdown in the insights Insights panel.
Either way you land in the same dialog, where you can modify an existing set or create one with Create Set. New sets start empty, so the first thing to do is add Properties.
If you are an admin of a Report Property Set, you can rename it and customize its Users, who can see and use the set, and Admins, who can modify it.
Saving your changes
Edits are held until you commit them. Save Changes writes them, and Undo Changes throws them away and reloads the set as it was last saved. Both buttons appear only while there is something pending.
While changes are pending you cannot switch to another set or create one, and closing the dialog asks whether you want to discard your work. Set names must also be unique, so saving under a name already in use is rejected.
Delete Set removes the Report Property Set entirely. It asks for confirmation first, and it cannot be undone.
Every row shares the same controls
Properties, Aggregates, and Breakdowns each live on their own tab, but the rows behave identically on all three.
- Name is what your users see in report output. Leaving it blank falls back to showing the expression itself.
- The calculate button beside the expression switches that row between a straight one-to-one mapping, chosen from a dropdown of fields, and a typed Calculation. Breakdowns have no single expression, so there the button sits on each metric instead.
- The visibility_off button hides the row. Hidden rows are not offered in the Create Report dialog at all, which is the way to retire something without deleting it.
- keyboard_arrow_up keyboard_arrow_down reorder the row, and reports follow that order.
Properties
Report Property Sets can have any number of Properties, which are evaluated separately for every item in a report.
A Property maps either to a single catalog field or Dynamic Field, or to a custom calculate Calculation such as width * height.
Aggregates
Report Property Sets can have any number of Aggregates, which are calculations performed across all widgets Positions in the display (such as Total Cost or Average Price).
Aggregates are always mapped to a custom calculate Calculation. These calculations must contain an aggregate function. The currently supported aggregate functions are Sum() and Avg().
Breakdowns
Report Property Sets can have any number of Breakdowns, which report on percentages of properties in relation to other parameters. Breakdowns can be expressed as tables, pie charts, and bar charts when included in reports or insights Live Insights.
Each Breakdown divides the display by a catalog field or Dynamic Field (the "Segments") and measures each segment against one or more "Metrics". The editor reads as a sentence, Each category as a % of, followed by one row per metric. The example above reports, for every category, what share of the rack's area and of the inventory cost that category takes up. Each metric becomes its own column in the table and its own series in the chart.
- Add metric adds a row. Pick a field from the dropdown, or use the row's calculate button to type an expression instead (see below).
- delete removes a metric. A Breakdown needs at least one, so the button is hidden while only one metric is set.
- gives a segment or metric a display name, covered below.
Expression metrics
A metric does not have to be a single field. With the calculate button on, the row takes a Calculation that is worked out for every Position and then totaled, so each segment's share is a share of that total.
This matters for per-unit fields. cost on its own counts each
product once, however many facings it has. cost * FacingsTotal weights it by what is actually on the shelf, which gives each category's share
of inventory cost. The same works with Store Data, for example !UnitCost * FacingsTotal.
Units(), covered
next.Metrics in other units
Sizes such as TotalRackArea and TotalShelfWidth come back in each viewer's own Units setting, so the raw values read in square inches for one person and square centimeters for another. Percentages are the same either way.
To pin a metric to one unit, make it an expression of the form Units(TotalRackArea, "ft"). That is still the TotalRackArea metric, measured against the same rack space,
but every raw value and total is in square feet for everyone, in Insights and in
reports. Accepted units are "in", "ft", "cm", "m" and "mm"; areas come out
squared. Pair it with a display name such as Square Footage (ft²) and the
label is true for every reader. See the Units function for using it in other
calculations.
Display names
Field names like sub_category or TotalRackArea are not always what you want readers to see. The button beside the segment or any metric opens a shown as box, and whatever you type there replaces the field name in Insights tables and charts, reports, and comparisons. Show sub_category as Department, or TotalRackArea as Rack Space. A name that states a unit is only accurate if the metric is pinned to it with Units().
Expression metrics are worth naming, since otherwise the calculation itself becomes the column heading. removes a display name and goes back to the field name. Two metrics in one Breakdown cannot share a display name; if they do, the editor warns you and the second keeps its field name.
It is most common to use the category, sub_category, or sub_sub_category fields to segment Breakdowns, but any catalog field or Custom Data field can be used.
Aggregate and Breakdown Scopes
In some advanced cases, you may want to have certain Aggregates or Breakdowns calculate on smaller portions of your report. To do this, you can specify scope for an Aggregate or Breakdown by pressing the filter_center_focus icon.
When working with Aggregates and Breakdowns, the Scope determines what portion of your planogram the calculation applies to. Scope specifies whether you see calculations for the entire planogram or separately for each bay, aisle, or other grouping.
Example: Total Cost Aggregate
- With a Plan scope, you see one total cost for the entire planogram
- With a Fixture scope, you see a separate total cost for each aisle
- With a Bay scope, you see a separate total cost for each shelves bay
Example: Category Breakdown
- With a Plan scope, you see what percentage each category represents across the whole planogram
- With a Bay scope, you see separate category percentages calculated independently for each bay
Available Scopes:
- Plan - Whole planogram
- Bay - Each shelves aisle bay separately
- Fixture - Each curtains_closed aisle or surface separately
- Project - Entire project
- Store Plan - Entire Store Plan
- All - Aggregate or Breakdown across all specified Plans and Projects
Use broader scopes (Project, Plan) when you want high-level summaries, and narrower scopes (Fixture, Bay) when you need detailed breakdowns for specific segments. If scope is not specified (the most common case), it will default to match the Breaks of the specified Report.
Options
The fourth tab stores default report options for this set. Whenever someone selects the set in the Create Report dialog, these values fill in the rest of that dialog for them.
The tab has two columns:
- Report options, which are the same Format, Breaks, Font, Header Notes, and Other toggles offered at report time.
- Image Options, which control the planogram images a PDF report embeds: scale, dimensions, header signs, fixture names, lock icons and layout type, hiding overlapping fixtures, Auto Fill regions, and the two Store Plan toggles for section names and the schematic.
This is the tidiest way to standardize output across a team. A set built for shelf-strip printing can default to PDF (Side-by-Side) broken by Bay with the company logo on, while an analysis set defaults to XLSX (Single Sheet), and nobody has to remember the combination.
Two things to know. Header Notes and the Font selector are always shown on this tab even when the Format is a spreadsheet, though both only affect PDF output. And Scope is deliberately absent, because it is chosen per report rather than stored on the set.
Using Report Property Sets
Users may now select the new Report Property Set from the Create Report dialog, choose the data they want, and generate reports.
Alternatively, users may use the Report Property Set to inform insights Insights.