Solibri API - Getting Started with Solibri Superrun

Since: 26.9.0

Solibri Superrun is a feature in Solibri Premium for automating routine tasks, available in Solibri 26.9.0 and later. You compose a workflow—such as updating models, running checks, coloring and isolating components, taking snapshots, creating presentations, exporting issues as BCF files, running information takeoff (ITO), and creating ITO reports—as a sequence of actions, and Solibri executes them in order. For example, you can run daily model checking overnight and focus on issue handling and quality coordination during the day.

Workflows are saved as .superrun files. The files are plain JSON, so you can also edit them in a text editor or generate them from a script, but the Superrun view is the intended way to author them: it knows every action, its parameters, and their allowed values, and it can capture values such as filters, camera views, and section planes from the running application.

Superrun needs paths to the files it should open and where it should write reports. If your cloud service syncs a shared folder to disk, point Superrun at that folder. Files in a connected cloud service can also be referenced directly; see File and resource references.

Building a workflow in the Superrun view

1. Open the Superrun view. It has a list of actions on the left and, on the right, a Parameters tab, a Console tab, and an Inspector.

2. Click Add action to open the action picker. Filter by category, or type in the search field to find an action by name. Double-click an action, or press Enter, to add it to the workflow.

3. Select an action in the list and fill in its parameters on the Parameters tab. Depending on the parameter, you can:

• Browse for a file.
• Select a value that is currently available in the application, such as an open model, ruleset, presentation, Information Takeoff, or rule.
• Choose model categories.
• Pick a color.
• Build a component filter with From Filter Table or From Selection.
• Capture the current 3D state with Capture Current View or Capture Current Planes.
• Capture two selected components with From 2 Selected Components for a distance measurement.

1. Order the actions so that each one has what it needs. For example, open a model before checking it, and check before reporting. Drag actions to reorder them, and use Duplicate, Cut, Copy, Paste, and Delete as needed.

2. Use Enable and Disable—or Disable from here down, Isolate enabled, Enable all, and Disable all—to control which actions run without deleting them. Disabled actions stay in the file and are skipped at run time.

3. Click Validate to check the workflow without running it. Validation does not consume a seat from your quota. Errors, such as a missing required parameter or a missing input file, must be fixed before the workflow can run. Warnings, such as an action whose prerequisites may not be available, do not block the run. See Validation.

4. Click Save to write the workflow to a .superrun file, and Run to execute it. Run selected runs only the actions you have selected, which is useful while you are still building the workflow.

You can also drag .superrun files onto the action list to add their workflows, rename a workflow with Rename Superrun, and pin a workflow to the current project so that it is stored in the .smc file and reappears when the project is opened.

Once the workflow is saved, you can run it without opening the view at all—by double-clicking the file or by passing it to Solibri on the command line. See Launching Solibri Superrun.

Solibri Superrun examples

Seven use cases are explained below. Update the file paths to match your environment before running them.

Example 1

This workflow includes the actions to:

1. Open an SMC model.
2. Update all IFC, PDF, and DWG files in the model that are outdated.
3. Save the updated SMC model with the same name.
4. Exit Solibri.

{
  "version": 1,
  "name": "Update models",
  "actions": [
    {
      "type": "OPEN_MODEL",
      "params": { "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    {
      "type": "UPDATE_MODELS",
      "params": {}
    },
    {
      "type": "SAVE_MODEL",
      "params": { "output_path": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    { "type": "EXIT", "params": {} }
  ]
}

To update a single file with a specific new version instead, use UPDATE_MODEL:

{
  "type": "UPDATE_MODEL",
  "params": {
    "existing": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\ifc\\Solibri Building.ifc",
    "with": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\ifc\\Solibri Building - modified.ifc"
  }
}

Example 2

This workflow includes the actions to:

1. Open an IFC model with a discipline, a short name, and model categories.
2. Save it as an SMC model.
3. Exit Solibri.

{
  "version": 1,
  "name": "Import and categorize",
  "actions": [
    {
      "type": "OPEN_MODEL",
      "params": {
        "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\ifc\\Solibri building.ifc",
        "discipline": "Architectural",
        "short_name": "ARC",
        "categories": ["CATEGORY_NAME1", "CATEGORY_NAME2"]
      }
    },
    {
      "type": "SAVE_MODEL",
      "params": { "output_path": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    { "type": "EXIT", "params": {} }
  ]
}

Example 3

This workflow includes the actions to:

1. Open an IFC file.
2. Update all models that are outdated.
3. Open a classification.
4. Open a ruleset.
5. Check the model.
6. Add issue slides with a description and a snapshot zoomed to the relevant component.
7. Create a presentation from the checking results.
8. Export the issues as a BCF 3.0 file.
9. Save the model as an SMC file.
10. Exit Solibri.

{
  "version": 1,
  "name": "Check and report",
  "actions": [
    {
      "type": "OPEN_MODEL",
      "params": { "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\ifc\\Solibri building.ifc" }
    },
    { "type": "UPDATE_MODELS", "params": {} },
    {
      "type": "OPEN_CLASSIFICATION",
      "params": { "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Classifications\\Building Elements - General.classification" }
    },
    {
      "type": "OPEN_RULESET",
      "params": { "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Rulesets\\Architectural Rules\\BIM Validation - Architectural.cset" }
    },
    { "type": "CHECK", "params": { "scope": "all" } },
    { "type": "AUTO_COMMENT", "params": { "zoom": true } },
    {
      "type": "CREATE_PRESENTATION",
      "params": { "name": "Found issues", "from_checking_results": true }
    },
    {
      "type": "EXPORT_BCF",
      "params": {
        "output_path": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\reports\\Found issues.bcf",
        "version": "3.0",
        "scope": "all"
      }
    },
    {
      "type": "SAVE_MODEL",
      "params": { "output_path": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    { "type": "EXIT", "params": {} }
  ]
}

Example 4

This workflow includes the actions to:

1. Open an SMC model.
2. Update an IFC file included in the SMC model.
3. Check the updated model.
4. Add issue slides with a description and a snapshot zoomed to the relevant component.
5. Update a previously created presentation with the new checking results.
6. Write a coordination report from a template.
7. Save the SMC model.
8. Exit Solibri.

If you need to retain issues that have been resolved from the checking results, do not update presentations immediately after rechecking; update those presentations manually instead.

{
  "version": 1,
  "name": "Recheck and update presentation",
  "actions": [
    {
      "type": "OPEN_MODEL",
      "params": { "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    {
      "type": "UPDATE_MODEL",
      "params": {
        "existing": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\ifc\\Solibri Building.ifc",
        "with": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\ifc\\Solibri Building - modified.ifc"
      }
    },
    { "type": "CHECK", "params": { "scope": "all" } },
    { "type": "AUTO_COMMENT", "params": { "zoom": true } },
    { "type": "UPDATE_PRESENTATION", "params": { "name": "Coordination" } },
    {
      "type": "COORDINATION_REPORT",
      "params": {
        "output_path": "C:\\Superrun\\reports\\Solibri Building_CoordinationReport.xlsx",
        "template_file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Report Templates\\Coordination Report\\CoordinationReportTemplateDetailedReport.xlsx",
        "presentation_name": "Coordination"
      }
    },
    {
      "type": "SAVE_MODEL",
      "params": { "output_path": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    { "type": "EXIT", "params": {} }
  ]
}

Example 5

This workflow includes the actions to:

1. Open an SMC model.
2. Open an ITO file.
3. Run a specific ITO.
4. Create a plain ITO report.
5. Save the model as an SMC file.
6. Exit Solibri.

{
  "version": 1,
  "name": "Space takeoff",
  "actions": [
    {
      "type": "OPEN_MODEL",
      "params": { "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    {
      "type": "OPEN_ITO",
      "params": { "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Information Takeoff\\Spaces.ito" }
    },
    { "type": "CALCULATE_ITO", "params": { "name": "Spaces" } },
    {
      "type": "REPORT_ITO",
      "params": {
        "name": "Spaces",
        "output_path": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\Spaces.xlsx"
      }
    },
    {
      "type": "SAVE_MODEL",
      "params": { "output_path": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    { "type": "EXIT", "params": {} }
  ]
}

Example 6

This workflow includes the actions to:

1. Open an SMC model.
2. Open an ITO file.
3. Run all defined ITOs.
4. Create an ITO report using a template.
5. Save the model as an SMC file.
6. Exit Solibri.

{
  "version": 1,
  "name": "Takeoff report from template",
  "actions": [
    {
      "type": "OPEN_MODEL",
      "params": { "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    {
      "type": "OPEN_ITO",
      "params": { "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Information Takeoff\\Spaces.ito" }
    },
    { "type": "CALCULATE_ITO", "params": {} },
    {
      "type": "REPORT_ITO",
      "params": {
        "output_path": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\Spaces.xlsx",
        "template_file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Information Takeoff\\Templates\\Spaces.xlsx",
        "title": "Report"
      }
    },
    {
      "type": "SAVE_MODEL",
      "params": { "output_path": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    { "type": "EXIT", "params": {} }
  ]
}

Example 7

This workflow produces a set of visual documentation images, which is something Superrun can do and Autorun cannot. It includes the actions to:

1. Open an SMC model.
2. Reset colors and visibility so the run starts from a known state.
3. Isolate the components matching a filter.
4. Color them.
5. Set the camera to an orthogonal projection and move it to a known position.
6. Save a PNG snapshot.
7. Reset colors and visibility.
8. Exit Solibri.

The filter_json values below match every component. Build the filters you actually need in Solibri and capture them with From Filter Table or From Selection; see Component filters.

{
  "version": 1,
  "name": "Visual documentation",
  "actions": [
    {
      "type": "OPEN_MODEL",
      "params": { "file": "C:\\Users\\Public\\Solibri\\SOLIBRI\\Samples\\models\\Solibri model.smc" }
    },
    { "type": "RESET_COLORS_VISIBILITY", "params": {} },
    {
      "type": "ISOLATE",
      "params": { "filter_json": "[{ \"target\": \"ANY\", \"state\": \"INCLUDE\" }]" }
    },
    {
      "type": "COLOR_COMPONENTS",
      "params": {
        "filter_json": "[{ \"target\": \"ANY\", \"state\": \"INCLUDE\" }]",
        "color_hex": "#FF8800"
      }
    },
    { "type": "SET_CAMERA_PROJECTION", "params": { "mode": "orthogonal" } },
    {
      "type": "MOVE_CAMERA",
      "params": {
        "mode": "absolute",
        "location_x": 0.0,
        "location_y": -30000.0,
        "location_z": 15000.0,
        "direction_x": 0.0,
        "direction_y": 1.0,
        "direction_z": -0.4
      }
    },
    {
      "type": "TAKE_SNAPSHOT",
      "params": { "output_path": "C:\\Superrun\\snapshots\\overview.png" }
    },
    { "type": "RESET_COLORS_VISIBILITY", "params": {} },
    { "type": "EXIT", "params": {} }
  ]
}