hiveops-guide/backend/src/main/resources/content/reports/templates/overview.md

module, title, tab, order, audience

module	title	tab	order	audience
reports.templates	Report Templates	Overview	10	customer

Build reusable reports from your fleet data — pick what to include once, then run it on demand or on a schedule. Use this when you need a recurring pull of incidents, ATM health, transactions, fleet tasks, or agent versions.

📝 Create a Report

1. Click + New Report in the toolbar.
2. Give it a Name and pick a Data Source: Incidents, ATM Health, Transactions, Fleet Tasks, Agent Versions, or Agent Modules.
3. Choose your Columns — click the fields you want in the report.
4. (Optional) Add a short Description and choose an Output Format: CSV (for spreadsheets/BI tools) or JSON.
5. (Optional) Pick Group By fields to summarize rows. When grouped, a count is always included, and you can add SUM / AVG / MIN / MAX on numeric fields.
6. Save. Your report appears under My Reports.

You must select at least one column or a group-by field before saving.

▶ Run a Report

1. On any report, click ▶ Run.
2. Choose a saved query, or pick Custom to set a date range and select specific ATMs for this run.
3. Submit — the run is queued and you're taken to Run History to watch it finish.

🔖 Saved Queries

1. Click Queries on a report to open its saved queries.
2. Click + New Query to save a reusable combination of date range (e.g. Last 7 days, This month, or a custom range) and a set of ATMs.
3. Saved queries give you quick run options and are required to schedule a report.

🕐 Schedule a Report

1. While creating or editing a report, turn on scheduling and pick a frequency: every X minutes, hourly, daily, weekly, or monthly.
2. Open the report's Queries and click Set Scheduled on the query that should run automatically.
3. The Schedule and Next Run columns show when it will run next. Completed scheduled reports are delivered to you in-app.

A report with no schedule shows Manual — it only runs when you click Run.

🤝 Share

• Click Share on a report to make it available to other users in your organization; they'll see it under Shared Reports and can run it.
• Click Unshare to stop sharing.

📊 What you're looking at

• My Reports — your saved reports, showing Data Source, Format, Schedule, and Next Run.
• Shared Reports — reports others shared with you, with the person who shared them.
• Run History — every run with its Status (Pending, Running, Completed, Failed), Rows returned, who triggered it, and start/finish times. On a completed run, click Preview to view the first rows in-app or Download to save the file.

The page auto-refreshes about once a minute so run statuses stay current — toggle it off with the switch in the header if you prefer.