What is a Report?

This guide provides information about how Reports in the Resolute software work to identify equipment performance issues and describes the requirements to create a Report. 

What is a Report 

A Report is a document produced by transforming low-level analytics into high-level actions and answers. A Report is always attached to a building and provides information about equipment within that building. Reports are generated for all equipment types within a building. The VAV Scorecard Report provides information about all VAVs within a given building. If that building has no equipment set with the VAV type, then the VAV Scorecard Report cannot be generated for that building. 

Some Reports are not only designed to provide information about a particular type of equipment, but they also require sets of tags to be associated with the equipment. If the equipment has the right type but is missing the required tags, the Report will not include that piece of equipment. Such requirements for additional equipment tags are referred to as Equipment Tag Constraints.  

What are the Inputs to a Report? 

To appear in a Report, each piece of equipment of the appropriate type and with the appropriate Equipment Tag Constraints must have at least one input point. There are two general categories of input points: 

• Standard Input Points: A Standard Input Point uses a Resolute connector (such as Niagara) to retrieve time-series data at regular intervals. Standard Input Points for a Rule are selected based on the tags associated with a given point and the position of the point in the building hierarchy. If the requirements for those two classifiers are not met, the Report will not be created. 
• Rule Input Points: A Rule Input Point is the output of a Rule applied to a given piece of equipment. It is a time series representing the presence or absence of a given fault condition. 

If a given piece of equipment is missing any of the required input points, then it will not appear in the Report. Certain Reports will have more complex requirements around the presence or absence of different input points. A Report might, for instance, stipulate that it requires either an “EffCoolSp” point or an “EffHeatSp” point. Taken by themselves, each of these points is optional, but a given piece of equipment will not be included in the Report unless at least one of these input points is present. Such requirements governing the presence or absence of more than one input point are referred to as Tuple Constraints. 

What is Standard Input Point Multiplicity? Scalar Versus Vector 

A Scalar Input Point is defined that there is only a single match that can exist. A Vector Input Point can have more than one match and all matches are used to generate the Report data. 

Most Reports are defined in such a way that only a single match can exist for a given input point. For instance, if a Report expects that a VAV will have a single child point with the “ZoneTemp” point template applied to it, and if more than one “ZoneTemp” point is found for a given VAV, then the Report will not include the VAV in question unless the input point has also been defined as optional. This is because the Report was expecting a single “ZoneTemp” input point, and it does not know what to do with multiple “ZoneTemp” input points.