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/to the server.

This article contains information about the following topics:

The Documents API can be found in the integrations menu of the file tab in Solibri.

To get started with the documents API you first need to give Solibri access to your Catenda account.

To do so, click on Connect.

The list of servers you can connect to will now start loading in.

The first time you start up Solibri this list can take some time to load.

After the first load the list is stored and will be faster to open up.

In the resulting dropdown menu you can select Catenda or Bimsync to connect to the Catenda documents API.

Click on Open to import documents or models that you have access to in Catenda Hub.

After clicking on open, your default browser will open up.

For the Upload model button to become available you have to have connected your Catenda account and have at least one file in your Solibri session.

Click on Upload model to export your Solibri session a part of your Catenda project that you have access to.

If you have not yet saved your Solibri session, or made any changes since your last save, you will be asked to save an .smc file so it can be uploaded.

The .smc that has been saved can now be exported as a new revision to Catenda and later imported again to Solibri if you wish to continue your session with the latest revision.

After having saved your .smc file click on upload model again.

After clicking on Upload Model, your default browser will open up.

After clicking on open and signing in, if you just allowed access or have previously granted access, a page similar to the projects page of Catenda Hub will open up as a new page in your default browser. ​

The Solibri document integration projects page can look something like this:

See the documents you have access to with you catenda account on the documents page of the Solibri document integration.

Here you can configure which documents will be synchronised with Solibri.

Click on the name of the project if you wish to navigate to a different project.

Click on models in the left menu to import by model instead of by document.

For each document you will see:

Select a set of documents by checking the boxes or check the box on top to select all.

After selecting the information menu will appear on the top right.

If it is closed, click on the i icon to expand it.

When importing you can configure which documents will be imported to Solibri.

Click on download towards the bottom to import the latest shared revision of each selected document.

When exporting you can configure the .smc file that will be uploaded.

​
​Update document name

With this option on, the name of the selected document will be updated to the name you have given to your file.

This way you can make sure you can keep uploading revisions to a document while making sure it always has the same name as those revisions.
​

Automatically select similar documents

With this option on you will be able to upload your file to a document with a similar name, even if it is not exactly the same. Note that the uploaded revision will still have the filename that you have specified.

Filename

Here you will see the name of the file that will be uploaded to Catenda.

By default the name of the smc file you have saved on your system will be displayed.
The name can still be changed at this moment.

Configure the name of the file by clickin on the pencil to the right.

​Document

Here you will see the name of the document on Catenda that will receive the file.

By default it will have the same name as the filename.

If there is no document with that name in your current folder yet this field will be green, indicating that a new document will be created.

The name that your document will have can sitll be changed at this moment.

If there are other .smc documents in this folder you will be able to click on the document name to select any of the other documents that you would like your .smc file to be uploaded to as a revision.

If you have chosen a document or if there is a document in the current folder with the same name this field will be gray.
You will then see a message warning you that a document with this name already exists and that your smc file will be uploaded as a new revision to that document.
​

Status

If the status workflow has been enabled for your project you will see the status dropdown.

If you are creating a new document, or if your document does not have a status yet you will see no status.

If you are adding a revision to an exisiting document you will see the status of that document and will be able to change the document status upon upload.

If you wish to change the status of the document when your revision is uploaded you can select it from the list of available statuses in the project.

When the download has started successfully you will see the following message in the browser

If you go back to Solibri you will see that the documents have started processing.

Downloaded documents will be stored in a temporary folder while your Solibri session is active.

Remember to save your Solibri session or upload a new revision on Catenda if you wish to save any changes made in your file.

Uploaded document revisions will be stored on Catenda. The latest revision can later be opened in Solibri again.

See the models you have access to with you catenda account on the models page of the Solibri document integration.

Here you can configure which models will be synchronised with Solibri.

Click on the name of the project if you wish to navigate to a different project.

For each model you will see the:

Select a set of models by checking the boxes or check the box on top to select all.

After selecting the information menu will appear on the top right.

If it is closed, click on the i icon to expand it.

Here you can edit your selection of models to be imported to Solibri.

Click on download towards the bottom to import the latest shared revision of each selected model.

While your browser session is active you will see the following message in Solibri.

Press cancel if you wish to end the import process.

If you are not yet logged into Catenda, you will be asked to sign in.

After opening for the first time, after signing in or if you were already signed in, you will be asked for permission to access your Catenda account:

If you were already signed in, but not with the right account, you can click on your profile picture to sign out and sign into the right account.

When you are sure you are signed into the right account, click Allow access to continue.

If you wait to long to do this it will not work so be sure to have your password ready!

After successfully granting access to your account you will see the following message:

Documents that have been linked from Catenda in Solibri can look different from regular documents that have been opened from the local system.

This is what documents can look like when they have been linked with documents on Catenda:

The name of the model might take some time to update but will eventually change to reflect the amount of revisions in the document on Catenda.

If your organization has set a preference for the download name of your document you might find a different name here.

For example the document name without the revision option is possible to request. Note that this has to be requested by the organization for all downloaded files in their projects.

You can see the different download name options for orgainzations here.

The Version column will help you keep track of which revision is currently loaded.

If revision publishing has been activated on your Catenda project you might see major (1.0, 2.0, 3.0, etc...) and minor (1.1, 1.2, 2.1, etc...) revision numbers here.

After a model has been imported from Catenda Hub a chainlink icon will be displayed in the third column to show that it is linked.

If you hover over a document that has been linked from Catenda you will see

[Documents API] Catenda followed by the name of the document.

Right click a document to open the context menu.

Here the document update preferences can be configured.

​Update Models

This is what the update models dialogue can look like if you have selected multiple documents.

Folder - Click on the folder if you wish to choose a local file for this model instead.

Version - Here you will see the version number in Catenda along with a checkmark which shows if you are currently working with the latest revision or not.

Update - Check the update box for each model or for all models by checking the box at the top and click on update models to update them.

Settings - Click on settings to open the model update settings for your selected documents.

Relink Models - Relink models only works if you have selected local models in this dialogue and not with Catenda models.
​

Model update settings

Automatic - When a new revision is available in Catenda Hub the model will automatically update.
​

Prompt - A promt will be shown when a new revision is available on Catenda. Updating to the new revision will start at your convenience.

Relink Models - Relink models only works if you have selected local models in this dialogue and not with Catenda models.
​

Towards the bottom of the document context menu you will see hyperlinks.
​

For each of the selected document that has a link to Catenda, you will see "Catenda" when you open each of the hyperlinks menus..

This is what the expanded hyperlinks meny can look like:
​

New Hyperlink - Clicking on New Hyperlink opens the Add Hyperlink meny which can look something like this:

Show

Click "Catenda" to open that linked document on Catenda.

Edit

Click "Catenda" to edit the link for that selected document.

The Edit Hyperlink menu will now open up and can look something like this:

The address should look something like this:
​https://hub.catenda.com/project/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/revisions/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
​
The topic will be Catenda by default, but can be renamed to anything you want.
​

Catenda links are always Absolute meaning that they are not relative to where your .smc file is on your system.

Remove

Click "Catenda" to remove the link for that selected document.
​