This article lists all the template keys that can be used in an ITO report template created with Excel. The template keys are used to populate the report with specific information from Solibri, and they act as placeholders that Solibri will replace with actual data from your model. ITO Report templates can include multiple keywords in a single cell, along with other descriptive text.
The article covers the following topics:
Related articles:
The template keys can be divided into four different types:
-
General template keys provide general information about the report such as the title, user information, a company logo, etc. As this information pertains to a single entity, namely the report, these are the only keywords that can span multiple rows within the template.
It's important to understand that the other three types of keywords relate to multiple entities. Your model can contain multiple IFC files, multiple rulesets, and multiple components with takeoff information. Therefore, these types of keywords must be contained within a single row among themselves. When a report is being written, Solibri will iterate through those multiple entities creating rows one after another populating the keywords with information.
-
The Model template keys row should be below the rows of General keywords. Model keywords provide information about the IFC models that are open in Solibri.
-
Ruleset task template key lists the rulesets specified as Ruleset Tasks that should be checked and results resolved before running the takeoff.
-
Column Name template keys correspond to the Names of the columns from the Information Takeoff Definition. As they correspond to the column names, they can be anything; however, they must match exactly and reside on a single row, as Solibri will iterate through each row mapping the value in each cell of the corresponding column from the takeoff in Solibri to the report.
The following is a listing of keywords that can be used in ITO Report Templates along with their description and where these can be edited:
Table 5. General Template Keys
|
Template Key |
Description |
Where to Edit |
|---|---|---|
|
<PNG_IMAGE> |
Your company logo or an image inserted as a picture |
In the Excel template, insert the PNG image anywhere in the sheet, and it will appear in the cell that contains. |
|
<CURRENT_TIME> |
The current date/time on your computer when the report is generated |
- |
|
<REPORT_TITLE> |
The title of the report |
In the Information Takeoff view, click the Report button to open the Report Information Takeoff dialog and set the Report Title. |
|
<USER_NAME> |
Your user name as currently set in Solibri |
- |
|
<USER_ORGANIZATION> |
Your user organization as currently set in SMC |
In the File layout, click Settings > General and set your User > Organization. |
|
<FILE_NAME> |
The file name of the SMC file you currently have open |
In the File layout, click Save Model As… and set the File Name of the SMC file. |
|
<SOLIBRI_VERSION> |
The version of SMC you are using (e.g. 9.13.5 or 24.5.0) |
- |
|
<EMPTY> |
Use this tag to designate a cell as being empty. |
In the Microsoft Excel Worksheet template, insert this tag as a reference for where a cell should remain empty. |
Table 6. Model Template Keys
|
Template Key |
Description |
Where to Edit |
|---|---|---|
|
<MODEL_DISCIPLINE> |
The discipline (e.g. Architectural, Structural, Building Services, etc.) of a model as set in SMC |
Right-click the model in the Model Tree view and select Set Discipline. |
|
<MODEL_SHORT_NAME> |
The short name (e.g. A, B, C, ARCH, STRUCT, MEP, etc.) of a model as set in SMC |
Right-click the model in the Model Tree view and select Set Short Name. |
|
<MODEL_NAME> |
The filename of a model |
- |
|
<MODEL_TIME> |
The timestamp of a model |
- |
|
<MODEL_APPLICATION> |
The name of the building authoring tool (BAC) that created a model |
- |
|
<MODEL_TYPE> |
The IFC Schema (e.g. IFC2X3, IFC2X2_FINAL) of a model |
- |
Table 7. Ruleset Task Template Keys
|
Template Key |
Description |
Where to Edit |
|---|---|---|
|
<EXPECTED_RULE_SETS> |
Rulesets specified as Ruleset Tasks that should be checked and results resolved before running the takeoff. |
In the Information Takeoff View, click the Edit Information Takeoff Definition button and add/remove Ruleset Tasks. |