This article describes what the Documents API integration is and how you can sync project files (SMC) between Solibri and the CDE. The Documents API integration is available in Solibri v9.13.0 and newer. Please note that the integration is not available in Solibri Anywhere.
The Documents API integration offers an easy way to access your cloud-stored content. You can connect to a common data environment (CDE), and download and upload models from or to the server. As a result, you always have access to the latest available information. You can connect to the following CDEs via Documents API:
-
Aconex
-
Bimsync
-
Buildercom
-
buildagil
-
Catenda
You can open the following file types in Solibri using the Documents API integration:
-
IFC
-
IFCZIP
-
PDF
-
SMC
-
ZIP
The article covers the following topics:
Important
To connect to a CDE/server, you need to have an account for the CDE/server.
To connect to a CDE/server:
-
Open Solibri and select Integrations from the menu on the left. If you already have Solibri open, click File > Integrations:
-
You can see the Documents API section at the top. Click Connect:
-
A server chooser dialog opens. Select the server from the drop-down menu and click OK:
-
A browser window opens. Authenticate the access by filling in the information according to the CDE/server requirements. You can then close the window.
-
In Solibri, you should see to which CDE you're connected:
Tip
To end the connection, click Disconnect.
You can open one or multiple files from the CDE at once. Opening multiple files works for .ifc, .zip, .ifczip and .pdf files. You can't open multiple .smc files, but you can open, for example, an .smc and a .ifc file. You can open files either via the Open Model dialog or the Integrations page.
To open a model from a CDE via the Open Models dialog:
-
Click File > Open Model. A dialog opens. The name of the CDE tab depends on the CDE to which you're connected (for example, Bimsync).
Note
The CDE tab only appears after you connect to the Documents API server on the integrations page.
-
Click Add Files:
-
A browser window opens. Navigate to the file(s) and click a Download button.
-
The selected files are listed in the Open models dialog:
-
Click Open. The model opens in Solibri. For more information on the next steps, see Setting Model Short Name, Discipline and Category.
To open a model from a CDE on the Integrations page:
-
Click Open:
-
A browser window opens. Navigate to the file(s) and click a Download button.
-
The model opens in Solibri. For more information on the next steps, see Setting Model Short Name, Discipline and Category.
To upload models to your selected CDE via the Documents API integration:
-
Save the model locally.
-
Click Upload model:
-
A browser window opens. Navigate to the correct folder and click an Upload button.
Important
Note that each CDE server has slightly different configuration requirements, so you need to be aware that the CDE might ask you to provide some more information when uploading files.
-
Close the browser window.
Tip
If you haven't saved the model locally and try to upload, you get the following notification:
Click Save. Save the file and then click Upload model again.
You can update imported IFC models with new versions via the Documents API integration. You can select to update either a single IFC model or several IFC models at once.
Note that if you update models, you need to manually re-check the model to update the checking results. Issues that are not affected by the update keep their decisions, comments and snapshots. You can see the updated model in 3D when an issue is selected. You need to update the snapshots and other details in issue slides manually.
Important
You can only select and update .ifc files, not .smc files.
To update models via Documents API:
-
Right-click a model/models in the Model Tree view and select Update Models from the context menu:
Alternatively, click File, then Update Models. The dialog below will then list all the opened models and you can select which ones you wish to update.
-
The Update Models dialog opens:
Select one of the three updating options:
-
Update: Requires you to manually carry out this task when you want to update any models. If the filename has changed (revision letter, date etc.) then the new version of the file will need to be located using the Folder icon (
) at the end of the row. This will need to be done for each model.
-
Automatic: Updates are done automatically in the background when the software is started, and during a session if the time stamp is changed. Make sure that the new version of your file(s) is located in the same folder where the original model file is, and that it has the same name. The software will update your model automatically.
-
Prompt: You will get a prompt when the update is available, and the updating starts at your convenience. Make sure that the new version of your file(s) is located in the same folder where the original model file is, and that it has the same name.
-
-
A dialog opens. Select Use Documents API file:
-
A browser window opens. Navigate to the correct file and click Download X document(s).
-
Click OK.
Important
After any update or change to the Model Tree structure (IFC added or removed), Solibri will inform you that you have unsynchronised results. You will also notice that:
-
The rulesets are greyed out and reporting is disabled
-
Result Summary view is blank
-
The Results view shows the following message advising to run the check again: "Some models have been modified since the last check is done, please run check to see the results."
To proceed, you must click Check Model/Check Selected to run all the checks again.