maxsuite Diagrams

Reports

Reports

Reports shows how things stand across every installed module in one place, and keeps saved reports that can be sent to a person on a schedule (module reports).

In the sidebar under Home → Reports.

What you see

The figures

The top of the screen is a card for each installed module that has figures to give, such as overdue tasks or monitors down. Each module supplies its own figures, so the cards change as modules are switched on or off. A figure that links somewhere opens the screen where you act on it.

If a module cannot answer, its card stays and says so: its figures are missing, not zero. With no figures from any module, the screen says "Nothing to report yet". If the whole screen fails to load, Try again loads it once more.

Saved reports

Below the figures is a Saved reports card:

  • A table with Report (its name), Schedule (the cron string, or "on request"), Last sent and Updated.
  • New report, and Send now, Edit and Delete on each row, for people who can manage reports.

With none saved, the card says "No saved reports".

What you can do

Save a report

  1. Open Reports and press New report under Saved reports.
  2. Give it a Name, such as "Weekly figures". Names are unique in the workspace.
  3. Optionally set a Schedule as a cron string, such as 0 9 * * 1 for 09:00 UTC every Monday. Leave it empty to send it only when asked.
  4. Optionally choose who it goes to in Send to. Left empty, it goes to whoever saved it.
  5. Save.

A report saved from the screen covers every module's figures.

Send a report now

Press Send now on its row. The figures are worked out at once and sent to the report's recipient as a notification. Their own notification settings decide whether it reaches them in the app, in a chat, or both. See Notifications and alerts.

A report addressed to someone MaxSuite cannot find is refused rather than marked as sent.

Schedule or stop a report

  1. Press Edit on the report.
  2. Change the Schedule, or clear it to stop the scheduled sends.
  3. Save.

Schedules are read in UTC: 0 9 * * 1-5 is 09:00 UTC on weekdays, not 09:00 where you are. A schedule that is not a valid five-part cron string is refused when you save it.

Delete a report

Press Delete on its row and confirm. Its schedule goes with it.

Only the person who saved a report, or an admin, can edit or delete it.

Who can do what

PermissionLabelLets you
reports:readView reportsSee the figures and the saved reports, and work a saved report out without sending it.
reports:writeManage reportsSave reports, send them now, and edit, schedule or delete the ones you saved. Admins can edit or delete any.

See People, roles and permissions.

What runs on its own

JobWhenWhat it does
tickEvery minute (* * * * *)Sends every saved report whose schedule names this minute, in UTC, to its recipient, and stamps when it was sent.

Needs

Projects and Tasks switched on.

For agents

An agent can read the figures, list saved reports, work one out, see what you looked at recently, and save, rename, change or delete reports. It cannot schedule or send a report: when a report goes out, and to whom, is set by a person. Saving and changing are writes, and deleting is destructive, so by default each one waits for a person to approve it. See Agents and approvals.

Read: reports.list, reports.dashboard, reports.runReport, reports.recent

Change: reports.create, reports.update

Destructive (approval): reports.delete

  • reports.dashboard returns the same figures as the top of the screen.
  • reports.runReport works a saved report out and returns its figures. Nothing is sent and nothing is written.
  • reports.recent lists what the caller looked at recently, newest first.
  • reports.create and reports.update can narrow a report to one module's figures. Filters and grouping can be saved with it, but they are not applied to the figures yet, and the answer says so.

Over MCP the same tools are named reports__list, reports__runReport and so on. See API keys and MCP access.