New UI
      Back to home
      1. Help Center
      2. FAI-Cloud (Cloud Deployment)
      3. New UI

      FAI Reports

      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, and scheduled report generation.

      Trigger

      (Menu) Data > Report - New [beta]

      Access and Permissions

      • All Users Can Create Reports: Any user can generate reports, including users with the Operator role.

      • Report Ownership and Visibility: Currently, only the report owner can view their own reports for security reasons.

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

      Capabilities

      Report Generation Options

      Users can generate reports in two ways:

      1. Generate Now: Users can manually generate a report immediately.

      2. Scheduled Reports: Users can configure reports to be generated at predefined time intervals.

      Report Types

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

      Report Type

      Details

      Status

      Stream History

      A report displaying list of samples from multiple Data Streams from multiple Sites.

      Unlike the old report tool, where users could only select streams from a single site, the new tool allows users to select multiple streams from multiple sites.

      Released

      Events

      A report displaying the events happened in a time range in an account.

      Released

      Devices Health

      A report displaying list of devices with health issues (battery %, humidity %, communication status, signal strength %, has not transmitted recently).

      Any device that meets one or more of the above criteria will be included in the report.

      We urge you to set a daily report including an email notification if devices with such issues appear.

      Released

      Stream History Aggregation

      A report displaying list of samples from multiple Data Streams from multiple Sites. aggregated Sum, Average, Min, Max and/or STD.

      In-Progress

      Daily Meter Reading

      A report displaying samples of Meter Reading data streams in a time range.

      Future

      Daily Total Flow Report

      A report displaying samples of Flow data streams in a time range.

      Future

      Inactivated Devices

      A report displaying list of devices that are in “Ready” mode, not activated yet.

      Future

       Batch Processing

      • In the old report tool, users could only generate reports covering up to 3 months of data. In the new Report Tool, this limitation has been removed, allowing reports to cover any time range.

      Setting the Export File

      • Users can change the export file default settings.

      • Settings include CSV format, such as Delimiter (, / ; / tab), Quotation mark (“) / Apostrophe (') / None, option to remove the header row, option to round sample time to closet minute, etc.

      Email Notifications and Sharing

      • The report owner has the option to receive an email notification upon the generation of a report.

      • By selecting the "Notify by email when the report is ready" checkbox, the report owner can specify their preferences:

        1. To receive notifications directly, the report owner should check the "Notify me" checkbox.

        2. To inform other users, the report owner can choose the desired user groups from the "Notify the following groups" dropdown menu.

      Please note:

      [1] Users associated with the selected user groups will receive email notifications upon the successful generation of the report.

      [2] The generated report will be accessible to these users. They will be able to view the report within the "Generated Report" tab and download the data report as needed.

      • The report owner can choose to receive an email notification when a report is generated.

      • When selecting the "Notify by email when the report is ready" checkbox, the report owner can select:

        • To be notified, by selecting the "Notify me" checkbox.

        • To notify selected user groups, by selecting the user groups in the "Notify the following groups" dropdown field.
          Notes:
          [1] By selecting user groups, the users associated with these user groups will receive email notification on success of generated report.
          [2] The generated report will be shared with these users. Shared users will be able to view it within the "Generated Report" tab and download the data report.

      • The email contains a download link. Clicking the link opens FAI (after authentication) and automatically downloads the report.

      • Users can decide to skip notification if a generated report has no data, by selecting the "Skip notification if report has no data" checkbox.

      Report Retention

      • The retention period is set according to system settings. by default, the expiration date of generated reports is 30 days.
      • In upcoming updates, we plan to provide users with the ability to configure the retention duration for generated reports, allowing for customized storage options for future reference.

      Beta Version Notes

      • The new Report Tool is currently in Beta.

      • Not all report types have been added to the new report tool. We’re working on it.

      • Users are encouraged to provide feedback to improve functionality and usability before the final release.

      For support or questions, please contact the Ayyeka Support team.