Create a report
Export model information using a report template
Overview
The “Reporting” menu allows data from the model to be exported as structured reports.
A report in big is based on three components:
- Report Type
- Report Template
- Filter Profile
Depending on the selected report type, the following types of content can be exported, for example:
- Instance lists
- Attribute lists
- Type lists
- Room books
- Issue lists
The presentation and structure of the exported data are defined by the respective report template.
Requirements
The following requirements must be met in order to create a report:
- Model data or Issue data must be available in the project.
- The required elements, attributes, or issues must be available in the project.
- Certain report types require a suitable Excel template.
- A filter profile can optionally be used to restrict the exported data.
If a report is to be visible to other users or accessed by PowerBI, it must also be shared.
Opening Reporting
You can access reports via the “Reporting” menu.
Here you can see the existing reports and create new reports.
Click “New Report” to create a new report.
Creating a Report
1 Select a Report Type
First, select the desired report type.
Depending on the use case, different report types are available, for example:
- Instance List
- Attribute List
- Attribute Sheet
- Type List
- Issue List
The report type determines which data will be exported.
2 Upload a Report Template
For many report types, a report template can or must be uploaded.
This is usually an Excel file that defines:
- which columns appear in the export
- how the data is structured
- which variables are populated
Note:
The technical structure of these templates is described in the article “Report Templates”.
3 Select Elements
Next, select the element(s) that should appear in the report.
Depending on the report type, you can select specific building component types or data structures, for example.
4 Select a Filter Profile
The filter profile determines which data is included in the report.
This allows the export to be specifically restricted, for example, to:
- specific disciplines
- specific floors
- specific building components
- open issues
- defined model versions
Important:
A report always takes into account the selected filter settings or the configured filter profile.
5 Share the Report
The report can optionally be shared.
Shared reports:
- are visible to other users
- can be used for further analysis
- can be accessed by PowerBI
6 Save the Report
Save the report after completing the configuration.
The report will then appear in the report overview and can be reopened or exported at any time.
Exporting a Report
A saved report can then be exported.
Depending on the report type, different export formats may be available, for example:
- Excel
- BCF
- COBieLite XML
The available export formats depend on the selected report type.
Notes on Using Filters
The content of a report is directly dependent on the selected filter profile.
If data is missing from the report or too much content is being exported, check:
- which filter profile has been configured
- whether a suitable filter has been saved in the overall model
- whether certain elements or disciplines have been excluded
Filters are particularly important when reports need to be created for specific subsets of the model.
Notes on Report Templates
The report template determines the layout and structure of the export.
Depending on the report type, templates can range from very simple to technically advanced.
Technical details regarding:
- JXLS syntax
- variables
- attribute mapping
- specific big attributes
can be found in the article “Report Templates”.
Typical Use Cases
Reports are frequently used for:
- Exporting building component lists
- Creating room books
- Checking attributes
- Exporting issues for coordination meetings
- Providing data for PowerBI
- Documenting model versions
Frequently Asked Questions (FAQ)
Why is data missing from the report?
This is usually caused by the selected filter profile or the element selection.
Why can't I export a report?
Check whether the report has been saved correctly and whether all required inputs have been completed.
Do I always have to upload a template?
No. This depends on the selected report type. However, for many report types, a template is useful or required.
Who can see the report?
Only shared reports are visible to other users.
Can a report be used in PowerBI?
Yes. Shared reports can be accessed by PowerBI.