Coordination Report Templates

Of the many features you’ll find in Solibri Model Checker (SMC), one of the most useful is its ability to communicate information about issues within a Building Information Model (BIM)  to a design team.  One method is through a Coordination Report, which uses a Microsoft Excel Worksheet as a template thereby allowing the user to either select from one of the out-of-the-box-templates or create their own custom template.  As a Coordination Report uses Microsoft Excel as the format, it in essence is a table of issues found in the model.  The information about the issues come from the slides you create for results of checks in SMC.

Example Coordination Report
Example Coordination Report

To create a Coordination Report, after you’ve created your presentation(s) of slides of issues, click the Report button in the Presentation view.  In the Create Report dialog seen below, you can select from one of the out-of-the-box-templates or create your own by clicking the Create Default… button.

Create Report Dialog
Create Report Dialog

There are three out-of-the-box templates found in the Report Templates/Coordination Report folder of SMC.  The difference between the three templates is the amount of information about the slides from the presentation that is included in the report.  The following lists what columns are included for each template:

  • CoordinationReportTemplateSimpleReport.xls:  Number, ID, Issue Title, Picture, Issue Description, Issue Comment
  • CoordinationReportTemplate.xls: Number, ID, Location, Date, Author, Title, Picture, Issue Description, Issue comment, Responsibilities, Action Required, Action Taken, Status
  • CoordinationReportTemplateDetailedReport.xls: Number, ID, Location, Date, Author, Issue Title, Picture, Issue Description, Issue Comment, Responsibilities, Action Required, Action Taken, Status, Hyperlink 1, Hyperlink 2, Components, Topic ID

If you would like to create your own, click the Create Default… button, and SMC will create a new template with the same information contained in the CoordinationReportTemplate.xls template and open this template in Microsoft Excel for editing.

In order to populate the report with specific information from SMC, keywords (e.g. <SLIDE_ID>) 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.    Coordination templates can include multiple keywords in a single cell.  Also, other descriptive text can be included in the cell along with keywords.

There are four types of template keywords: General, Model, Presentation, and Slide.  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, a report can contain multiple presentations, and a presentation contains multiple slides.  Therefore, these types of keywords must be contained on a single row amongst themselves. When a report it 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 this, the single row with Presentation keywords should be above the row containing Slide keywords.  When a report is written for multiple presentations, SMC will iterate through each presentation, first writing the row containing the presentation information, and then the rows for the slides contained in the presentation.  This is one of the reasons you shouldn’t place any keywords in rows between the row for presentation keywords and slide keywords when creating a template.  This is also a reason why a single row cannot contain keywords of different types.

Below is a screenshot of the “My Coordination Template.xmls” default template with the four keyword types highlighted in different colors:

General, Model, Presentation, and Slide Report Keywords Categories
General, Model, Presentation, and Slide Report Keywords Categories

The following table describes the General keywords:

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, which may contain multiple presentations In the Presentation view, click the Report button to open the Create Report 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.5)
<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.

The following screenshots show the locations in the SMC user interface that correspond to General keywords:

General Keywords from Create Report Dialog
General Keywords from Create Report Dialog
General Keywords from File - Settings - General
General Keywords from File – Settings – General

The following Model keywords relate to information about the models currently loaded in SMC:

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

The following screenshots show the locations in the SMC user interface that correspond to Model keywords:

Model Keywords from Info View - Idenfication
Model Keywords from Info View – Idenfication
Model Keywords from Info View - IFC File Name
Model Keywords from Info View – IFC File Name
Model Keywords from Info View - IFC File Schema
Model Keywords from Info View – IFC File Schema

The following Presentation keywords relate to information about the presentations reported:

PRESENTATION KEYWORDS
KEYWORD DESCRIPTION WHERE TO EDIT
<PRESENTATION_NAME> The name of a reported presentation Right-click the presentation in the Presentation view and select Rename…
<PRESENTATION_NUMBER> The number of a reported presentation The numbering is automatically generated by the ordering of presentations listed in the Presentation view.  To change the numbering you must remove the existing presentations and create them again in a new order.

The following screenshots show the location in the SMC user interface that correspond to Presentation keywords:

Presentation Keywords from Presentation View
Presentation Keywords from Presentation View

The following Slide keywords relate to information from slides in the reported presentations:

SLIDE KEYWORDS
KEYWORD DESCRIPTION WHERE TO EDIT
<SLIDE_TITLE> The title of the slide Right-click the result in the Results view and select Show Slide.

or

Right-click the slide in the Presentation view and select Edit Issue.

<SLIDE_DESCRIPTION> The description of the issue in the slide. Right-click the result in the Results view and select Show Slide.

or

Right-click the slide in the Presentation view and select Edit Issue.

<SLIDE_ID> The unique tracking ID of a slide in an SMC Model

NOTE: The unique ID of a slide is auto-incremented every time a new slide is created in an SMC Model.  There is no way to edit this number.

<SLIDE_NUMBER> The number of a slide based on the ordering of slides in a presentation Right-click the slide in the Presentation view and select Move Up or Move Down to reorder the slides.
<SLIDE_LOCATION> The location (e.g. floor, space name, space number, etc.) of an issue in a slide Right-click the result in the Results view and select Show Slide.

or

Right-click the slide in the Presentation view and select Edit Issue.

<SLIDE_TIME> The date/time when a slide was created Right-click the result in the Results view and select Show Slide.

or

Right-click the slide in the Presentation view and select Edit Issue.

In the Issue Details dialog, click the Update button after repositioning the camera in the 3D view.

<SLIDE_PICTURE> The 3D viewpoint of a slide as a picture
<SLIDE_COMMENT> The comments in a slide, which contain the author of the comment, the date the comment was created, and the comment itself Right-click the result in the Results view and select Show Slide.

or

Right-click the slide in the Presentation view and select Edit Issue.

<SLIDE_STATUS> The status (assigned, closed, open, resolved) of a slide Right-click the result in the Results view and select Show Slide.

or

Right-click the slide in the Presentation view and select Edit Issue.

In the Issue Details dialog, select the Coordination tab to set the Status.

<SLIDE_RESPONSIBILITIES> The names of the parties that are made responsible for the issue addressed in a slide Right-click the result in the Results view and select Show Slide.

or

Right-click the slide in the Presentation view and select Edit Issue.

In the Issue Details dialog, select the Coordination tab to add/remove Responsibilities.

<SLIDE_AUTHOR> The name of user that created a slide in SMC

Note: The slide author field is automatically populated with the Name or Initials of the user creating the slide in SMC.

< SLIDE_HYPERLINK_1>
< SLIDE_HYPERLINK_2>
< SLIDE_HYPERLINK_3>
< SLIDE_HYPERLINK_4>
< SLIDE_HYPERLINK_5>
The hyperlinks (up to 5) that are attached to a slide Right-click the result in the Results view for Hyperlink options (new, edit, remove).
 <SLIDE_TOPIC_ID> The GUID of a topic from a BCF Report.

NOTE: This field is only populated if the slide came from a presentation that was imported from a BCF report.

<SLIDE_COMPONENTS> The reported identities of components related to an issue. Right-click the result in the Results view and select Show Slide.

or

Right-click the slide in the Presentation view and select Edit Issue.

In the Issue Details dialog, select the Components tab to add/remove Components.

NOTE: To change the reported identities of the related components, click File > Settings > Presentation.  In the Components, tab add/remove properties to identify the component.

The following screenshots show the location in the SMC user interface that correspond to Slide keywords:

Slide Keywords from Issue Details - Slide
Slide Keywords from Issue Details – Slide
Slide Keywords from Issue Details - Coordination
Slide Keywords from Issue Details – Coordination
Slide Keywords from Issue Details - Components
Slide Keywords from Issue Details – Components
Slide Keywords from Presentation View
Slide Keywords from Presentation View
Advertisements
Coordination Report Templates

8 thoughts on “Coordination Report Templates

  1. Matt Jackson says:

    Do you have a similar list for ITO report templates? I want to customize a template to include for example Revit Category to help clarify the list. doesn’t seem to work.

    Like

  2. Hi Matt,

    By Revit Category, do you mean the Family Category of components (Wall, Door, Specialty Equipment, etc)? If that is the case, then a property must exist that is attached to the components to be reported by the ITO. I have found that when exporting to IFC from Revit 2016, Revit automatically creates a “Category” property under the property set “Other” even though it doesn’t list it under the “Other” property group when working in Revit itself. In Solibri, you can simply add a column to your ITO definition, specify “Other” as the Property Set Name, and specify “Category” as the property name.

    Unfortunately, it doesn’t appear that Revit 2014 automatically creates this Other.Category property. I am unsure of Revit 2015.

    – John

    Like

  3. Hi,
    Mmmmm… very interesting! I’m reviewing this article, and I have a question:
    In the report, Is it possible to add a column for “BCF Status”?
    Best regards,
    Xavi

    Like

    1. The “BCF Status” information is not available in the coordination report and cannot be used as a column. The I will log a feature enhancement request on your behave with our development to add this information as an available column.

      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