FAI Report Tool Guide

Introduction

The new Report Tool allows all users, including those with the Operator role, to generate reports based on data from the FAI system. This tool introduces improvements such as:

• Expanded report retention

• Batch processing

• Scheduled report generation

---

How to Access

Navigate to the Reports page by going to: Menu → Data → Report - New [beta]

---

Access and Permissions

• All Users Can Create Reports: Any user, including Operators, can generate reports.

• Report Ownership and Visibility: Only the report owner can view their reports for security reasons.

• Collection-Based Access: Users can only generate reports within their permitted collections.

---

Capabilities

Report Generation Options

• Generate Now: Manually generate a report immediately.

• Scheduled Reports: Configure reports to be generated at predefined intervals.

Report Types

The goal is to incorporate all report types that were previously available in the old report tool.

Report Type	Details	Status
Stream History	Displays list of samples from multiple Data Streams and Sites. Now supports multiple sites (not just one).	Released
Events	Displays events that occurred in a selected time range in an account.	Released
Devices Health	Lists devices with health issues (battery %, humidity %, communication status, signal strength %, inactivity). Set a daily report with email notification.	Released
Stream History Aggregation	Displays aggregated Sum, Average, Min, Max, and/or STD from multiple streams and sites.	In-Progress
Daily Meter Reading	Displays samples of Meter Reading streams in a time range.	Future
Daily Total Flow Report	Displays samples of Flow data streams in a time range.	Future
Inactivated Devices	Lists devices in “Ready” mode that are not yet activated.	Future

---

Batch Processing

In the old tool, reports were limited to 3 months of data. The new Report Tool allows any time range.

---

Setting the Export File

Users can configure export file defaults, including:

• CSV delimiter: ,, ;, tab

• Quotation: ", ', or None

• Option to remove the header row

• Option to round sample time to the closest minute

---

Email Notifications and Sharing

Report owners can opt to receive email notifications when a report is generated.

To Enable Notifications:

1. Select "Notify by email when the report is ready".

2. Choose one or both:

   • "Notify me" to receive notification personally.

   • "Notify the following groups" to notify selected user groups.

Notes:

• [1] Users in selected groups receive email notifications when the report is generated.

• [2] These users can access the report in the "Generated Report" tab and download it.

The email includes a download link, which opens FAI (after authentication) and downloads the report.

Users can also skip notifications for reports with no data by selecting: "Skip notification if report has no data".

---

Report Retention

• Reports expire after 30 days by default (per system settings).

• Future updates will allow customizable retention durations.

---

Beta Version Notes

• The Report Tool is currently in Beta.

• Not all report types are available yet.

• Users are encouraged to provide feedback before final release.

For support, contact the Ayyeka Support team.