Solibri API - Solibri Autorun Tasks

Solibri Autorun has a list of specific tasks which you can perform. These correspond to tasks you can do manually with Solibri Office. Most tasks have parameters you need to specify (for example, use the parameter file to specify the file path). Some parameters are optional, so you can leave them out if you don't need them.

The tasks you can perform with Solibri Autorun are:

Accessing Files with the Resource Element

(Since: 25.6.0)

Solibri Autorun provides an alternative method for specifying file paths using a child <resource> element instead of direct attributes like file or templatefile. This enhanced functionality allows for more detailed file location specifications, including access to remote files from various cloud providers.

When using the <resource> element, you can specify attributes such as:

  • provider: The service providing the file (e.g., "Autodesk", "OneDrive", "SharePoint", "Trimble Connect", "SAP").
  • region: The server region, if applicable (e.g., "US", "EMEA").
  • server: The server name or account identifier (e.g., "My Account").
  • project: The project identifier or name.
  • path: The path to the file within the provider's system or a local file path.
  • role: (For tasks requiring multiple files, like updatemodel or itoreport) A descriptor for the file's role (e.g., " existing", "update", "report", "template", "pdf", "rtf"). Accessing Remote Files:

This new method enables Solibri Autorun to access files stored in:

  • Autodesk Construction Cloud (ACC) / BIM 360
  • OneDrive
  • SharePoint
  • Trimble Connect
  • SAP

Important Note on Authentication: To access files from these remote providers, you must first log in to the respective service manually through the Solibri Office desktop application. If you use this feature frequently, Solibri will attempt to refresh the saved access token, potentially avoiding the need for repeated manual logins. However, initial setup and occasional re-authentication might be required.

Examples of <openmodel> with different providers:

Local File System or Mapped Network Drive:

<openmodel file="C:\Users\Models\ifc\MyModel.ifc"/>

Autodesk Construction Cloud / BIM 360 (Since: 25.6.0)

<openmodel>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Structural.ifc"/>
</openmodel>

(Note: server could be your ACC account name/hub, project is the project name, and path starts from the 'Project Files' root or equivalent)

OneDrive (Since: 25.6.0)

<openmodel>
    <resource provider="OneDrive" path="Documents/Models/MyBuilding.ifc"/>
</openmodel>

(Note: The path is relative to your OneDrive root.)

SharePoint (Since: 25.6.0)

<openmodel>
    <resource provider="SharePoint" site="My Project" drive="Documents" path="sites/ProjectSite/Models/Architecture.ifc"/>
</openmodel>

Trimble Connect (Since: 25.6.0)

<openmodel>
    <resource provider="Trimble Connect" region="Europe" project="My Project" path="Folder/MyModel.ifc"/>
</openmodel>

Here are the detailed descriptions of the tasks:

openmodel

  • Opens the specified model(s). You can open the following file types:
  • SMC: .smc
  • IFC: .ifc, .ifczip, .zip
  • PDF: .pdf
  • DWG: .dwg
Important
If you open an existing SMC model with Solibri Autorun, it may also include rules and rulesets, which are used in checking.
Important
If you have selected a role to be used in Solibri, the role and the resources related to it, such as classifications and rulesets, are automatically loaded when you start Solibri. Thus, if you check a model using Solibri Autorun, these rulesets are also used in checking, in addition to the ones you may have opened with Solibri Autorun.

  • Parameters:

  • file: Specify the path to the model file(s). You need to list each individual model file.

    Example with local file:

    <openmodel file="C:\Users\Models\ifc\MyModel.ifc"/>

    Example with remote resource: (Since: 25.6.0)

    <openmodel>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Structural.ifc"/>
</openmodel

  • Optional parameters:

  • discipline: Specify the model discipline.

    Example: <openmodel file="C:\Users\Models\ifc\MyElModel.ifc" discipline="Electrical"/>

    Possible disciplines in different languages are:

    EN DE FI JP
    Air Conditioning Klimaanlage Ilmastointi 空調
    Architectural Architektur Arkkitehti 意匠
    Building Services Gebäudetechnik Talotekniikka 設備
    Cooling Kühlung Jäähdytys 冷却
    Electrical Elektrik Sähkö 電気
    Facility Management Gebäudemanagement Toimitilajohtaminen 施設管理
    HVAC HKLSE LVI HVAC
    Heat Heizung Lämpö 暖房
    Inventory Inventar Lähtötieto インベントリ
    Landscape Landschaft Maasto 造園
    Plumbing Rohrleitungen Vesi 配管
    Prefab Concrete Betonfertigteile Betonielementit プレハブコンクリート
    Process Prozess Prosessi プロセス
    Site Operations Baustellenbetrieb Rakennusaikaiset 現場作業
    Special Piping Sonderrohrnetz Erikoisputkisto 特殊配管
    Sprinkler Sprinkler Sprinkleri スプリンクラー
    Steel Structure Stahlkonstruktion Teräsrakenne 鉄骨構造
    Structural Statik Rakenne 構造
    Ventilation Lüftung Ilmanvaihto 換気

  • shortname: Specify the model short name.

    Example: <openmodel file="C:\Users\Models\ifc\MyElModel.ifc" shortname ="ELE"/>

  • category: Specify the model categories. Models can be set to multiple categories. (Since: 9.12.8)

Example:

```
<openmodel file="C:\Users\Public\Solibri\SOLIBRI\Samples\ifc\Solibri building.ifc"> 
    <category>CATEGORY_NAME1</category>
    <category>CATEGORY_NAME2</category> 
</openmodel>
     
```

updatemodel

  • Updates a specific IFC, PDF or DWG file included in the SMC model with a new file.
  • PDF and DWG files Since: 24.0.1
  • Parameters:
  • file: Specify the file and the path to the file to be updated. The file must be included in the SMC model opened by the openmodel task.

  • Optional parameters:

  • with: Specify the path to the new version of the file.

  • autoupdate: When true, model is updated only when the IFC, DWG or PDF file is newer than the previously imported version. When false, the model is updated unconditionally. (Since: 9.12.8) Examples with local file:

    <updatemodel file="C:\Users\Public\Solibri\SOLIBRI\Samples\ifc\SMC Building.ifc" with="C:\Users\Public\Solibri\SOLIBRI\Samples\ifc\SMC Building - modified.ifc"/> <updatemodel file="C:\Users\Public\Solibri\SOLIBRI\Samples\ifc\SMC Building.ifc" autoupdate="true"/>

    <updatemodel file="C:\Users\Public\Solibri\SOLIBRI\Samples\ifc\SMC Building.ifc" with="C:\Users\Public\Solibri\SOLIBRI\Samples\ifc\SMC Building.ifc" autoupdate="true"/> <updatemodel file="C:\Users\Public\Solibri\SOLIBRI\Samples\ifc\SMC Building.ifc" />

    Example with remote resource: (Since: 25.6.0)

    <updatemodel>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Structural.ifc" role="existing"/>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Structural.ifc" role="update"/>
</updatemodel>

autoupdatemodels

  • Since: 9.12.8

<autoupdatemodels/>

  • Updates all imported models that have a newer version on the disk.

updatepresentation

<updatepresentation/>

  • Updates all presentations.
  • Typically used after a model has been updated and rechecked.
  • If there are new issues, they are added to the existing presentations.
  • If an issue has been removed from the checking results, it's also removed from the presentation.
Important
If you need to retain issues that are resolved from the checking results in your presentations then please do not use the updatepresentation command in your XML files, instead update these presentations manually.

openclassification

  • Opens the specified classification(s).

  • Parameters:

  • file: Specify the path to the classification file(s). The file type must be .classification.

    Example with local file:

    <openclassification file="C:\Users\Public\Solibri\SOLIBRI\Classifications\Space Usage.classification"/>

    Example with remote resource: (Since: 25.6.0)

    <openclassification>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Classifications/Space Usage.classification"/>
</openclassification>

  • To open a classification from an extension, use the following parameters:

classification-resource-path.png

  • provider: Specify the folder name.
  • resource: Specify the classification name.
  • Example: <openclassification provider="COBie-UK" resource="/Classification/COBie Facility - Name.classification"/>

closeclassification

Since 9.13.5

  • Closes the specified classification(s).

  • Parameters:

    • name: Specify name to match the classification(s) to be closed.

    Examples: - <closeclassification name="My Classification"/> - <closeclassification name="* Classification"/> - <closeclassification name="Classification ??"/>

openruleset

  • Opens the specified ruleset(s).

  • Parameters:

  • file: Specify the path to the ruleset file(s). The file type must be .cset. Example with local file: <openruleset file="C:\Users\Public\Solibri\SOLIBRI\Rulesets\Architectural Rules\BIM Validation 2004.cset"/>

    Example with remote resource: (Since: 25.6.0)

    <openruleset>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Rulesets/BIM Validation 2004.cset"/>
</openruleset>

  • To open a ruleset from an extension, use the following parameters:

ruleset-resource-path.png

  • provider: Specify the folder name.
  • resource: Specify the ruleset name.
  • Example: <openruleset provider="ADA and ABA" resource="/Ruleset/ADA and ABA Accessibility July 23 2004.cset"/>

openidsruleset

Since 9.13.8

  • Opens an IDS file as a ruleset.

  • Parameters:

    • file: Specify the path to the IDS file. The file type must be .ids.

    Example with local file: - <openidsruleset file="C:\Users\Public\Solibri\SOLIBRI\Rulesets\Architectural Rules\Example.ids"/>

    Example with remote resource: (Since: 25.6.0)

    <openidsruleset>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Rulesets/Example.ids"/>
</openidsruleset>

closeruleset

Since 9.13.5

  • Closes the ruleset(s) that match specified name.

  • Parameters:

    • name: Specify name to match the ruleset(s) to be closed.

Examples: - <closeruleset name="My Ruleset"/> - <closeruleset name="* Ruleset"/> - <closeruleset name="Ruleset ??"/>

check

<check/>

  • Checks the model(s) specified in openmodel using the ruleset(s) specified in openruleset or openidsruleset.

autocomment

<autocomment/>

  • Creates an issue slide and adds the default description to the Description field of each issue.

An issue is created for every checking result marked with the symbols:

, , or

The issue status is automatically marked as 'Undefined'.

  • Optional parameters:

  • zoom: The snapshots are zoomed in towards the components, when you insert the value TRUE.

    Example: <autocomment zoom="TRUE"/>

  • maxsnapshotsincategory: Adds snapshots to the category level if the category has more issues than the limit specified in the value. Insert a numerical value.

    Example: <autocomment zoom="TRUE" maxsnapshotsincategory="5"/>

createpresentation

<createpresentation/>

  • Creates a presentation from the issue slides added in autocomment.

bcfreport

  • Creates a BCF report from the Presentation view.

bcf-report.jpg

  • Parameters:

  • file: Specify the path and the name for the report. The file type must be .bcfzip for versions 1 & 2 and it must be .bcf for versions 2.1 and 3.0.

  • version: Specify the version of the BCF report. The version can be either 1 or 2, 2.1, 3.0.

    Examples with local file: <bcfreport file="C:\SolibriAutorun\reports\SolibriBuilding_BCFReport.bcfzip" version="2"/> <bcfreport file="C:\SolibriAutorun\reports\SolibriBuilding_BCFReport.bcf" version="2.1"/> <bcfreport file="C:\SolibriAutorun\reports\SolibriBuilding_BCFReport.bcf" version="3.0"/>

    Examples with remote resource: (Since: 25.6.0)

    <bcfreport version="3.0">
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/BCF3Report.bcf"/>
</bcfreport>

resultsummaryreport

Since 9.13.5

  • Creates a result summary report from the Result Summary view in Excel format.

result-summary-report.png

  • The file type can be .xls or .xlsx.

  • Parameters:

  • file: Specify the path and the file name for the report created by Solibri Autorun.

  • templatefile: Specify the path and the file name for the template to be used when creating the report.
  • title: Specify the title of the report (If not given the template filename is used.)

Example with local file:

<resultsummaryreport file="C:\SolibriAutorun\reports\Solibri Building_result_summary_report.xlsx" templatefile="C:\Users\Public\Solibri\SOLIBRI\Report Templates\Summary Report\CheckingSummaryTemplate.xlsx" title="Checking Summary"/>

Example with remote resource: (Since: 25.6.0)

<resultsummaryreport>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/ResultSummaryReport.xlsx" role="report"/>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/ResultSummaryTemplate.xlsx" role="template"/>
</resultsummaryreport>

generalreport

  • Creates a report from the Presentation view in a PDF and/or RTF format.

general-report.png

  • Parameters:

Example with local file:

  • pdffile: Specify the the file path and the name for the PDF report created by Solibri Autorun.

    Example: <generalreport pdffile="C:\SolibriAutorun\reports\SolibriBuilding_GeneralReport_PDF.pdf"/>

    • rtffile: Specify the the file path and the name for the RTF report created by Solibri Autorun.

    Example with local file: <generalreport rtffile="C:\SolibriAutorun\reports\SolibriBuilding_GeneralReport_RTF.rtf"/>

    Example with remote resource: (Since: 25.6.0)

    <generalreport>`
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/SolibriBuilding_GeneralReport_PDF.pdf"/>`
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/SolibriBuilding_GeneralReport_RTF.rtf"/>`
</generalreport>`

coordinationreport

  • Creates a coordination report from the Presentation view in Excel format.

coordination-report.jpg

  • The file type can be .xls or .xlsx.

  • Parameters:

  • file: Specify the path and the file name for the report created by Solibri Autorun.

  • templatefile: Specify the path and the file name for the template to be used when creating the report.

    Example with local file: <coordinationreport file="C:\SolibriAutorun\reports\Solibri Building_CoordinationReport.xlsx" templatefile="C:\Users\Public\Solibri\SOLIBRI\Report Templates\Coordination Report\CoordinationReportTemplateDetailedReport.xlsx"/>

    Example with remote resource: (Since: 25.6.0)

    <coordinationreport>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/CoordinationReport.xlsx" role="report"/>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/CoordinationReportTemplate.xlsx" role="template"/>
</coordinationreport>

openito

  • Since: 9.12.8
  • Opens the specified ITO file.

  • Parameters:

  • file: Specify the path to the ITO file. The file type must be .ito.

    Example with local file: <openito file="C:\Users\Public\Solibri\SOLIBRI\Information Takeoff\Spaces.ito" />

    Example with remote resource: (Since: 25.6.0)

    <openito>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Spaces.ito"/>
</openito>

closeito

Since 9.13.5

  • Closes the Information Takeoff(s) that match specified name.

  • Parameters:

    • name: Specify name to match the ito(s) to be closed.

    Examples: <closeito name="My ITO"/> <closeito name="* ITO"/> <closeito name="ITO ??"/>

takeoff

  • Since: 9.12.8
  • Calculates the ITOs with matching name if specified or calculates all ITOs if no name is specified.

  • Example: <takeoff />

  • Optional Parameter:

  • name: Specify the ITO name.

  • Example: <takeoff name="Spaces" />

itoreport

  • Since: 9.12.8
  • Creates a report of ITO results from Information takeoff view.

  • Report can be created using an excel template or it can be a plain excel report.

Plain Excel Report

  • If a specific ITO name is provided, then report is created for it. Else, it reports all ITOs.

  • Parameters:

  • file: Specify the path and the name for the report file. The file format must be .xls or .xlsx.

  • Optional Parameters:

  • name: Specify the ITO name.

    Examples with local file: <itoreport name="Spaces" file="C:\Users\Public\Solibri\SOLIBRI\Samples\Spaces.xlsx" /> <itoreport file="C:\Users\Public\Solibri\SOLIBRI\Samples\Spaces.xlsx" />

    Examples with remote resource: (Since: 25.6.0)

    <itoreport name="Spaces">
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Spaces.xlsx" role="report"/>
</itoreport>

Excel Template Report

  • The report is created using the excel template.

  • The report file and template file must have same excel format, either .xls or .xlsx.

  • If a specific ITO name is provided, then report is created for it. Else, it reports all ITOs.

  • Parameters:

  • file: Specify the path and the name for the report file.

  • templatefile: Specify the path and the file name for the template to be used when creating the report.

  • Optional Parameters:

  • name: Specify the ITO name.

  • reportTitle: Add a name for the report.

Examples:

  • <itoreport name="Spaces" file="C:\Users\Public\Solibri\SOLIBRI\Samples\Spaces.xlsx" reportTitle="Report" templatefile="C:\Users\Public\Solibri\SOLIBRI\Information Takeoff\Templates\Spaces.xlsx" />
  • <itoreport file="C:\Users\Public\Solibri\SOLIBRI\Samples\Spaces.xlsx" reportTitle="Report" templatefile="C:\Users\Public\Solibri\SOLIBRI\Information Takeoff\Templates\Building Element Quantities.xlsx" />
  • <itoreport file="C:\Users\Public\Solibri\SOLIBRI\Samples\Spaces.xlsx" templatefile="C:\Users\Public\Solibri\SOLIBRI\Information Takeoff\Templates\Building Element Quantities.xlsx" />

Examples with remote resource: (Since: 25.6.0) <itoreport name="Spaces"> <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Spaces.xlsx" role="report"/> <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/Templates/Spaces.xlsx" role="template"/> </itoreport>

savemodel

  • Saves the model as an SMC file.
  • Parameters:
  • file: Specify the the file path where you wish the file to be saved and the name of the file. The file type must be .smc. Example with local file: <savemodel file="C:\SMCAutorun\models\SolibriBuilding_saved.smc"/>

    Example with remote resource: (Since: 25.6.0)

    <savemodel>
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/SolibriBuilding_saved.smc"/>
</savemodel>

closemodel

  • Closes all models or a specified model which have been opened.

  • Optional Parameters:

  • Since: 9.13.8
  • file: Specify the path and the name for single model to close.

    Examples: - <closemodel/> - <closemodel file="C:\Users\Models\ifc\MyModel.ifc"/> - <closemodel file="*MyModel.ifc"/> * is a multiple character wildcard. - <closemodel file="*MyModel-??.ifc"/> ? is a single character wildcard.

exit

<exit/>

  • Closes Solibri and all models which have been opened.