Building Operation Tutorial

Administering Reports

Purpose of This Guide

This tutorial provides step-by-step instructions for logging on to WebReports, running reports manually and automatically according to schedule, creating and configuring typical dashboard reports, configuring Report Manager, and viewing reports in WorkStation.

This tutorial focuses on the following Building Operation Engineering Certification objectives:

  • Create reports

  • ​Edit reports

  • ​Schedule reports to be automatically generated

  • ​Generate reports manually

University X

We are going to install Building Operation as the building management system for University X. The university is a campus of buildings for which heating and cooling are supplied from a Central Plant with an underground distribution system. The case study focuses on the renovation of the Central Plant and the expansion of the School of Business.

The ​School of Business and the​ Central Plant

The ​School of Business and the​ Central Plant

The Cooling Plant consists of a single chiller with a primary-secondary pumping system. The secondary water loop serves four VAV air handling units with chilled water coils located in the School of Business. The secondary loop has two water pumps. Only one pump is required for 100 % of the load. The second pump provides 100 % backup. The secondary pumps are variable speed. The primary chilled water loop has a single constant volume chilled water pump. The condenser loop rejects heat by means of a cooling tower. The condenser loop has a single constant volume condenser water pump. The tower has two constant speed, draw-through fans to increase the capacity of the tower above the natural draft capacity. A diverting valve can be used to protect the chiller from condenser water thermal shock. The water leaving the condenser can be diverted back to the inlet of the condenser without any cooling effect.

Cooling Plant diagram

Cooling Plant diagram

The heating plant consists of two boilers in parallel, each with their own inline pumps.  Much of the time only one boiler is required to meet the load but under greater load, both boilers will operate at the same time.  The flow from the two boilers comes together in a common supply header.  There is a line from the supply header to the mechanical systems that require a source of hot water.  This line has two constant volume distribution pumps in parallel.  Only one is required to meet the load.  The second is back-up and lead-lag is used to alternate which pump runs.  The water returning from the mechanical systems flows into the return header where it can be pumped by the inline pumps through the boilers.  There is a common line between the supply header and the return header.  When the inline pumps are flowing at a rate that exceeds the distribution pump flow rate, the water flow in the common line is from the supply header to the return header.  When the distribution pump is flowing at a rate that exceeds the combined inline pump flow rates, flow in the common line is from the return header to the supply header.  Each boiler has its own self contained control system that interfaces with Building Operation through a combination of binary electrical control and network variables.  The inline pumps are locally controlled by the self contained control system.

Heating Plant diagram

Heating Plant diagram

Notice

The programs and files that are used for the fictional customer University X are intended for training purposes only.

Requirements and Specifications

To be able to configure Building Operation for University X, the following devices and software are used in this tutorial.

Devices Used for This Case Study

The following devices are used for this case study:

  • Power Supply, PS-24V

  • Automation Server, AS-B or AS-L

  • I/O Modules:

    • 1 x DI-16

    • 1 x DO-FA-12

    • 2 x UI-8/AO-4

Software Used in This Tutorial

The following software is used in this tutorial:

  • License Administrator, and a valid license

  • Enterprise Server

  • WorkStation

  • Reports Server

Specifications

You find specifications in the Building Operation datasheets for Enterprise Server, WorkStation, Reports Server, PS-24V Power Supply, Automation Server, and I/O Module Family.

Focus of This Tutorial

The university requires reports for monitoring and recording the performance and energy consumption of the Central Plant. Additionally, they require reports for monitoring and archiving user activities. All reports should be accessible both from the Internet and WorkStation.

In this tutorial, you create dashboard reports that will be generated both manually and according to schedule. These reports, which are created from default templates, will include activities per user, comparison of information captured in extended trend logs, and energy consumption data obtained from power meters. You configure Report Manager and create reports in WorkStation to make the dashboard reports easily accessible in WorkStation.

Pre-existing Database Folders and Programs

For University X, the Enterprise Server called University X ES1 has the following folder structure:

​University X ES1 and its folder structure

​University X ES1 and its folder structure

​The Automation Server called CPlant AS controls the Cooling Plant and Heating Plant.

CPlant AS​ has the following folder structure:

CPlant AS and its folder structure

CPlant AS and its folder structure

CPlant AS has the following programs for the Cooling Plant:

​CPlant AS and its programs for the Cooling Plant

​CPlant AS and its programs for the Cooling Plant

CPlant AS has the following programs for the Heating Plant:

CPlant AS and its programs for the Heating Plant

CPlant AS and its programs for the Heating Plant

Pre-existing Database Objects

For University X, the following objects are available in the Building Operation database prior to the administration of reports:

  • ...University X ES1/Application/Extended Trend Logs/ChwrTempCV Extended Log

  • ...University X ES1/Application/Extended Trend Logs/ChwsTempCV Extended Log

  • ...University X ES1/Application/Extended Trend Logs/HwrTempCV Extended Log

  • ...University X ES1/Application/Extended Trend Logs/HwsTempCV Extended Log

  • ...University X ES1/Application/Extended Trend Logs/OaTempCV Extended Log

  • ...University X ES1/Application/Extended Trend Logs/ClgEnergyConsumption Extended Log

  • ...University X ES1/Application/Extended Trend Logs/HtgEnergyConsumption Extended Log

  • ...University X ES1/System/Domains/University X Domain/Users/Susan

  • ...University X ES1/System/Domains/University X Domain/Users/Steve

  • ...University X ES1/System/Domains/University X Domain/Users/Richard

  • ...University X ES1/System/Domains/University X Domain/Users/John

Our Example

In this chapter, you create the Energy folder, which provides facilities for site energy monitoring. In the Energy folder, you create a hierarchy of sites and meters. The meter hierarchy provides the source from which energy reports are generated. In our example, you create a site to represent the Central Plant Building. Within the site, you create two meters to represent external power meters for the Cooling Plant and the Heating Plant respectively. To obtain data for your reports, you associate an extended trend log with each meter. In our example, the power meters are simulated by a program.

Logging on to WorkStation as a StruxureWare User

You log on to WorkStation to securely access the functions in Building Operation.

Notice

​​Ensure that you have a working and available WorkStation license. A working license is required to log on to WorkStation. For more information, see Licenses .

Show More

In this example, you log on to WorkStation using the default administrator account.

To log on to WorkStation as a StruxureWare user
  1. In the Welcome to StruxureWare window, click Other user .

  2. In the User name box, type the user name. procedure example icon In this example, type “admin.”

  3. In the Password box, type the password. procedure example icon In this example, type “admin.”

  4. In the Domain box, type a domain name. If you do not enter a domain name, you are logged on to the local domain. procedure example icon In this example, do not type a domain name.

  5. In the Server box, enter a server name or IP address. procedure example icon In this example, enter localhost .

  6. Select Remember me to have WorkStation remember your settings.

  7. Click Log on .

  8. If the Select Default Workspace window is displayed, click the workspace you want to have as the default. procedure example icon In this example, click Engineering .

Creating the Energy Folder

You create the Energy folder to provide a receptacle for an energy monitoring site hierarchy.

Show More

In this example, you create the Energy folder under the University X ES1 in the System Tree pane. The Energy folder provides the facility for you to create a hierarchy of sites and meters for energy monitoring.

To create the Energy Folder
  1. In WorkStation, in the System Tree pane, select the Enterprise Server root folder. procedure example icon In this example, select ...University X ES1 .

  2. On the File menu, point to New and then click Energy .

  3. In the Name box, type a name for the Energy folder. procedure example icon In this example, keep the default name “Energy.”

  4. In the Description box, type a description for the Energy folder. procedure example icon In this example, do not type a description.

  5. Click Create .

You now add sites and meters.

Notice

You must not create more than one Energy folder, even though it is possible to do so (future versions may not support multiple Energy folder creation). Furthermore, you must create the Energy folder in the root of the Enterprise Server.

Creating a Site

You create a site (or a sub-site) to represent the location of a meter, or a group of meters.

Show More

In this example, you create a site named Central Plant Bldg in the Energy folder.

To create a site
  1. In WorkStation, in the System Tree pane, select the Energy folder or a site in the Energy folder. procedure example icon In this example, select ...University X ES1/Energy .

  2. On the File menu, point to New and then click Site .

  3. In the Name box, type a name for the site. procedure example icon In this example, type “Central Plant Bldg.”

  4. In the Description box, type a description for the site. procedure example icon In this example, do not type a description.

  5. Click Create .

You now create a meter or a sub-site.

Creating a Meter

You create a meter within a site to represent an external meter.

Show More

In this example, you create an electricity meter within the Central Plant Bldg site to represent an external power meter for the Cooling Plant. In our example, the external power meter is simulated by a program.

To create a meter
  1. In WorkStation, in the System Tree pane, select the Energy folder or a site in the Energy folder. procedure example icon In this example, select ...University X ES1/Energy/Central Plant Bldg .

  2. On the File menu, point to New and then click Meter .

  3. In the object list, select the type of meter. procedure example icon In this example, select Electricity Meter .

  4. In the Name box, type a name for the meter. procedure example icon In this example, type “Electricity Meter Cooling Plant.”

  5. In the Description box, type a description for the meter. procedure example icon In this example, do not type a description.

  6. Click Create .

You now configure the meter.

For this example, repeat the procedure to create an electricity meter to represent an external power meter for the Heating Plant. Use the following settings:

  • Location : ...University X ES1/Energy/Central Plant Bldg

  • Type : Electricity

  • Name : Electricity Meter Heating Plant

Associating an Extended Trend Log with an Energy Meter

You associate an extended trend log with an energy meter to provide the source from which you can generate energy reports.

Show More

In this example, you associate the meter named Electricity Meter Cooling Plant with the extended trend log named ClgEnergyConsumption Extended Log.

To associate an extended trend log with an energy meter
  1. In WorkStation, in the System Tree pane, select the meter with which you want to associate an extended trend log. procedure example icon In this example, select ...University X ES1/Energy/Central Plant Bldg/Electricity Meter Cooling Plant .

  2. On the File menu, click Properties .

  3. In the Meter Trend Log box, enter the path of the extended trend log. procedure example icon In this example, enter ...University X ES1/Application/Extended Trend Logs/ClgEnergyConsumption Extended Log .

  4. Click OK .

For this example, repeat the procedure to associate the extended trend log with the meter named Electricity Meter Heating Plant. Use the following settings:

  • Location : ...University X ES1/Energy/Central Plant Bldg/Electricity Meter Heating Plant

  • Meter Trend Log : ...University X ES1/Application/Extended Trend Logs/HtgEnergyConsumption Extended Log

Our Example

If the chilled water and hot water systems are not maintained well, the efficiency of the plant declines over time.

In order to regularly evaluate the plant as well as track user actions that may affect the plant performance, the university requires reports to graphically compare and display extended trend log data.

In this chapter, you create reports for user activities, energy consumption, and trend data comparisons to evaluate the plant.

Adding a User Account to a User Account Group

You add a user account to a user account group to add software permissions and workspaces to a user.

Show More

In this example, you add the admin user account of the Local domain to the Reports Administrators and Administrators user account groups. As a result, the admin user is provided with access to administrative functions on the WebReports menu bar and the user is also associated with a workspace.

To add a user account to a user account group
  1. In WorkStation, on the Tools menu, click Control Panel .

  2. On the Control Panel , in the Server list, select the server where the user account is located. procedure example icon In this example, select University X ES1 .

  3. Click Account management .

  4. In the Domain list, select the domain the user account belongs to. procedure example icon In this example, select Local .

  5. In the User Accounts list, select the user account you wish to add to a user account group. procedure example icon In this example, select admin .

  6. Click Group membership .

  7. In the Available User Account Groups list, select a user account group and click the Add button . procedure example icon In this example, select Administrators and Reports Administrators .

  8. On the File menu, click Save .

Logging On to WebReports

You log on to the WebReports Web site when you want to view and customize reports using your web browser. If you log on using an administrator's account, you can also create schedules, upload images, create report packs, rename and delete custom reports, and assign templates to be used with default reports.

Show More

To log on to WebReports
  1. In the address bar of your Web browser, type the WebReports URL, for example, http://10.159.17.246/SchneiderElectric/WebReports.

  2. In the User name box, type your WorkStation user name. procedure example icon In this example, type "admin."

  3. In the Password box, type your WorkStation password. procedure example icon In this example, type "admin."

  4. Select Remember me to save your user name.

  5. Click Log on .

Uploading an Image

You upload an image when you want to add the image to the Image Library and use the image in the header of your reports. You can upload one or two images, and then decide to add the images to the left or right of the header.

Show More

In this example, you upload a University X logo with white background and select to use it on the upper left side of the university's reports.

To upload an image
  1. In WebReports, on the menu bar, click Images .

  2. In the Image file box, enter the image file that you want to upload. procedure example icon In this example, enter C:\Project University X\Images\University - X Logo White Background small.png​ .

  3. In the Image tag box, select a tag to identify the image in the image database. procedure example icon In this example, select Category1 .

  4. In the Image name box, type a name for the image. procedure example icon In this example, type “University X logo.”

    Notice
    • Do not use the name “Default” as this name is reserved for Schneider Electric images. Images named “Default” cannot be deleted.

  5. Click Save .

  6. In the Left image box, select the image that you want to position on the upper left side of the report. procedure example icon In this example, select Category1/University X logo .

  7. In the Right image box, select the image that you want to position on the upper right side of the report. procedure example icon In this example, keep the default image.

  8. Click Save .

Creating an Activities Per User Dashboard Report

You create an Activities Per User dashboard report when you want to enter and save filtering criteria, and then run the report in the future based on the same filtering criteria.

Show More

In this example, you create an Activities Per User dashboard report for the user named Susan.

To create an Activities Per User dashboard report
  1. In WebReports, on the menu bar, click View .

  2. In the Reports Tree , expand Production Reports and then select Activities Per User .

  3. In the Date Range Filter box, select one of the following filter options to define the start time and end time for the report:

    • Select one of the predefined date range filters.

    • Select Fixed Date , and in the Start Report Date/Time boxes, enter a start date and type a start time. In the End Report Date/Time boxes, enter an end date and type an end time.

    procedure example icon In this example, select the predefined date range filter Last 7 Days .
  4. In the User box, select the user you want to view activities for. procedure example icon In this example, select University X Domain/Susan .

    Notice
    • You can only create reports for users that have performed some actions, for example, logged on to the system or created an object.

  5. In the Report View box, select how you want the information to be displayed. procedure example icon In this example, select Graphs and Tables .

  6. In the Show Top box, select the number of user activities you want in the report. procedure example icon In this example, select 50 .

  7. Click Submit Form .

  8. Click Save as .

  9. In the Report name box, type a folder name and report name for the dashboard report. procedure example icon In this example, type /University X Reports/User Activities for Susan .

  10. Select Dashboard report .

  11. Click Save as .

  12. Click OK .

For this example, repeat the procedure to create Activities Per User dashboard reports for the users Steve, Richard, and John. Use the following settings:

  • Date Range Filter : Last 7 Days

  • User : University X Domain/[User]

  • Report View : Graphs and Tables

  • Show Top : 50

  • Report Name : /University X Reports/User Activities for [User]

Creating a Trend Log Comparison Dashboard Report

You create a Trend Log Comparison dashboard report to enter and save filtering criteria, and then run the report in the future based on the same filtering criteria.

Show More

In this example, you create the Cooling Plant Load dashboard report.

To create a Trend Log Comparison dashboard report
  1. In WebReports, on the menu bar, click View .

  2. In the Reports Tree , expand Production Reports and then select Trend Log Comparison .

  3. In the Date Range Filter box, select one of the following filter options to define the start time and end time for the report:

    • Select one of the predefined date range filters.

    • Select Fixed Date , and in the Start Report Date/Time boxes, enter a start date and type a start time. In the End Report Date/Time boxes, enter an end date and type an end time.

    procedure example icon In this example, select the predefined date range filter Last 24 Hours .
  4. In the Ext. Trend Logs box, select the extended trend logs you want to compare. procedure example icon In this example, select the following three extended trend logs: ...University X ES1/Application/Extended Trend Logs/ChwrTempCV Extended Log , ChwsTempCV Extended Log , and OaTempCV Extended Log .

  5. In the Report View box, select how you want the information to be displayed. procedure example icon In this example, select Graphs and Tables .

  6. Click Submit Form .

  7. Click Save as .

  8. In the Report name box, type a folder name and report name for the dashboard report. procedure example icon In this example, type /University X Reports/Cooling Plant Load .

  9. Select Dashboard report .

  10. Click Save as .

  11. Click OK .

For this example, repeat the procedure to create the ​Heating Plant Load dashboard report. Use the following settings:

  • Date Range Filter : Last 24 Hours

  • Ext. Trend Logs : ...University X ES1/Application/Extended Trend Logs/:

    • HwrTempCV Extended Log

    • HwsTempCV Extended Log

    • OaTempCV Extended Log

  • Report View : Graphs and Tables

  • Report Name : /University X Reports/Heating Plant Load

Creating a Consumption Dashboard Report

You create a Consumption dashboard report when you want to define fixed filtering criteria, and then run the report in the future with the same filtering criteria applied.

Show More

In this example, you create the Cooling Energy Consumption dashboard report.

To create a Consumption dashboard report
  1. In WebReports, on the menu bar, click View .

  2. In the Reports Tree , expand Energy Monitoring and then select Consumption .

  3. In the Utility Type box, select the utility type. procedure example icon In this example, select Electricity .

  4. At the Power Meter box, point to the green plus sign and then select the site or meter for which you want to see consumption. procedure example icon In this example, select ...University X ES1/Energy/Central Plant Bldg/Electricity Meter Cooling Plant .

  5. In the Date Filter box, select one of the following filter options to define the start time and end time for the report:

    • Select one of the predefined date range filters.

    • Select Fixed Date , and in the Start Report Date/Time boxes, enter a start date and type a start time. In the End Report Date/Time boxes, enter an end date and type an end time.

    procedure example icon In this example, select the predefined date range filter Month To Date .
  6. In the Group Interval box, select the time interval for grouping the report data. procedure example icon In this example, select Daily .

  7. In the Consumption Target box, type the consumption goal for the selected time range. procedure example icon In this example, type “55000” (kWh).

  8. Click Submit Form .

  9. Click Save as .

  10. In the Report name box, type a folder name and report name for the dashboard report. procedure example icon In this example, type /University X Reports/Cooling Energy Consumption .

  11. Select Dashboard report .

  12. Click Save as .

  13. Click OK .

For this example, repeat the procedure to create the Heating Energy Consumption dashboard report. Use the following settings:

  • Utility Type : Electricity

  • Power Meter : University X ES1/Energy/Central Plant Bldg/Electricity Meter Heating Plant

  • Date Filter : Month To Date

  • Group Interval : Daily

  • Consumption Target : 15000 (kWh)

  • Report Name : /University X Reports/Heating Energy Consumption

Creating a Monthly Report Schedule

You create a monthly report schedule when you want the schedule to run a report on a monthly basis on the first or last day of the month, or on both the first and last day of the month at a specified time.

Show More

In this example, you create a report schedule for the Cooling Energy Consumption report to run on the last day of every month at 23:59:59.

To create a monthly report schedule
  1. In WebReports, on the menu bar, click Schedules .

  2. In the Select existing schedule box, select New Schedule .

  3. In the Report schedule name box, type a name for the schedule. procedure example icon In this example, type “EndofMonthCooling.”

  4. In the Schedule description box, type a description for the schedule. procedure example icon In this example, type “Runs the Cooling Energy Consumption report on the last day of the month.”

  5. In the Select a dashboard report box, select the dashboard report that you want to schedule. procedure example icon In this example, select /University X Reports/Cooling Energy Consumption .

  6. In the Frequency box, select Monthly .

  7. In the Start schedule box, enter the date and time to activate the schedule. procedure example icon In this example, enter the current date and the time 23:59:59 .

  8. Select the First box to make the schedule run on the first day of every month. procedure example icon In this example, clear the check box.

  9. Select the Last box to make the schedule run on the last day of every month. procedure example icon In this example, select Last .

  10. In the Report output format box, select the file format to be used when the report is generated. procedure example icon In this example, select Acrobat (PDF) File .

  11. In the Report output destination box, type the directory path on the Reports Server for the report output. procedure example icon In this example, type C:\Project University X\Reports .

  12. Select the Overwrite prior report output box to keep only the most current copy of the report output. procedure example icon In this example, clear the check box.

  13. Select the Disable schedule box to disable the schedule when not used. procedure example icon In this example, clear the check box.

  14. Click Save .

For this example, use the End of Month Cooling Energy Consumption schedule as a template to create the End of Month Heating Energy Consumption schedule running the Heating Energy Consumption report.

  • Select existing schedule : EndofMonthCooling

  • Schedule description : Runs the Heating Energy Consumption report on the last day of the month

  • Select a dashboard report : /University X Reports/Heating Energy Consumption

  • Click Save as .

  • Schedule Name : EndofMonthHeating

Our Example

In order to view reports in WorkStation, it is necessary to configure Report Manager in Enterprise Server.

In this chapter, you configure Report Manager and then view a previously created dashboard report in WorkStation. You created the report in the Reports Tree at the WebReports Web site. The report is available in the Reports folder in the System Tree pane in WorkStation.

Configuring Report Manager

You configure Report Manager so you can view and create reports in WorkStation.

Show More

To configure Report Manager
  1. In WorkStation, in the System Tree pane, expand the System folder.

  2. Select Report Manager .

  3. On the File menu, click Properties .

  4. In the Web site URL box, type the URL of the WebReports Web site, for example, http://10.159.17.246/SchneiderElectric/WebReports/Login.aspx.

  5. In the Web service URL box, type the URL of the WebReports Web service, for example, http://10.159.17.246/SchneiderElectric/WebReportsService.

  6. In the Report source box, select StruxureWare Reports Server .

  7. In the Default Report Folder Name box, keep the default name.

  8. In the Metering Log Filter box, keep the listed units.

  9. On the File menu, click Save .

Viewing a Dashboard Report in WorkStation

You view a dashboard report to see a report based on predefined filtering criteria.

In this example, you view a dashboard report that you have previously created in WebReports.

To view a dashboard report in WorkStation
  1. In WorkStation, in the System Tree pane, expand the Reports folder, and then expand the folder that contains the previously saved dashboard report. procedure example icon In this example, expand ...University X ES1/Reports/University X Reports .

  2. Select the dashboard report. procedure example icon In this example, select one of the available reports.

Summary

You have now created reports that will enable the university to track system activities by user, monitor the efficiency of the Central Plant by comparing trend log data to determine the Cooling Plant and Heating Plant load, and monitor the energy consumption of the Central Plant by obtaining trend log data from power meters connected to the Cooling Plant and Heating Plant. You created a monthly schedule so that the energy consumption reports are generated and saved to a specific location automatically. 

Finally, you configured Report Manager in WorkStation to make the reports accessible not only from the Web, but also from within WorkStation.

Product version

Language