Report app — reference (install body + catalog.json)
Copy‑paste reference for wiring up a report type. Uses the Origin‑Destination report as the example.
1. Install the app
POST {{baseUrl}}/controlrooms/{{controlRoomId}}/apps
{ "appIdentifier": "fleets/reports", "weight": 10, "appConfig": { "reportType": "origin-destination", "title": "Origin-Destination Report", "icon": "outline:sl-event-pin-distance-fill", "columns": [ { "property": "periodStart", "label": "From", "type": "date" }, { "property": "periodEnd", "label": "To", "type": "date" }, { "property": "checkpointVisits", "label": "Checkpoints", "align": "right" }, { "property": "tripsExceedingMaxDrive", "label": "Trips > max drive","align": "right" }, { "property": "generatedAt", "label": "Generated", "type": "datetime" } ] }}Notes:
appIdentifieris alwaysfleets/reports(one generic app). Install it once per report type you want to show, each with its ownreportType/columns.reportType= the S3 folder under.../reports/.title+icondrive the sidenav (icons are theme‑namespaced, e.g.outline:sl-…).columns[].type:text(default) ·date·time·datetime.align:left·right·center. Also:bold,prefix,suffix,sortable.
curl:
curl -X POST "$BASE_URL/controlrooms/$CONTROL_ROOM_ID/apps" \ -H "X-Authorization: $API_KEY" -H "Content-Type: application/json" \ -d @install-report-app.json2. catalog.json (current — array)
Path: s3://.../{{controlRoomId}}/reports/origin-destination/catalog.json
[ { "reportId": "2026-06-22__2026-06-28", "reportName": "22 – 28 Jun 2026", "reportPath": "/reports/origin-destination/2026-06-22__2026-06-28.html", "periodStart": "2026-06-22", "periodEnd": "2026-06-28", "checkpointVisits": 111, "tripsExceedingMaxDrive": 22, "generatedAt": "2026-06-30T02:38:26Z" }, { "reportId": "2026-06-10__2026-06-16", "reportName": "10 – 16 Jun 2026", "reportPath": "/reports/origin-destination/2026-06-10__2026-06-16.html", "periodStart": "2026-06-10", "periodEnd": "2026-06-16", "checkpointVisits": 103, "tripsExceedingMaxDrive": 11, "generatedAt": "2026-06-30T01:50:41Z" }]Row fields:
reportId— unique id (filename without.html).reportName— display label.reportPath— path under the reports host (leading slash ok); the component resolves it to an absolute URL and opens it via the “Open Report” action.- Any other fields (
periodStart,checkpointVisits, …) are referenced bycolumns[].property.
Each report type has its own catalog.json in its own folder; deploy the same
catalog-loader.html alongside it.
3. catalog.json (future — object, per the metadata proposal)
Not live yet. When the object form ships, columns + a description can live
in the catalog and appConfig shrinks to nav essentials.
{ "meta": { "description": "Place & trip compliance across checkpoints for the period.", "columns": [ { "property": "periodStart", "label": "From", "type": "date" }, { "property": "checkpointVisits", "label": "Checkpoints", "align": "right" } ] }, "reports": [ { "reportId": "2026-06-10__2026-06-16", "reportName": "10 – 16 Jun 2026", "reportPath": "/reports/origin-destination/2026-06-10__2026-06-16.html", "periodStart": "2026-06-10", "periodEnd": "2026-06-16", "checkpointVisits": 103 } ]}Install body then reduces to:
{ "appIdentifier": "fleets/reports", "weight": 10, "appConfig": { "reportType": "origin-destination", "title": "Origin-Destination Report", "icon": "outline:sl-event-pin-distance-fill" } }