Reporting

Part of the IP4CMS portal. ← All module guides

What it's for β€” Reporting lets you build your own visual dashboards from the data already flowing through other parts of the portal β€” transactions, members, properties, vehicles, panic alerts and more. Each dashboard is a grid of tiles ("report items"): a table, a chart, a single big metric number, a map, an embedded web page, or a pre-built dashboard pulled in from Metabase (an external business-intelligence tool, optional). You group dashboards into collections, arrange tiles by drag-and-drop, and can pin one dashboard as the portal home page. (In some deployments this module is relabelled "Dashboard" in the menu β€” it is the same feature.)

Where to find it β€” In the left-hand navigation under Reporting (or Dashboard), route /app/reporting/dashboards. The screen opens with a list of dashboard groups and dashboards down the side; selecting one shows its tiles in the main canvas. If a default reporting dashboard has been configured (see below), it can also appear as your portal landing page at /app.

Before you start

Key tasks

Create a dashboard group

Groups are folders for organising related dashboards (for example "Finance", "Operations").

  1. On the Reporting screen, choose New group (the add control beside the dashboard list).
  2. Enter a Name and save.
  3. The group appears in the side list and can be expanded or collapsed. To rename or remove it, use its edit and delete controls.

Fields: Name (required, up to 255 characters). Deleting a group does not delete its dashboards β€” they simply become ungrouped.

Create a dashboard

  1. Choose New dashboard.
  2. Enter a Name.
  3. Optionally pick a Group to file it under; leave blank to keep it ungrouped.
  4. Save. You are taken straight into the new (empty) dashboard, ready to add tiles.

Fields: Name (required), Group (optional). You can move a dashboard between groups, or rename it, at any time via its edit control. Deleting a dashboard removes it and all its tiles β€” this cannot be undone.

Add a report item (tile / metric)

Tiles are the building blocks of a dashboard. Open a dashboard and choose Add report item, then complete the modal.

  1. Item type β€” choose one:
  1. Source module β€” the data the tile draws from: Transactions, Members, Vehicles, Properties/Locations, Property Verifications, Member Requests or Panic Alerts. The list reflects what your tenant has licensed. (For Metabase tiles you instead pick a Metabase dashboard.)
  2. Title β€” the heading shown on the tile (required).
  3. Configure the tile's content (varies by type β€” see below).
  4. Save. The tile is added to the grid; reposition it as needed.

Configuring a table tile β€” pick which columns to show (leave all selected to show everything), and optionally add filters to narrow the rows.

Configuring a chart or total tile β€” choose how to summarise the data:

Adding filters β€” choose Add filter, pick a field, then set its value:

Each active filter shows as a removable pill. You can clear filters individually or all at once.

Lay out the dashboard

Tiles sit on a 12-column grid.

  1. Switch the dashboard into edit mode (the layout/edit toggle). The grid lines appear.
  2. Drag a tile by its handle to move it; drag its edge/corner to resize. Neighbouring tiles move out of the way automatically.
  3. Layout is saved automatically a moment after you finish moving (no explicit Save needed).
  4. Turn edit mode off to return to the normal read-only view. Any tile can be opened full screen from its tile menu; press Esc to close.

Embed a Metabase dashboard

If your platform has Metabase connected and dashboards allow-listed for your tenant, you can surface them inside the portal.

  1. Add a report item and set Item type to Metabase embed.
  2. Choose the Metabase dashboard from the allow-listed options (only active, allow-listed dashboards appear).
  3. Give it a Title and save.

Behind the scenes the portal requests a short-lived secure embed token (valid about 10 minutes, refreshed automatically) so the Metabase dashboard renders safely without exposing credentials. You cannot embed arbitrary Metabase dashboards β€” only those your administrator has allow-listed for your tenant. If Metabase signing is not configured on the server, embedding is unavailable and the option will not produce a working tile.

Set a landing / default dashboard

You can make one reporting dashboard the portal's home page so users land on it after signing in.

  1. Go to Settings β†’ General settings.
  2. Under Home page, open Default reporting dashboard.
  3. Select a dashboard (or clear it to remove the default).
  4. Save. From then on, /app shows that dashboard in read-only embed mode. With no default set, users land on their first accessible route instead.

Setting this requires the reporting:update:all permission.

How the data connects

Reporting does not store its own copy of your business data β€” it reads live from the modules you already use:

Because tiles query live data, the numbers reflect the current state every time a dashboard loads; relative date filters re-resolve on each load. Metabase tiles are different β€” they are produced entirely by your separate Metabase instance and embedded as-is; their content, refresh and data sources are managed in Metabase, not in the portal.

Only the dashboard definition itself is stored: the dashboard, its group, its tiles (type, source, title, filters, metric configuration) and the saved grid layout.

Permissions & access

Access is gated by the Reporting licence module plus four role permissions:

PermissionLets the user
reporting:read:allView dashboards, groups, tiles and run their data queries
reporting:create:allCreate dashboard groups, dashboards and tiles
reporting:update:allEdit groups, dashboards, tiles, layout, and set the default home dashboard
reporting:delete:allDelete groups, dashboards and tiles

All data is tenant-scoped β€” you only ever see and edit your own organisation's dashboards and data. Tile source modules are further filtered by their own licences, so a user can only build tiles from data they are entitled to.

Tips & gotchas