Publishing & Loading
How to use Speckle for Revit
Step-by-step guide for using the Revit connector
Speckle currently supports versions: .
The connector works on only.
Setup
1
Install the connector
Install your connector
2
Open the Revit connector
- In Revit, select the Speckle tab in the ribbon.
- Select Speckle to open the Revit connector.
- Select Sign in if you haven’t linked your Speckle account.
Why is the Speckle plugin not showing up after I installed the connector?
Why is the Speckle plugin not showing up after I installed the connector?
- Make sure your version of is one of the supported versions.
- Uninstall and reinstall your connector.
.exe or right-clicking and then selecting Open to run the installer.
Installation issues can also be caused by conflicting plugins.If you’re still experiencing problems, please report it in our Community Forum and include the following information:- Your application version
- Your Speckle connector version
What should I do if the plugin UI is empty or unresponsive, or if my application crashes?
What should I do if the plugin UI is empty or unresponsive, or if my application crashes?
If your connector window is floating, try docking it to your application to fix blank UI issues.For major issues, you can sometimes find a
log file in your directory at AppData\Roaming\Speckle\Logs.
Please report your problem in our Community Forum and include the following information:- Your application version
- Your Speckle connector version
- A copy of the log
Why can't I add a new account?
Why can't I add a new account?
This can happen if our desktop service isn’t running. Desktop Service is used for authenticating new accounts. If it’s not running, search for Speckle Desktop Services in Windows search and run it.
How do I uninstall my connector?
How do I uninstall my connector?
All Speckle connectors are installed like any other program. You can uninstall them directly from your system’s
Applications. For a full uninstall, you should also remove Speckle Desktop Services as well as your Speckle connector.How do I update my connector to the latest version?
How do I update my connector to the latest version?
You can always download the latest version of the connector in the web app.
If a new version of the connector is available, you will also see a notification in your connector UI.
Publishing a Model
1
Select Publish
2
Choose a project
- Select an existing project
- or select New Project to create one
3
Choose a model
- Select an existing model
- or select New Model to create one
4
Select objects to publish
- In your application viewport, select the elements you want to publish.
- Select Publish.
- Your model is now published to Speckle and is available to the rest of your team.
What types of Revit elements can I publish to Speckle?
What types of Revit elements can I publish to Speckle?
All visible elements in the Model category (such as walls, floors, beams, and columns) can be published. In the Annotation category, only visible gridlines can be published. Each element contains the following information:
- category, family, and type
- level
- location curve (if any)
- Mesh (solid elements), Curve (model curves), or Pointcloud geometry
- custom properties
- render material
How do I publish models from Revit views?
How do I publish models from Revit views?
- Click the blue filter field at the top of Select objects dialog while publishing a new version.
- Select Views, and then select the view you would like to publish from.
How do I publish models by Revit category?
How do I publish models by Revit category?
- Click the blue filter field at the top of Select objects dialog while publishing a new version.
- Select Categories, and then click on any number of categories you would like to add to the filter.
How do I publish linked models?
How do I publish linked models?
Linked models are supported by default when publishing. If they are not included in your published version:
- Expand the Settings field at the bottom of the Select objects dialog while publishing a new version.
- Check that the Include linked models toggle is turned on.
How do I make sure my Revit model is aligned with my other Speckle models?
How do I make sure my Revit model is aligned with my other Speckle models?
If you are using reference points to coordinate your project, you can publish your Revit model according to a specific reference point:
- Expand the Settings field at the bottom of the Select objects dialog while publishing a new version.
- Set the Reference Point setting to your desired reference point. Your published model will now be oriented according to your specified reference point.
How do I see the custom properties on my published Revit elements, like parameters or material quantities?
How do I see the custom properties on my published Revit elements, like parameters or material quantities?
All custom properties can be found under the
properties field when you select and view a Revit object in your browser.
Custom properties vary depending on the type of Revit element, and can include:- element id, built-in category, and workset properties
- material quantities
- parameters
- structural material properties (such as density and compressive strength)
How do I publish my rebar as solid objects instead of curves?
How do I publish my rebar as solid objects instead of curves?
- Expand the Settings field at the bottom of the Select objects dialog while publishing a new version.
- Toggle the Send Rebars As Volumetric setting to true. Caution: publishing all rebars as their volumetric representations can significantly slow down publishing speed.
Why does my model have the wrong colors in the web browser viewer?
Why does my model have the wrong colors in the web browser viewer?
In the viewer, select the View Modes button in the side bar, and switch the view mode to Shaded. If you still don’t see your object colors, let us know in our Community Forum
Why are some objects that I published missing from my model?
Why are some objects that I published missing from my model?
After you publish a Speckle model, click on the Report button to see any errors that may have occurred.
Click on any item in the report to highlight that item in your application. Some objects may not be supported for publishing.
Loading a Model
1
Select Load
2
Choose a project
3
Choose a model
4
Choose a version to load
- Latest version is always first.
- To load a specific version, select it from the UI.
How are Speckle models loaded in Revit?
How are Speckle models loaded in Revit?
All objects in Speckle models are loaded as Direct Shapes (generic models) with a default category in Revit. If your model contains block instances, each instance will be loaded as its own generic model. Each object will be loaded with:
- render material (if any)
Mesh,Curve, orSolid(only from Rhino and Grasshopper) geometry.
Can I load custom properties in Revit, like parameters?
Can I load custom properties in Revit, like parameters?
Currently, you can not load any custom properties on your Speckle model objects into Revit.
How do I load a Speckle Model according to a specific reference point in Revit?
How do I load a Speckle Model according to a specific reference point in Revit?
If you are loading a Speckle Revit model that was published with a reference point, the model will be loaded according to the transformation of that reference point.
Any existing reference points in your Revit document will be ignored.
Models published from other applications cannot be loaded according to a reference point in your Revit document.
How do I change the material of a Speckle model object I loaded in Revit?
How do I change the material of a Speckle model object I loaded in Revit?
If your Speckle model was published from Rhino or Grasshopper, it will contain
solid geometry and you can edit the material of the created direct shape as
you’d like. For any other Speckle model, currently it is not possible to
change the applied material.
How do I change the category of a Speckle model object I loaded in Revit?
How do I change the category of a Speckle model object I loaded in Revit?
Currently, you can not change the category of a loaded object.
Why are some objects that I loaded missing from my model?
Why are some objects that I loaded missing from my model?
After you load a Speckle model, click on the Report button to see any errors that may have occurred.
Click on any item in the report to highlight that item in your application. Some objects may not be supported for loading in .
Why can't I select a project in the UI—it's disabled?
Why can't I select a project in the UI—it's disabled?
This happens when you don’t have permissions to load a project. Contact the project owner to change your role.
Can I load a model via URL?
Can I load a model via URL?
Yes. Next to the search box in the project selection dialog, there’s an Add model by URL option. Paste the model URL there.