Report widgets and export

A report is made of widgets, and each widget reads one query. In the builder's Widgets step, each widget either has Own data (its own source, metric, grouping, filters and row limit) or uses Share a query to read primary, totals or one of your extra queries. A new report also gets a primary widget from its type: a data table, an editable table, a KPI strip with a chart, or a trend chart with a table.

• Widget title (optional): shown on the card, and used to name exported files.
• Column span: Half width or Full width. In the Document layout, two half-width widgets sit side by side.
• Widget settings (⌄): the options for that kind, such as tone, format, stacking or legend.
• If a widget is missing something, Review & save names it, for example "Widget "By status" needs a group-by field."

Screenshot · Store Overview widgets

The last column says how each kind gets into a report. Add widget means the Widgets step palette (most kinds can also be dragged in from Insert in the Layout step). Report type means the wizard creates it. Spec JSON means it renders when a spec contains it but has no palette entry. Not yet means a saved spec shows a "coming soon" card.

The Facility map & list puts a list of items beside a live map of the facility. Pick a row and its shape lights up on the map; click a shape and its row is picked. Every built-in report ends with one, and every full-map report is built around one.

Screenshot · A facility map & list on the full map

1. 1
   Pick the facility

   Under Facility, choose the site the map shows. A report shows one facility at a time, so every map & list in a report must use the same one.

2. 2
   Choose what the list shows

   Under What the list shows, pick Facility items (floors, areas, racks, markers, walls, doors, stairs, lifts, escalators, text labels, 3D models) and/or Linked data: tables connected to this facility's map through a data link. Each one becomes a tab.

3. 3
   Tune each tab

   Set the Tab name, the Row title, and up to 4 fields Shown under each row (they also become the list's sort options). For facility items, choose what's Editable in the detail panel; changes save straight to the map. Rows of a linked table are read-only here, and viewers open the table to edit them.

The detail panel shows a preview and every property of the picked item, with Previous / Next to step through the list. For facility items: Edit then Save changes, Delete (not for floors) and Open in editor; items hidden in the editor carry a Hidden badge. For linked rows: the record's status and numbers, where it sits On the map (or "Not on the map — no matching shape"), and Open in table.

On a report, click Export in the header (on the full map: Share & export → Export…). Export report lets you pick a format, tick the widgets to Include (Select all / Clear) and set options. Your options are remembered in this browser.

Every format asks which Rows to include: As on screen (each table's current sort, search and hidden columns) or All loaded rows. Excel and CSV also ask for Values: Formatted or Raw. If a table hit its query's row limit, the dialog warns that there may be more rows.

Hover over a widget and click its ⋯ Widget menu for one-click exports of just that widget, using your remembered options. More export options… opens the full dialog with only that widget ticked.

A whole report (its sources, parameters, viewer filters, queries, widgets and layout) is stored as one JSON document, the spec. Download it to copy a report into another workspace or keep it in version control.

1. 1
   Export the spec

   Open the report in the builder and go to Review & save. Click Download spec JSON, or open View generated spec (advanced) to read it in place.

2. 2
   Import it

   On the Reports screen, pick the facility tab the report should belong to, then click Import JSON (owners and admins). Enter a Name, paste the Spec JSON and click Create report. The new report opens straight away.

3. 3
   Re-point its sources

   The spec refers to data sources and facilities by id. In a different workspace, open the builder and re-pick the Data source, any widget's own source, and the facility of any map & list, so the report reads this workspace's data.

{
  "v": 2,
  "reportType": "detail",
  "sources": [{ "kind": "dataSource", "id": 208 }],
  "params": [{ "id": "vf_status", "label": "Status", "input": { "kind": "dropdown" } }],
  "queries": [{ "name": "rows", "sourceRef": { "kind": "dataSource", "id": 208 } }],
  "layout": { "kind": "map", "mapSlots": { "chart_status": "insights" } },
  "widgets": [
    { "id": "kpi_rows", "kind": "bigValue", "title": "Rows", "queryRef": "kpi_rows" },
    { "id": "chart_status", "kind": "donut", "title": "By status", "queryRef": "chart_status" },
    { "id": "explorer", "kind": "facilityExplorer", "queryRef": "rows" }
  ]
}