1. Introduction

Reports Access and Subscription is an essential feature for Acuity application or system that generates and presents reports. This technical document provides guidance on implementing report access and subscription features. Report access ensures that authorized users can view reports, Edit Schedule and Edit Recipients, while report subscription allows users to receive reports regularly through preferred delivery channels like email.

2. User Interaction with the Acuity Web Application

<aside> 💡 The Reports Engine is a component of an Acuity web application that allows users to create, manage, and configure reports. It provides an interface for users to interact with the application and customize their reports. Here's how users interact with the frontend Acuity web application.

</aside>

2.1 Accessing the Reports Engine

Access the web application by opening a web browser and navigating to the designated URL. for example: https://dev.aderisenergy.com

2.2 Authentication

To use the Reports Engine and subscribe to reports, you need to log in to the Acuity web application using your credentials. This ensures that only authorized users can manage their subscriptions.

2.3 Reports Engine Access

Once on the homepage, locate and click on the Reports option. This will take you to a page where you can access all available reports

2.4 Interactions within the Reports Engine

1. To create a new report, click on the Create Report button, fill in the necessary details such as the report Name and Type, and then click Add to create the report.

1. If the user selects the Report Type, the system will provide two different types: Daily KPIs and Time Series.

   • Daily KPIs: Daily KPIs encompass once-daily summarized Key Performance Indicators, including total energy (actual, expected, and/or modeled), average or maximum temperature, performance index, and ratio, or availability. When executed, Daily KPI reports will present one row of data per day throughout the report interval. These reports prove valuable for analyzing plant performance over an extended period.

   

   • Time Series: Time Series reports enable users to export historical data recorded from devices at various sampled resolutions (1-minute, 5-minute, 15-minute, etc.).

   

2. Initially, you can select KPIs and devices from the report contents, and you have the option to add KPIs to your selection. If you choose KPIs, you can select Add Data to add specific KPIs and devices. Similarly, when selecting devices, you can select Add Data to add the devices, and then you can view either KPIs or devices.