Creating a Report
Turn any planogram into a branded PDF or spreadsheet for a line review or a store reset: images, tables, charts, and totals, all from one dialog.
Built for Line Reviews and Store Resets
A report is the part of your planogram that travels, and whoever receives it needs no GoPlanogram account and nothing to install. Because it is generated from the Plan, a late change means regenerating the report, not rebuilding a deck by hand.
- Suppliers: bring a document, not a screenshot. Add your logo, a coversheet, and a revision number or effective date, then back the layout with calculate Aggregates and bar_chart Breakdown charts built from your catalog and analytics Store Data.
- Retailers: send stores something they can set. Break the report by shelves Bay, print dimensions and shelf notches on every photo_library image, and include a format_list_numbered Fixture Bill of Materials for whoever orders or installs the fixtures.
- Report across every account. With a group_work Project open, get one report that totals every Plan, or a ZIP with a standalone report for each. A newspaper Report Property Set can save your settings, so the next reset's report comes out the same way.
Choose PDF when the report needs images and charts, or XLSX and CSV for further analysis. Report Formats compares them.
The Create Report Dialog
Every report, in every format, comes out of the same dialog. Open it with File → Export → Report, or right click the planogram and choose Export → Report.
The dialog has four parts, and this page walks through them left to right: the list of newspaper Report Property Sets, the data you want included, the report options, and a preview of the images the report will embed.
1. Choose a Report Property Set
The left column lists every newspaper Report Property Set you have access to. A Report Property Set decides what data a report can contain, so picking one is always the first step. Use the search box to narrow a long list. The same sets drive live insights Insights.
Every site starts with a Default set you can modify, and you can define as many of your own as you need, though only site admins can define sitewide ones. Sample Reports at the bottom of the list expands to show the example sets that ship with every GoPlanogram site. They are a good starting point if you have not built your own yet.
edit Edit Sets opens the Report Property Set editor without losing your place, and the list refreshes when you return.
2. Choose your data
The second column lists everything the selected set offers, in three groups:
- info Properties are reported once per widgets Position, and become the columns of the report tables. Each one is a catalog field, a Dynamic Field, or your own calculate Calculation.
- calculate Aggregates are calculated across all Positions in scope, such as total facings or retail value. Each one is a Calculation using an aggregate function.
- bar_chart Breakdowns divide the display into percentage shares, rendered as tables in XLSX and as tables plus charts in PDFs.
Everything starts checked. Uncheck anything you do not want in this particular report, or use the deselect button beside a group heading to check or uncheck the whole group at once.
Breakdowns are unavailable when the Format is CSV, and the dialog marks them as disabled. Aggregates are still included in a CSV, after the Position rows.
3. Set the report options
The middle column controls the report itself, across two tabs. Settings holds the fields below; Options holds the toggles, covered in the next step.
| Option | What it does |
|---|---|
| Name | Names the report and the downloaded file. Defaults to the name of the open Plan. |
| Header Notes | PDF only. Up to 150 characters printed in the header of every page, which is useful for a revision number, a store cluster, or an effective date. |
| Scope | Limits the report to a single top-level fixture, such as one Aisle or Surface. Leave it on All Plan Content to report the whole Plan. |
| Format | PDF, XLSX, or CSV. See Report Formats for which to pick. |
| Breaks | Splits the report into sections: None for one continuous report, Fixture for one section per top-level fixture, or Bay for one section per bay. In PDFs each section starts on a new page, in XLSX each section gets its own sheet, and in XLSX (Single Sheet) each section gets a sub-header. CSV rows run together unless you also enable One File Per Section. |
| Font | PDF only. Choose Roboto, Open Sans, Lato, Merriweather, Source Code Pro, or Montserrat. Each option previews in its own font, and Default keeps the built-in report font. |
| Header Color and Accent Color | XLSX only. Header Color fills the header and section sub-header rows. Accent Color fills the alternating rows beneath them. |
4. The Options tab
The Options tab holds every remaining toggle, in four groups: Content, Images, Layout, and Sections. Most apply to PDF reports, where there is a page to put them on. The tables below list the formats each one works with. The number beside the tab name is how many are switched on, so you can see there is something set without opening it.
Options: Content
| Option | Effect | Formats |
|---|---|---|
| Include POP | Adds POP items, such as signs and header signs, as report rows. | All |
| Coversheet | Starts each Plan with a full image of the chosen Scope, with all color views turned off. | |
| format_list_numbered Fixture Bill of Materials | Adds a bill of materials: every fixture in the Plan with its name, SKU
and quantity. A page in PDF, a sheet in XLSX, a table at the end of a
CSV, and a Fixtures sharing a SKU are one line with a quantity. A fixture with no SKU is still listed, by name, so nothing is silently left off an order. Parts that belong to a fixture are not listed separately, because the fixture's own SKU already covers them. For example, a Hanging Bar that declares its own hook count owns those hooks, and a Rack owns its base decks. A peg you hang a single Position on is counted, even when it comes from a Rack's or Bar's hook length rather than a Hook record. Those pegs have no SKU, so they are listed by size. | All |
| QR Code | Adds a QR code at the end of the report that opens this Plan in GoPlanogram. Handy for printed reports carried onto the floor. | |
| Hyperlink | Adds a clickable link at the end of the report to the same place. | |
| Include Logo | Prints your company logo in the top right corner of every page. Site admins upload it under Admin → Company Logo. |
Options: Images
| Option | Effect | Formats |
|---|---|---|
| Images Only | Prints just the section images, leaving out property tables, Aggregates, and Breakdowns no matter what the chosen RPS selects. Use it for a picture-only PDF without having to uncheck every RPS line, which also means your columns come straight back when you turn it off. QR Code and Hyperlink still apply if you enabled them. | |
| Include Topdown View | Adds a page showing the Topdown View of the planogram. | |
| Auto Rotate Images | Rotates any section image that is wider than it is tall by 90 degrees, so it prints larger on the page. |
Options: Layout
| Option | Effect | Formats |
|---|---|---|
| Single Line Rows | Forces every cell to one line, truncating long text with an ellipsis. Keeps wide tables readable. | |
| Table Borders | Draws a thin gray border around every table cell below the column titles. | |
| No Fixture Dimensions | Leaves fixture dimensions out of those section headings. | PDF, XLSX |
| Hide Section/Page Counts | Removes the section and page counter, such as "Section 1 of 2, page 1 of 2", from the page header. The Plan name and Header Notes still print. | |
| Hide Bay Location | Leaves the (Aisle X, Bay Y) location off the title above each bay's image, so it shows just the bay's name. | |
| Legacy Report | Uses the previous PDF layout and styling for tables, titles, charts, the cover, and the footer, and keeps Aggregates and Breakdowns that have no value. |
Options: Sections
| Option | Effect | Formats |
|---|---|---|
| No Fixture Sections | Lists every item in one flat table with no per-shelf or per-fixture section headings, whatever the fixture hierarchy. | PDF, XLSX |
| One File Per Section | Downloads a separate file per report section inside a single ZIP archive, instead of one combined file. Requires Breaks to be something other than None. | All |
| Skip Duplicates | Combines every Position sharing an item ID into one row, so an item placed in four spots is reported once. | All |
5. Preview the image sections
For PDF formats the right side of the dialog previews exactly which images the report will embed, one per section as determined by Breaks. Step through them with the arrows to confirm the report is broken up the way you expect before you generate anything.
The image controls here are the same ones described on the Images page, including scale, dimensions, shelf notches, fixture names, lock icons and layout type, header signs, and hiding overlapping fixtures. Untick fixture names, lock icons, and layout type to keep report images clean even if you show them while you work.
This panel also sets the Labels to print on each Position. The report saves whichever you pick and prints them on its section images.
When a group_work Project or Store Plan is open, a Preview Plan selector appears so you can check any Plan the report will cover.
Spreadsheet formats do not embed images, so this panel is replaced by a note saying so.
6. Generate the report
The buttons along the bottom of the dialog decide how much gets reported. Which ones appear depends on what you have open.
| Button | What it generates |
|---|---|
| Plan Report | The current Plan. This is the usual choice. |
| Single Section Report | Only the section currently shown in the image preview, which is the fastest way to get a single bay or fixture onto paper. PDF formats only. |
| Store Plan Report | Every Plan in the open Store Plan, as one report. |
| Project Report | Every Plan in the open group_work Project, as one report, with Aggregates and Breakdowns calculated across the whole Project. |
| Project ZIP | A separate report for each Plan in the Project, delivered as a ZIP archive. |
The report is generated and downloaded to your computer. Large Projects report one Plan at a time, and progress is shown while they run.
Reporting via API
To automate reports or feed BI tools, the Web API generates reports in every format, or as raw JSON. See the API reference for details. API access is included with the Professional package and above.