Configuring and Scheduling Energy Reports
Scenario: You want to integrate the extension Energy Reporting with the Management Platform, configure the reports and schedule the automatic execution of energy reports. For manual execution of energy reports, see View Report Output.
Reference: For background information, see the reference section.
Workflow diagram:
Prerequisites:
- The Energy and Power Reporting Templates extension is installed and added to the project. This in turn installs the Advanced Reporting, Managed Meters, Web Services, and Application Host Base extensions and adds to the project.
- Advanced Reporting is configured along with the configuration for Home Webservice, Data Caching, Caching Settings, Layout Settings and synchronizing energy reporting templates.
- Managed meters are created and information for the Metering Point, Media Unit, Meter Path, and Offset is historized.
- A view that represents the hierarchical structure of a building with floors and with meters installed on the floors is created. See View Layout Representations.
- A display rule is configured that runs the report on selecting a particular floor or managed meter.
- Information for configuring additional energy reports is added in the Excel file depending on the report to be executed. See Excel Template for Configuring External Settings in Energy Reports.
- During automatic scheduling of reports to route the report to email, email settings are configured.
- System Browser is in Application View.
- System Manager is in Operating mode.
Steps:
1 – (Optional) Configure Additional Energy Report Parameters
- You have added information in the Excel Template for Configuring External Settings in Energy Reports depending on the report to be executed.
- Select Applications > Advanced Reporting.
- In the Application Viewer tab, click the Configuration Page.
- The Advanced Reporting Configuration Page displays.
- In the Configuration section, next to Additional Energy Report Settings (for Cost, Emissions, Budget, and Performance), click Edit.
- In the Parameter dialog box that displays, proceed as follows for the selected type of report.
- For Consumption Cost Report: In the Cost Value format display field, select the value format in which the cost is to be displayed. In the Currency in cost report field, specify the currency format.
- For Consumption Emissions Report: In the CO2 unit display field, select the unit in which CO2 emission value is to be measured.
- For Consumption Budget Report: In the Budget % display field, select either % used of the Budget to display the percentage consumed from the planned budget amount or Difference in % to display the remaining budget balance in percentage.
- For Consumption Budget Report: In the Default Graph type (Budget) field specify the type of graph in which the budget series is to be displayed.
- For Consumption Degree Days Corrected Report: In the HDD Corrected, Value 1 display in Graphics and HDD Corrected, Value 2 display in Graphics fields, select the value that you want to display in the graph in the report. The options include, Consumption measured, Consumption Not corrected part, Consumption corrected part, and Total corrected consumption.
- Click Execute.
- The settings are applied and the list of managed meters configured in your system display.
You can now copy the meter IDs as well as the names of the managed meters in the Meter ID and MeterName columns in the MeterIDList worksheet in EnergyReportsExternalSetting.xlsx.
- For Consumption Emissions Report, Consumption Budget Report, and Consumption Performance Report: In the Read Worksheet section, click Clean Tables next to Clean tables in cache (for an update of data from Excel worksheet) so that any latest changes done in EnergyReportsExternalSetting.xlsx are reflected in the generated report output.
- You can also view the following information that has been configured in the EnergyReportsExternalSetting.xlsx file by clicking the Read worksheet button next to the corresponding options:
a. Check the Excel file in the worksheet "MeterSurfaceCovered" - Surface area covered by the listed meters.
b. Check the Excel file in the worksheet "MeterVatFee" - Amount of VAT and meter fee specified for the meters.
c. Check the Excel file in the worksheet "MeterTariffData" - Tariff specified for the meters.
d. Check the Excel file in the worksheet “Budget” - Whether or not the budget has been configured for each listed meter, number of months for which the budget is configured for a meter, and whether any duplicate entry exists for a meter in the excel.
2 – Configure the Design of Report Elements
- Next to Energy Report settings, click Edit.
- The Parameter dialog box displays.
- Configure the layout of the various elements, such as the type of graph to be displayed in the report, along with the color in which the various media and related media groups should be represented.
- Click Execute.
- Your report will have the design as per the specified settings.
3 – (Optional) Configure Settings for PUE Report
- Next to PUE Report Settings, click Edit.
- The Parameter dialog box displays.
- Configure the following settings:
a. Value format display
b. Total energy consumption is taken from. This will have a value of 0 (for meters having usage as General) or 1 (for meters having usage as Total meter)
c. Unit display in PUE Report
- Click Execute.
- The PUE report is configured.
4 – Generate Cache
- System Manager is in Operating mode.
- In System Browser, select Application View.
- Select Applications > Advanced Reporting.
- Click the Application Viewer tab, and select the Job Create Cache report from the menu options.
- The Job Create Cache report displays.
- In the Parameter dialog box, select Full Period.
- Click Execute.
- The cache generation begins and the cache files are stored at the following location, [Installation Drive]:\Program Files\Apache Software Foundation\data\_cache\engine\_gms-birt_9595\CacheJob\Consumption.
- Next, you should schedule the cache generation to automatically update the cache. For information, see Scheduling Cache Generation.
You can now proceed to scheduling the automatic execution of reports. Alternatively, you can directly access and view report outputs.
5 – Create a Link for the Report to be Executed
- In System Browser, select the view with the hierarchical structure of the building with floors, and managed meters installed on the floors.
- Select the building, floor, or managed meter for which you want to generate an energy report.
- The list of reports associated with the selected building, floor, or meter displays in the Application Viewer tab.
- Select the report (for example, Consumption, Load Profile, or Max Power) that you want to schedule.
- Click Save As .
- In the Save As dialog box, enter the destination for saving the link.
- The saved link displays in the Applications > Links folder.
6 – Set User Credentials
- In System Browser, select Application View.
- Navigate to Applications > Links.
- Select the link(s) whose credentials you want to set.
NOTE: If you select multiple links, the selected software account is applied to all of them.
- Click Set Credentials .
- The Set Credentials dialog box displays.
- From the User Account drop-down menu, select the appropriate user from the list of existing software accounts.
NOTE: You must choose a user with the appropriate privileges. The language associated with the software account determines the language for any reports generated with this account.
- In the Extended Operation tab, specify the parameter values for the link. Ensure that you do not change the value of the P1 parameter as it reflects the name and location of the report. You can set the other parameter values as per the desired output.
NOTE: For information, see P3 Link Parameters for Load Profile Report, P4 Link Parameters for Load Profile Report, P3 Link Parameters for Max Power Report, P4 Link Parameters for Max Power Report, P3 Link Parameters for Consumption Report, P4 Link Parameters for Consumption Report.
- The user credentials are set for the link and parameter values are specified.
NOTE: In the Operating mode, you can run a report in the Application Viewer by selecting the link from Applications > Links, if the value of the P2 parameter is set to HTML. However, if the value of the P2 parameter is set to any other value (for example, XLSX, DOCX, PDF), then you cannot run the report in the Application Viewer. In this case, you can run the report by clicking Execute in the Extended Operation pane, and specifying the required parameter values.
7 – Schedule Automatic Execution of the Report
You can schedule the automatic execution of energy reports to an output folder or as an email attachment.
- System Manager is in Engineering mode.
- In System Browser, select Application View.
- Select Applications > Logics > Reactions.
- In the Reaction Editor tab, open the Output expander and then the Action expander.
- Drag the link from Links folder (created in Step 5) to the Scope/Target area of the Action expander.
- Select the newly-added instruction row and do the following:
- To send the report as an email, in the Command drop-down list, select Email [SendEmailExecute].
- To send the report to a folder, in the Command drop-down list, select Execute [WebAppExecute].
- In the Output Format drop-down list, select the format of the file. The value specified in this field must be the same as the P2 parameter value specified in the Extended Operations tab.
For example, if you have specified PDF as the P2 parameter value, then you must select PDF as the output format in this field.
- In the File Name field, enter the file name of the report output file.
- (Optional) In the File Path field, enter the location to save the report output file. For example, C:\Projects\NewReports.
NOTE: If you specify the location, the report is saved to this location and will also be sent as an email attachment.
- In the Section drop-down list, select Save Document [1].
- In the TimeStamp field, specify the timestamp format that is to be appended to the file name, for example, dd-MM-yyyy.hhmmss.
- Open the Triggers expander, and then open the Time and Organization Mode expander.
- Enter the date and time for report execution.
- Click Save As .
- Depending on the value specified in the Command drop-down list, the report executes at the date and time as specified in the reaction and is either sent as an attachment to the configured email recipients or to the report output folder specified in the File Path field.