Developer Platform

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:

Accessing remote files

This method enables Solibri Autorun to access files stored in:

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 Forma / 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="Models/Architecture.ifc"/>
</openmodel>

Trimble Connect (Since: 25.6.0)

<openmodel>
    <resource provider="TrimbleConnect" region="europe" project="My Project" path="Folder/MyModel.ifc"/>
</openmodel>

SAP (Since: 25.9.0)

<openmodel>
    <resource provider="SAP" server="SAP Configuration" project="My Project" path="Folder/MyModel.ifc"/>
</openmodel>

Here are the detailed descriptions of the tasks:

openmodel

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.

Example:

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

updatemodel

autoupdatemodels

<autoupdatemodels/>

updatepresentation

<updatepresentation/>

Important
If you need to retain issues that are resolved from the checking results in your presentations then do not run updatepresentation immediately after rechecking. When updating from a BCF file you can keep issues not present in the BCF by leaving removeAbsent unset or false.

Examples

Update all presentations from checking results (original behavior):

<updatepresentation/>

Update only presentations whose name starts with "Coordination" from checking results:

<updatepresentation name="Coordination*"/>

Update all presentations from a local BCF file, keep issues not in the BCF:

<updatepresentation file="C:\SolibriAutorun\bcf\CoordinationIssues.bcf"/>

Update matching presentations from a BCF file and remove issues not present in that BCF:

<updatepresentation file="C:\SolibriAutorun\bcf\CoordinationIssues.bcf" name="Coordination*" removeAbsent="true"/>

Using a remote BCF resource:

<updatepresentation name="Coordination*" removeAbsent="true">
    <resource provider="Autodesk" region="EMEA" server="My Account" project="My Project" path="Project Files/Example Project/CoordinationIssues.bcf"/>
</updatepresentation>

Wildcard examples for name: - Design Review (exact match) - Design* (matches Design, Design Review, Design v2, etc.) - *Coordination?? (matches names ending with Coordination plus two characters) - ?? Sync (matches any two characters followed by space Sync) - Regex example: rx:^Design Review (Phase|Stage) \\d{2}$

openclassification

classification-resource-path.png

closeclassification

Since 9.13.5

openruleset

ruleset-resource-path.png

openidsruleset

Since 9.13.8

closeruleset

Since 9.13.5

Examples: - <closeruleset name="My Ruleset"/> - <closeruleset name="* Ruleset"/> - <closeruleset name="Ruleset ??"/> - <closeruleset name="rx:^Ruleset (A|B)[0-9]{2}$"/>

updateruleparameters

Since 25.12.0

<updateruleparameters/>

check

<check/>

autocomment

<autocomment/>

An issue is created for every checking result, or for every result that matches an optional filter (since 26.6.0).

The issue status is automatically marked as 'Undefined'.

createpresentation

<createpresentation/>

bcfreport

bcf-report.jpg

resultsummaryreport

Since 9.13.5

result-summary-report.png

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

general-report.png

Example with local file:

coordinationreport

coordination-report.jpg

openito

closeito

Since 9.13.5

takeoff

itoreport

Plain Excel Report

Excel Template Report

Examples:

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

closemodel

exit

<exit/>

Pattern Matching (Wildcards and Regular Expressions)

Parameters that state they support wildcards (* and ?) also accept Java regular expressions when prefixed with rx:.