This article lists all the template keys you can use when creating a Result Summary report template. The Result Summary report can be created from a whole ruleset, a sub-ruleset or an individual rule. It gives detailed information about the checking results and functions as a tool for evaluating model quality development.
There are ruleset, rule, issue and component level keys available for the template. In addition, there are template keys for the rule parameters of each rule. These are listed on a PDF file which you can download at the end of this article.
Template keys are essentially placeholders or variables that you can use within your template to dynamically insert data. Instead of hard-coding specific values into cells, you use these keys to represent where data should be inserted. This allows for easy customization and automation of the spreadsheet.
The comprehensive set of all template keys are available in v24.5.0. Earlier versions include 23 template keys.
Tip
V24.5.0 resources include a new Excel template among the available data reporting templates in the Result Summary View. The template contains some of the new keys, and you can enrich it by adding keys that are relevant and interesting for you.
-
In Windows, the file path for the new report is: Local disk (C:) > Users > Public > Solibri > SOLIBRI > Report Templates > Summary report > CheckingSummaryTemplate - Issue and Components.xlsx
-
You can also download the new template at the end of this article.
The article covers the following topics:
Related articles:
Below is a list of all template keys on ruleset level:
Table 1. Ruleset Level Template Keys
|
Template Key |
Description |
|---|---|
|
<ACCEPTED_COMPONENTS> |
Count of Accepted Components |
|
<ACCEPTED_ISSUES> |
Count of Accepted Issues |
|
<ALL_ISSUES> |
Count of All Issues |
|
<CHECKED_COMPONENTS> |
Count of Checked Components |
|
<COMPONENTS_IN_CRITICAL_ISSUES> |
Count of Components in Critical Issues |
|
<COMPONENTS_IN_LOW_SEVERITY_ISSUES> |
Count of Components in Low Severity Issues |
|
<COMPONENTS_IN_MODERATE_ISSUES> |
Count of Components in Moderate Issues |
|
<CRITICAL_ISSUES> |
Count of Critical Issues |
|
<FAILED_COMPONENTS> |
Count of Failed Components |
|
<LOW_SEVERITY_ISSUES> |
Count of Low severity Issues |
|
<MODERATE_ISSUES> |
Count of Moderate Issues |
|
<PASSED_COMPONENTS> |
Count of Passed Components |
|
<REJECTED_COMPONENTS> |
Count of Rejected Components |
|
<REJECTED_ISSUES> |
Count of Rejected Issues |
|
<RULESET_DESCRIPTION> |
Ruleset Description |
|
<RULESET_NAME> |
Ruleset |
|
<UNDEFINED_COMPONENTS> |
Count of Undefined Components |
Below is a list of all template keys on rule level:
Table 2. Rule Level Template Keys
|
Template key |
Description |
|---|---|
|
<RULE_AUTHOR> |
Rule Author |
|
<RULE_DATE> |
Rule Date |
|
<RULE_DECISION> |
Rule decision |
|
<RULE_ID> |
Rule ID |
|
<RULE_IRRELEVANT_TEXT> |
Rule Irrelevant Comment |
|
<RULE_NAME> |
Name of the rule |
|
<RULE_SUPPORT_TAG> |
Rule Support Tag |
|
<RULE_VERSION> |
Rule Version |
Below is a list of all template keys on issue level:
Table 3. Issue level template keys
|
Template key |
Description |
|---|---|
|
<ISSUE_CATEGORIES> |
Issue Categories |
|
<ISSUE_CATEGORY> |
Issue Category |
|
<ISSUE_COMPONENT_COUNT> |
Issue Component Count |
|
<ISSUE_COMPONENTS_ADDRESS> |
Addresses of Issue Components |
|
<ISSUE_COMPONENTS_APPLICATION> |
Applications of Issue Components |
|
<ISSUE_COMPONENTS_BAT_ID> |
Bat IDs of Issue Components |
|
<ISSUE_COMPONENTS_BEAM_AREA> |
Beam Areas of Issue Components |
|
<ISSUE_COMPONENTS_BOUNDING_BOX_HEIGHT> |
Bounding Box Heights of Issue Components |
|
<ISSUE_COMPONENTS_BOUNDING_BOX_LENGTH> |
Bounding Box Lengths of Issue Components |
|
<ISSUE_COMPONENTS_BOUNDING_BOX_WIDTH> |
Bounding Box Widths of Issue Components |
|
<ISSUE_COMPONENTS_BUILDING> |
Issue Components Building |
|
<ISSUE_COMPONENTS_CEILING_AREA> |
Ceiling Areas of Issue Components |
|
<ISSUE_COMPONENTS_COLUMN_AREA> |
Column Areas of Issue Components |
|
<ISSUE_COMPONENTS_COMPOSITION_TYPE> |
Composition Types of Issue Components |
|
<ISSUE_COMPONENTS_CONSTRUCTION_TYPE_NAME> |
Construction Type Names of Issue Components |
|
<ISSUE_COMPONENTS_DESCRIPTION> |
Descriptions of Issue Components |
|
<ISSUE_COMPONENTS_DISPLAY_NAME> |
Display Names of Issue Components |
|
<ISSUE_COMPONENTS_DOMAIN> |
Domains of Issue Components |
|
<ISSUE_COMPONENTS_DOOR_AREA> |
Door Areas of Issue Components |
|
<ISSUE_COMPONENTS_ELEMENT_TYPE> |
Element Types of Issue Components |
|
<ISSUE_COMPONENTS_ELEVATION> |
Elevations of Issue Components |
|
<ISSUE_COMPONENTS_ELEVATION_DIFF_TO_NEXT_STOREY> |
Elevation Differences To Next Storey of Issue Components |
|
<ISSUE_COMPONENTS_ELEVATION_WITH_FLOORING> |
Elevation with Flooring values of Issue Components Level of flooring of this space; the average is be taken if the space ground surface is sloping or if there are level differences within this space. For more information, see the BuildingSMART website. |
|
<ISSUE_COMPONENTS_FEDERATED_FLOOR> |
Issue Components Federated Floor |
|
<ISSUE_COMPONENTS_FILLED> |
A list of Filled values (true or false) for Issue Components This value is for Openings and it provides information on if the Openings related to the issue are filled with a door or a window. |
|
<ISSUE_COMPONENTS_FIRERATING> |
Fire Ratings of Issue Components |
|
<ISSUE_COMPONENTS_FLOOR_AREA> |
Floor Areas of Issue Components |
|
<ISSUE_COMPONENTS_FLOW_DIRECTION> |
Flow Directions of Issue Components |
|
<ISSUE_COMPONENTS_FUNCTIONAL_TYPE> |
Functional Types of Issue Components |
|
<ISSUE_COMPONENTS_GEOMETRY> |
Geometries of Issue Components |
|
<ISSUE_COMPONENTS_GLOBAL_TOP_ELEVATION> |
Global Top Elevations of Issue Components |
|
<ISSUE_COMPONENTS_GLOBAL_BOTTOM_ELEVATION> |
Global Bottom Elevations of Issue Components |
|
<ISSUE_COMPONENTS_GLOBAL_X> |
Global X values of Issue Components |
|
<ISSUE_COMPONENTS_GLOBAL_Y> |
Global Y values of Issue Components |
|
<ISSUE_COMPONENTS_GLOBAL_Z> |
Global Z values of Issue Components |
|
<ISSUE_COMPONENTS_GROUP> |
Groups of Issue Components |
|
<ISSUE_COMPONENTS_GUID> |
GUIDs of Issue Components |
|
<ISSUE_COMPONENTS_IFC_ENTITY> |
IFC Entities of Issue Components |
|
<ISSUE_COMPONENTS_IFC_TYPE> |
IFC Types of Issue Components |
|
<ISSUE_COMPONENTS_IFC_SCHEMA> |
IFC Schemas of Issue Components |
|
<ISSUE_COMPONENTS_IS_EXTERNAL> |
List of Is_External values of Issue Components |
|
<ISSUE_COMPONENTS_IS_INTERIOR> |
List of Is_Interior values of Issue Components |
|
<ISSUE_COMPONENTS_IS_RELATIVE> |
List of Is_Relative values of Issue Components |
|
<ISSUE_COMPONENTS_LATITUDE> |
List of Latitudes of Issue Components |
|
<ISSUE_COMPONENTS_LAYER> |
Layers of Issue Components |
|
<ISSUE_COMPONENTS_LONG_NAME> |
Long Names of Issue Components |
|
<ISSUE_COMPONENTS_LONGITUDE> |
Longitudes of Issue Components |
|
<ISSUE_COMPONENTS_MATERIAL> |
Materials of Issue Components |
|
<ISSUE_COMPONENTS_MATERIAL_SCHEMA> |
Material Schemas of Issue Components |
|
<ISSUE_COMPONENTS_MODEL> |
Model information of Issue Components |
|
<ISSUE_COMPONENTS_MODEL_CATEGORIES> |
Model Categories of Issue Components |
|
<ISSUE_COMPONENTS_NAME> |
Names of Issue Components |
|
<ISSUE_COMPONENTS_NEAREST_SPACE> |
Nearest Spaces of Issue Components |
|
<ISSUE_COMPONENTS_NUMBER> |
Numbers of Issue Components |
|
<ISSUE_COMPONENTS_OBJECT_TYPE> |
Object Types of Issue Components |
|
<ISSUE_COMPONENTS_OCCUPANT> |
Occupants of Issue Components |
|
<ISSUE_COMPONENTS_OPERATION> |
Operations of Issue Components |
|
<ISSUE_COMPONENTS_OPERATION_TYPE> |
Operation Types of Issue Components |
|
<ISSUE_COMPONENTS_PHASE> |
Phases of Issue Components |
|
<ISSUE_COMPONENTS_POSTAL_ADDRESS> |
Postal Addresses of Issue Components |
|
<ISSUE_COMPONENTS_PREDEFINED_TYPE> |
Predefined Types of Issue Components |
|
<ISSUE_COMPONENTS_PROFILE_TYPE> |
Profile Types of Issue Components |
|
<ISSUE_COMPONENTS_PROJECT> |
Projects of Issue Components |
|
<ISSUE_COMPONENTS_REF_PERIMETER_NET_AREA> |
Ref Perimeter Net Areas of Issue Components |
|
<ISSUE_COMPONENTS_RELATIVE_BOTTOM_ELEVATION> |
Relative Top Elevation of Issue Components |
|
<ISSUE_COMPONENTS_RELATIVE_TOP_ELEVATION> |
Relative Top Elevation of Issue Components |
|
<ISSUE_COMPONENTS_SHORT_NAME> |
Short Names of Issue Components |
|
<ISSUE_COMPONENTS_SITE> |
Sites of Issue Components |
|
<ISSUE_COMPONENTS_SPACE_GROUP_TYPE> |
Space Group Types of Issue Components |
|
<ISSUE_COMPONENTS_STOREY> |
Storeys of Issue Component |
|
<ISSUE_COMPONENTS_SYSTEM> |
Systems of Issue Components |
|
<ISSUE_COMPONENTS_SYSTEM_TYPE> |
System Types of Issue Components |
|
<ISSUE_COMPONENTS_TOPIC> |
Topics of Issue Components |
|
<ISSUE_COMPONENTS_TRIANGLE_COUNT> |
Triangle Counts of Issue Components |
|
<ISSUE_COMPONENTS_TYPE> |
Types of Issue Components |
|
<ISSUE_COMPONENTS_TYPE_NAME> |
Type Names of Issue Components |
|
<ISSUE_COMPONENTS_VERSION> |
Versions of Issue Components |
|
<ISSUE_COMPONENTS_WALL_AREA> |
Wall Areas of Issue Components |
|
<ISSUE_COMPONENTS_WINDOW_AREA> |
Window Areas of Issue Components |
|
<ISSUE_COMPONENTS_ZONE> |
Zones of Issue Components |
|
<ISSUE_DECISION> |
Issue Decision |
|
<ISSUE_DESCRIPTION> |
Issue Description |
|
<ISSUE_LOCATION> |
Issue Location |
|
<ISSUE_NAME> |
Issue Name |
|
<ISSUE_SEVERITY> |
Issue Severity |
Below is a list of all template keys on component level:
Table 4. Component Level Template Keys
|
Template Key |
Description |
|---|---|
|
<COMPONENT_ADDRESS> |
Component Address |
|
<COMPONENT_APPLICATION> |
Component Application |
|
<COMPONENT_BAT_ID> |
Component Bat ID |
|
<COMPONENT_BEAM_AREA> |
Component Beam Area |
|
<COMPONENT_BETWEEN_SPACES> |
Component Between Spaces |
|
<COMPONENT_BOUNDING_BOX_LENGTH> |
Component Bounding Box Length |
|
<COMPONENT_BOUNDING_BOX_HEIGHT> |
Component Bounding Box Height |
|
<COMPONENT_BOUNDING_BOX_WIDTH> |
Component Bounding Box Width |
|
<COMPONENT_BUILDING> |
Component Building |
|
<COMPONENT_CEILING_AREA> |
Component Ceiling Area |
|
<COMPONENT_COLUMN_AREA> |
Component Column Area |
|
<COMPONENT_COMPOSITION_TYPE> |
Component Composition Type |
|
<COMPONENT_CONSTRUCTION_TYPE_NAME> |
Component Construction Type name |
|
<COMPONENT_DOMAIN> |
Component Domain |
|
<COMPONENT_DOOR_AREA> |
Component Door Area |
|
<COMPONENT_DESCRIPTION> |
Component Description |
|
<COMPONENT_DISPLAY_NAME> |
Component Display Name |
|
<COMPONENT_ELEMENT_TYPE> |
Component Element Type |
|
<COMPONENT_ELEVATION> |
Component Elevation |
|
<COMPONENT_ELEVATION_DIFF_TO_NEXT_STOREY> |
Component Elevation Difference To Next Storey |
|
<COMPONENT_ELEVATION_WITH_FLOORING> |
Component Elevation With Flooring |
|
<COMPONENT_FEDERATED_FLOOR> |
Component Federated Floor |
|
<COMPONENT_FILLED> |
Component Filled |
|
<COMPONENT_FIRERATING> |
Component Fire Rating |
|
<COMPONENT_FLOOR_AREA> |
Component Floor Area |
|
<COMPONENT_FLOW_DIRECTION> |
Component Flow Direction |
|
<COMPONENT_FUNCTIONAL_TYPE> |
Component Functional Type |
|
<COMPONENT_GEOMETRY> |
Component Geometry |
|
<COMPONENT_GLOBAL_BOTTOM_ELEVATION> |
Component Global Bottom Elevation |
|
<COMPONENT_GLOBAL_TOP_ELEVATION> |
Component Global Top Elevation |
|
<COMPONENT_GLOBAL_X> |
Component Global X |
|
<COMPONENT_GLOBAL_Y> |
Component Global Y |
|
<COMPONENT_GLOBAL_Z> |
Component Global Z |
|
<COMPONENT_GROUP> |
Component Group |
|
<COMPONENT_GUID> |
Component Guid |
|
<COMPONENT_IFC_ENTITY> |
Component Ifc Entity |
|
<COMPONENT_IFC_SCHEMA> |
Component Ifc Schema |
|
<COMPONENT_IFC_TYPE> |
Component Ifc Type |
|
<COMPONENT_IS_EXTERNAL> |
Component Is External |
|
<COMPONENT_IS_INTERIOR> |
Component Is Interior |
|
<COMPONENT_IS_RELATIVE> |
Component Is Relative |
|
<COMPONENT_LATITUDE> |
Component Latitude |
|
<COMPONENT_LAYER> |
Component Layer |
|
<COMPONENT_LONG_NAME> |
Component Long Name |
|
<COMPONENT_LONGITUDE> |
Component Longitude |
|
<COMPONENT_MATERIAL> |
Component Material |
|
<COMPONENT_MATERIAL_SCHEMA> |
Component Material Schema |
|
<COMPONENT_MODEL> |
Component Model |
|
<COMPONENT_MODEL_CATEGORIES> |
Component Model Categories |
|
<COMPONENT_NAME> |
Component Name |
|
<COMPONENT_NEAREST_SPACE> |
Component Nearest Space |
|
<COMPONENT_NUMBER> |
Component Number |
|
<COMPONENT_OBJECT_TYPE> |
Component Object Type |
|
<COMPONENT_OCCUPANT> |
Component Occupant |
|
<COMPONENT_OPERATION> |
Component Operation |
|
<COMPONENT_OPERATION_TYPE> |
Component Operation Type |
|
<COMPONENT_PHASE> |
Component Phase |
|
<COMPONENT_POSTAL_ADDRESS> |
Component Postal Address |
|
<COMPONENT_PREDEFINED_TYPE> |
Component Predefined Type |
|
<COMPONENT_PROFILE_TYPE> |
Component Profile Type |
|
<COMPONENT_PROJECT> |
Component Project |
|
<COMPONENT_REF_PERIMETER_NET_AREA> |
Component Ref Perimeter Net Area |
|
<COMPONENT_RELATIVE_BOTTOM_ELEVATION> |
Component Relative Bottom Elevation |
|
<COMPONENT_RELATIVE_TOP_ELEVATION> |
Component Relative Top Elevation |
|
<COMPONENT_SPACE_GROUP_TYPE> |
Component Space Group Type |
|
<COMPONENT_SHORT_NAME> |
Component Short Name |
|
<COMPONENT_SITE> |
Component Site |
|
<COMPONENT_STOREY> |
Component Storey |
|
<COMPONENT_SYSTEM> |
Component System |
|
<COMPONENT_SYSTEM_TYPE> |
Component System Type |
|
<COMPONENT_TOPIC> |
Component Topic |
|
<COMPONENT_TRIANGLE_COUNT> |
Component Triangle Count |
|
<COMPONENT_TYPE> |
Component Type |
|
<COMPONENT_TYPE_NAME> |
Component Type Name |
|
<COMPONENT_VERSION> |
Component Version |
|
<COMPONENT_WALL_AREA> |
Component Wall Area |
|
<COMPONENT_WINDOW_AREA> |
Component Window Area |
|
<COMPONENT_ZONE> |
Component Zone |