ITO Report Templates

In a previous article, Coordination Report Templates, we explored how to create your own custom coordination report templates.  Similar functionality exists for Information Takeoff (ITO) reports, allowing a user to create an Excel template to organize and format ITO information of a corresponding ITO Definition. Reporting, which was only briefly mentioned in the article Understanding Information Takeoff (ITO), is the focus of the article below.  You can follow along using the SMC Building.smc model that comes with Solibri Model Checker (SMC).

Upon opening the SMC Building.smc model and selecting the ITO layout, you’ll find a takeoff of the Building Element Quantities ITO definition in the Information Takeoff View.

Information Takeoff View
Information Takeoff View

Click the Report ITO Report button to open the Report Information Takeoff dialog.

Report Information Takeoff Dialog
Report Information Takeoff Dialog

This dialog provides the options of either exporting a Plain Excel Report or an Excel Template Report. With the Plain Excel Report option marked, click the Save Report button and save an XLSX file. Once saved, excel will automatically open the exported report as below:

Plain Excel ITO Report
Plain Excel ITO Report

The result is similarly formatted to what is viewed in the Information Takeoff view of SMC.

Close the Excel file, and click the Report ITO Report button again in the Information Takeoff view.

This time, mark the Excel Template Report. The Template drop-down menu is now enabled allowing you to browse to or edit an existing template or you can create an entirely new template by clicking the Create Default Button.

ITO Report templates already exist for the out-of-the-box ITO definitions that reside in the Information Takeoff folder of the program, which is why the Building Element Quantities.xls template was found and is already listed in the drop-down menu.  With this template selected, click the Save Report button and save an XLSX file.  Again, Excel will automatically open the exported report as below:

Excel Template ITO Report
Excel Template ITO Report

You can see the same information from the Information Takeoff Window is now reported with some additional information at the top of the report along with visually appealing formatting.

Close the Excel file, and click the Report ITO Report button again in the Information Takeoff view.

With the Building Element Quantities.xls template selected, click the Edit option.  Excel will open the XLS template for editing:

Building Element Quantities.xls ITO Excel Report Template
Building Element Quantities.xls ITO Excel Report Template

The screenshot above is the resulting template opened in Excel with an additional color coding of the different types of keywords. Similar to Coordination Report Templates, in order to populate the report with specific information from SMC, keywords (e.g. <FILE_NAME>) are used in a Microsoft Excel template file.  When you view one of these templates, you can easily see the keywords as they are capitalized and surrounded by “<” and “>” characters.    As with coordination templates, ITO Report templates can include multiple keywords in a single cell along with other descriptive text.

General keywords 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 is 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 amongst themselves. When a report is being written, SMC will iterate through those multiple entities creating rows one after another populating the keywords with information.

The Model keywords row should be below the rows of General keywords.  Model keywords provide information about the IFC models that are open in SMC.

Below the line of Model keywords is the <EXPECTED_RULE_SETS> keyword, which is populated by ruleset tasks.

Click the Classification_Settings Edit Information Takeoff Definition button in the Information Takeoff view.

Tasks within the Information Takeoff Definition Dialog
Tasks within the Information Takeoff Definition Dialog

You’ll find “Check and go through results of ‘BIM Validation.cset’” listed as a task for this ITO Definition.  This is a Ruleset task that was added to warn the user that this check should be run and any results reviewed before running the Takeoff to ensure the reported information is accurate.

If you do not complete this task when attempting to run the takeoff, a pop-up window appears:

BIM Validation.cset Ruleset Task in the Tasks Pop-up Window
BIM Validation.cset Ruleset Task in the Tasks Pop-up Window

The <EXPECTED_RULE_SETS> keyword will report all rulesets associated with a ruleset task that haven’t been loaded, checked, have unhandled results, or rejected issues.

The lowest row contains Column Name keywords that 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 SMC will iterate through each row mapping the value in each cell of the corresponding column from the takeoff in SMC 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:

GENERAL KEYWORDS
KEYWORD DESCRIPTION WHERE TO EDIT
<PNG_IMAGE> Your company logo or an image inserted as a picture In the Microsoft Excel Worksheet 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 SMC In the File layout, click Settings > General and set your User > Name.
<USER_POSITION> Your user position as currently set in SMC In the File layout, click Settings > General and set your User > Position.
<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.
<SMC_VERSION> The version of SMC you are using (e.g. 9.6)
<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.
MODEL KEYWORDS
KEYWORD 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
RULESET TASK KEYWORD
KEYWORD 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

Close the excel file, and click the Classification_Settings Report button again in the Information Takeoff view.

Click the Create Default button, and save to a new xls file.

Default Template for Building Element Quantities ITO Definition
Default Template for Building Element Quantities ITO Definition

SMC auto-generates an Excel template that includes the General, File, and Ruleset Task keywords formatted as above along with Column Name keywords based on every column name that exists in the Information Takeoff Definition.   If you wish to create an ITO Report Template for one of your own ITO definitions that doesn’t come out of the box, this is the recommended way.

Modify the template however you’d like and save it for your own use as a template.

In the example below, we’ve removed the right-most Color column, modified the column headers, and changed some coloring and fonts.  Notice that though we changed the column headers in the template, the keywords still must match the column names that exist in the ITO Definition.

Modified Building Element Quatities ITO Excel Report Template
Modified Building Element Quatities ITO Excel Report Template

When using this template the resulting report looks as below:

Modified Building Element Quantities Excel Template ITO Report
Modified Building Element Quantities Excel Template ITO Report

This modified template can be found here:

Building Element Quantities_version_2.xls

Advertisements
ITO Report Templates

2 thoughts on “ITO Report Templates

  1. eloyasmine says:

    Hello,
    I have been trying to include a picture of the model whith the sorted elementents with no success ? Is it possible to that without creating an issue and an issue details view within the information takeoff template ?
    Thank you for your reply.
    Best regards

    Like

    1. Hi Eloyasmine,

      If you want to include an image of the model in the ITO report, I would simply take a screenshot of the model, create a row that is as tall for the image to fit proceeding the ITO data below, and paste it there. You can easily copy a snapshot of the model by right-clicking in the 3D view and selecting Copy Snapshot.

      Below is a Selected Takeoff of just internal and external doors color coded by their type. If you turn on Foot Print Controls, it makes it easier to see where elements are in the model.
      ITO With Model Image

      Best regards
      John

      Like

Leave a Reply

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out / Change )

Twitter picture

You are commenting using your Twitter account. Log Out / Change )

Facebook photo

You are commenting using your Facebook account. Log Out / Change )

Google+ photo

You are commenting using your Google+ account. Log Out / Change )

Connecting to %s