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
To edit Report Property Sets, navigate to File → Report and click the Edit Sets button. You can modify an existing Report Property Set, or create a new one with Create Set.
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.
Properties
Report Property Sets can have any number of Properties, which are evaluated separately for every item in a report.
Properties can be either to an individual catalog field or Dynamic Field, or to a custom calculate Calculation.
You can use the visibility_off button to temporarily hide a Property from report outputs.
Properties appear in Reports in the order that they are entered, and can be reordered with the keyboard_arrow_up and keyboard_arrow_down buttons.
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().
You can use the visibility_off button to temporarily hide an Aggregate from report outputs.
Aggregates appear in Reports in the order that they are entered, and can be reordered with the keyboard_arrow_up and keyboard_arrow_down buttons.
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 maps a catalog field or Dynamic Field (called "Segments") to one or more other fields (called "Metrics"). For example, the Breakdown in this example evaluates, for each category, what percentage of Total Products that category represents.
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.
You can use the visibility_off button to temporarily hide a Breakdown from report outputs.
Breakdowns appear in Reports in the order that they are entered, and can be reordered with the keyboard_arrow_up and keyboard_arrow_down buttons.
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
- 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.
Using Report Property Sets
Users may now select the new Report Property Set from the Create Report dialog, choose the properties they want, and generate reports.
Alternatively, users may use the Report Property Set to inform insights Insights.