Report Formats
Send a polished PDF to a buyer, a spreadsheet to an analyst, or a CSV to another system. One report, in whichever format its reader needs.
Format is a single dropdown in the newspaper Create Report dialog. Your Report Property Set and selections carry over when you switch, apart from what a format cannot hold, and some options only apply to certain formats.
Which Format to Choose
| If you need to | Choose | Why |
|---|---|---|
| Present to a buyer in a line review | PDF (Side-by-Side) | The fixture stays in view beside the data on every page |
| Print a finished plan or send it to stores | PDF (Portrait) | Each section's image gets a full page, followed by its tables |
| Fit wide fixtures or reports with many Properties | PDF (Landscape) | The Portrait layout, with more width |
| Work through the data section by section | XLSX | Each report section gets its own sheet |
| Sort or pivot the whole report at once | XLSX (Single Sheet) | Every section sits on one sheet |
| Load Position data into another system | CSV | Plain rows and the smallest file |
| Feed a dashboard or BI tool | JSON | Raw report data through the Web API |
Comparing the Formats
| Format | Planogram images | Aggregates | Breakdowns | Report sections |
|---|---|---|---|---|
| PDF (Portrait) | Yes | Yes | Tables and charts | Each starts on a new page |
| PDF (Landscape) | Yes | Yes | Tables and charts | Each starts on a new page |
| PDF (Side-by-Side) | Yes | Yes | Tables and charts | Each starts on a new page |
| XLSX | No | Yes | Tables | One sheet per section |
| XLSX (Single Sheet) | No | Yes | Tables | One sheet, with section sub-headers |
| CSV | No | Yes, after the rows | No | Rows run together |
Report sections come from the Breaks setting. Each format's options, such as Coversheet or Include Logo, are listed in Creating a Report.
PDF Formats
All three PDF formats carry the same data. They differ only in how each section is laid out on the page.
- PDF (Portrait) puts the section image on its own page, then the report tables after it.
- PDF (Landscape) is the same layout in landscape orientation, which suits wide fixtures and reports with many Properties.
- PDF (Side-by-Side) is landscape with the section image repeated down the left half of every page and the report content on the right half, so the fixture stays in view no matter how long the table runs.
PDFs are the only format that embeds the planogram images previewed in the dialog, and the only one that renders bar_chart Breakdowns as charts. Most report options apply only to PDFs as well, since they need a page to live on.
XLSX
XLSX reports contain the same info Properties, calculate Aggregates, and bar_chart Breakdown tables as a PDF, without images or charts, in a workbook you can sort, filter, and pivot. Header and accent colors let reports match your own template.
The two XLSX formats differ only in how sections are arranged. Plain XLSX gives each report section its own sheet. XLSX (Single Sheet) puts every section on one sheet, which is what you want when you intend to sort or pivot across the whole report.
CSV
CSV is a plain table of info Properties, one row per Position, which makes it the smallest file and the easiest to load into another system. It carries no Breakdowns, images, or formatting, and the dialog disables Breakdowns while CSV is selected.
Any calculate Aggregates you leave checked are written after the Position rows, separated by a blank line. If the system reading the file expects a single table, uncheck them.
Rows from different report sections run together, with no section markers. To keep sections apart, set Breaks and enable One File Per Section.
JSON
JSON is for reports read by another system rather than a person: a dashboard, a BI tool, or your own reporting pipeline. It comes from the Web API, which can hand back the report data directly instead of a file, and it does not appear in the Format dropdown unless it is enabled for your site.
You choose the Report Property Set, Breaks, and options the same way, so a report you designed in the dialog can be pulled as raw JSON without rebuilding it. When someone needs to open and read the report, use one of the file formats above.