A shared model is a Geometry model that you and your colleagues edit together. Each person keeps a copy of the model in their own workspace folder. When you save, Vulcan writes the model to your folder and sends a new version to the Vulcan server. Your colleagues then get that version. You can see who has the model open, where they work, and each recent version.
This guide uses these terms:
- Owner: The person who shared the model first.
- Recipient: A person that the owner shared the model with.
- Colleague: Another person who has access to the same model.
- Version: A save that reached the server.
- Unsent changes: Changes in your folder that did not reach the server.
Who can do what
Some actions need Vulcan Pro. This guide marks them Pro. Your own plan controls what you can do. The owner's plan has no effect on your access.
| Who | Can do | Cannot do |
|---|---|---|
| Owner with Pro Pro | Share a model with a person by email, or with everyone in your organisation. Remove people. Edit and save. Rename the model for everyone. Move the model to Trash and restore it. Restore older versions. | Share when sharing is off for your organisation. |
| Owner without Pro | Remove people from a model that you shared. Open the model, see colleagues and their changes, and read History. Use Save as… to make your own copy. | Share a model or add people. Save changes to the shared model. Rename the model, move it to Trash, or restore it from Trash. Restore older versions. |
| Recipient with Pro Pro | Open the model, edit it, and save. Choose Keep mine when you and a colleague save at the same time. Restore older versions. Use Save as… or Duplicate to make your own copy. | Add or remove people. Rename the model for everyone. A new name makes your own copy. Move the model to Trash. Delete removes only your copy. |
| Recipient without Pro (View only) | Open the model and see colleagues' changes when they save. See their cursors, follow them, and show in their People list. Read History. Use Save as… on the current version or an older version to make your own copy. | Save changes to the shared model. Restore older versions. Choose Keep mine. Add or remove people. |
- You can share a model with any email address. The person does not have to be in your organisation. They need a Vulcan account with that email address. The free plan is enough.
- Everyone means all members of your organisation, including new members. Members with Pro can edit. Other members get View only.
- Only the owner can add or remove people.
Before you start
To share a model, you need:
- Vulcan Pro Pro. See Plans and billing.
- An organisation with sharing on. If sharing is off, Vulcan shows Sharing is off for your organisation.
- A workspace folder. See Setting up Vulcan Software.
- A saved model with a name that is not
draft_model.
To open a model that a colleague shared with you, you need a Vulcan account and a workspace folder.
Vulcan saves models that you do not share to your folder only.
Share a model
You share a model Pro from the Files dropdown in the File Bar. Each model row has a Share button (a people icon) next to Duplicate and Delete. On a shared model, the icon has a tick and its tooltip shows Shared.
If the open model has unsaved edits or a new name, the Share button is disabled. Its tooltip shows Save first. Save the model, then share it.
Share with a colleague
- Open the Files dropdown.
- Click Share on the row of the model.
- Type the email address of the person. Vulcan suggests members of your organisation while you type.
- Click Share.
- Vulcan shows Share with email? They will see this model in Files. Click Share to confirm.
Vulcan sends the person an email about the share. If the person has a Vulcan account, the email has a link to Vulcan. The email tells them to open the model from Files, under Shared. If the person has no account, the email tells them to sign up free with that email address and choose a folder. Then they open the model from Files, under Shared.
Share with everyone in your organisation
- Click Everyone next to the email field.
- Confirm the share.
The dialog shows Everyone in organisation with Can edit. Hover over Can edit to see that only members with Pro can edit.
See who has access
The owner sees each person in the Share dialog, with their email address and status:
- Invited: The person has not opened the model.
- Can edit: The person opened the model and has Pro.
- View only: The person opened the model and does not have Pro.
- No account: The person no longer has a Vulcan account.
When no other person has access, the dialog shows Only you.
When a recipient clicks Share on a shared model, the dialog shows People with access. The list starts with the owner, marked Owner. Then it shows the names of other people who opened the model. Recipients do not see email addresses, statuses, or controls.
Remove someone
Only the owner can remove people. Click the cross next to a person, or next to Everyone in organisation.
When you remove a person:
- Vulcan removes the model from their folder and shows them No longer shared: model name. If the model is closed, this happens when they next open it.
- Vulcan keeps their unsent changes in their folder, as a separate model of their own.
- Their versions stay in History.
If you remove all people, the model stays shared with Only you. It keeps its History and continues to save to the server. You can share it again later.
Open a model shared with you
- Open the Files dropdown.
- Select Shared in the filter.
- Click the model.
A cloud icon marks a model that is not in your folder yet. Its tooltip shows Not in this folder. Vulcan downloads the model when you open it.. When you click the model, Vulcan downloads it into your folder and opens it.
The SAP files, overlay images, and PDF sources of the model download with it. Then the model works like all other models in your folder. Scenarios, Calculate, and SAP comparison use your local copy.
SAP files in your folder: A shared model keeps its SAP files in input/sap/<model id>/. Vulcan also shares SAP files in sub-folders of that folder. When the owner shares a model, or saves a model that they shared earlier, Vulcan copies its SAP files there. Vulcan does not delete the old folder. Vulcan sends colleagues only the files in that folder. For files outside it, the model shows Not shared: and the file names with not in this model's own SAP folder.
If you already have a different model with the same name, Vulcan opens the shared model as name 2, with the first free number. The same thing happens if the owner later gives the model a name that you already use.
Edit together
Saving
On a shared model, the Save button shows the save status:
- Saving…: Vulcan is sending your changes.
- Saved: Your colleagues have your latest version.
- Not saved: Your changes are in your folder, but they did not reach the server. Hover over the button to see the reason.
Vulcan sends your changes while you work, shortly after each edit. To save immediately, click the button or press Ctrl + S.
Vulcan always writes to your folder first. Not saved does not mean that you lost work. See Work offline.
Colleagues' changes
A colleague's version shows on your screen in a few seconds. Vulcan keeps your floor, zoom, panels, and selection when it applies the version.
Vulcan waits to apply a colleague's version while you type in a field, drag, draw, or have a dialog open. If you are on a different screen, for example Scenarios, a chip shows Updated by name · Open. Click the chip to go back to Geometry. Vulcan then applies the new version.
Undo goes back through your own edits since the last colleague's version arrived. To go back further, use History.
See where colleagues are
When colleagues have the same model open, you see:
- Cursors: Each colleague on your floor has a cursor in their own colour, with their name.
- Selections: Vulcan outlines the elements that a colleague selects in their colour, with their name. While they change an element, the label shows name · editing.
- Drags and drawing: While a colleague drags elements or draws, a dashed outline shows their work.
- Fields and menus: A ring in their colour marks the File Bar menu or field that they use.
People list and following
The Elements panel shows People below the Hide controls. When nobody else has the model open, the list does not show. A name can have one of these labels:
- away: No activity for one minute.
- hidden: Their Vulcan tab is in the background.
- offline: Your own connection is recovering.
- behind: They have an older version open.
- on screen: They are on a different screen, for example on Calculate.
- A floor name: They are on a different floor.
Click a person to follow them. Your view goes to their floor and moves with their view. Click the person again to stop. Following also stops when you pan, zoom, select a floor, or open a different model.
When two people save at once
If you and a colleague save at almost the same time, Vulcan keeps both versions. You select which version to keep. The File Bar shows this bar in place of the Save button, with the first part in an orange chip:
Updated by name · Keep mine · Open latest
- Keep mine Pro: Makes your version the newest. Vulcan asks Replace the latest version with yours? Theirs stays in History.
- Open latest: Replaces your copy with the newest version. If you have unsent changes, Vulcan asks you first.
Hover over the chip to see the number of the newer version. If Vulcan refused your last save, the tooltip also shows the reason.
With view-only access, the bar shows Open latest and your Save as… button.
Vulcan hides the History arrow while the bar shows.
History and restore
Click the arrow next to the Save button to open History.
Each row shows the person who saved, the time, the version number, and a short summary of the changes. Vulcan puts consecutive saves by one person within ten minutes into one row, for example name · times · 5 saves. Click a group to see each save in it. Click Show older to load older versions.
On each version other than the newest:
- Restore Pro: Makes that version the newest. The versions after it stay in History. If you have unsent changes, Vulcan asks you first.
- Save as…: Opens that version as a new model of your own, with a new name. Vulcan writes nothing until you click Save.
You can restore each save for 30 days. After 30 days, History keeps these versions:
- The first save and the last save of each group.
- Saves that you started with Save or
Ctrl + S. - Versions that someone restored or lodged.
If a colleague shared the model with you, your History starts when you got access.
Rename, copy, or delete
Rename
Only the owner can rename a shared model for everyone:
- Type a new name in the file name field. The Save button changes to Rename for everyone Pro. If the name collides with one of your other models, the button stays Save.
- Click Rename for everyone.
If a recipient types a new name and saves, Vulcan makes a separate model of their own with that name. The shared model does not change.
A name must not contain / \ : * ? " < > | or hidden characters. If you type one of these characters, a chip next to the name field shows it, for example Cannot use /. If you save with an empty name, the chip shows Enter a name. If one of your other models already has the name, the chip shows You already have a model with this name.
Make your own copy
Use Duplicate in the Files dropdown or Save as… to make a separate copy. A copy is a new model in your folder. Vulcan does not share the copy, and changes to the copy do not change the shared model. A copy gets its own SAP folder, input/sap/<copy name>, or input/sap/<copy name> n if that name is taken. It never uses the SAP folder of the original. A recipient's rename of a shared model works the same way.
Save as… gives the open model a new free name, which you can change. Click Save to write the copy as your own model.
Delete
The result of Delete on a shared model depends on your role:
- Owner Pro: Vulcan asks Move "name" to Trash? You can restore it from Trash in the Files menu. Vulcan removes the model from the Files list of all people.
- Anyone else: Vulcan asks Delete "name" from this folder? Vulcan deletes only your local copy. The model stays shared, and you can open it again from Shared.
To restore a model from Trash:
- Open the Files dropdown.
- Select Trash in the filter.
- Click Restore.
If the owner moves the model to Trash while you have it open, the Save button changes. You see Moved to Trash by name and Save as…. Vulcan stops sending your changes. The bar stays while you continue to edit, and your folder copy stays. To keep your work as your own model, click Save as…. You do not need Pro for this.
If the owner restores the model from Trash while you have unsent changes, you see the Updated by name bar. See When two people save at once.
When a model is no longer shared with you
If the owner removes you, Vulcan removes the model from your folder and shows No longer shared: model name. Click the chip to close it.
Vulcan keeps your unsent changes in your folder, as a copy with a new name. You can save and keep the copy.
Work offline
Vulcan writes to your folder on each save, so you can continue to work without a connection. The Save button shows Not saved, and its tooltip shows Offline. Vulcan kept your work in this folder. Vulcan sends your changes when the connection comes back.
While the live connection to colleagues recovers, the File Bar shows a Live paused chip. Colleagues' changes, cursors, and the People list come back when Vulcan reconnects.
If you close Vulcan with unsent changes, Vulcan warns you first. When you open the model again, Vulcan finds the unsent changes and shows Not saved with Not sent yet. Vulcan then sends the changes. To send them immediately, click Save.
View only and plans
Without Vulcan Pro, a shared model is view only for you. This also applies to the owner if their Pro ends.
- The row of the model in the Files dropdown shows a View only chip.
- Your edits stay on your screen and in your folder. Vulcan does not send them to colleagues.
- The Save button shows Save as…. Use it to keep your edits as a separate model of your own.
See Who can do what for all permissions.
If something looks wrong
| You see | What it means | What to do |
|---|---|---|
| Not saved, tooltip Offline | Vulcan has no connection to the server. Your work is in your folder. | Continue to work. Vulcan sends your changes when the connection comes back. |
| Not saved, tooltip Not sent yet | Changes from an earlier session did not reach the server. | Wait for Vulcan to send them, or click Save. |
| Not saved, tooltip Pro required | You need Vulcan Pro to save to a shared model. | Use Save as… to keep your work, or upgrade to Pro. |
| Not saved, tooltip Sharing is off for your organisation. | Your organisation turned sharing off. | Contact your organisation admin or Vulcan support. |
| Not saved, tooltip Not shared with you | You do not have access to the model now. | Ask the owner to share the model again, or use Save as…. |
| Not saved, tooltip Update Vulcan to edit this model | A colleague saved the model with a newer version of Vulcan. | Reload Vulcan. |
| You already have a model with this name next to the name field, or as the Not saved tooltip | One of your models already has this name. | Choose a different name. |
| Enter a name next to the name field | The name field is empty. | Type a name, then save. |
| Not saved, tooltip Model too large to share | The model is larger than the size limit for sharing. | Contact Vulcan support. |
| Not saved, tooltip Server unavailable (code) | Vulcan cannot connect to the server. Your work is in your folder. | Vulcan tries again. If the problem continues, contact Vulcan support. |
| Updated by name, chip tooltip includes Colleagues do not have your SAP or overlay file changes. | A colleague saved a new version. You changed SAP or overlay files that your colleagues do not have. | Click Keep mine to send your files. Click Open latest to use their files. |
| Updated by name with Keep mine and Open latest | A colleague saved at almost the same time as you. | See When two people save at once. |
| Updated by name · Open | A newer version waits while you are on a different screen. | Click the chip to go to Geometry. |
| Moved to Trash by name | The owner moved the model to Trash. | Use Save as… to keep your work. |
| No longer shared: name | The owner removed you from the model. | Click the chip to close it. Your unsent changes are in a copy in your folder. |
| Live paused | The live connection is recovering. The chip tooltip shows Vulcan paused colleagues' changes and presence until the connection recovers. | Wait. Vulcan continues to save to your folder. |
| Same model chip in Files | Two files in your folder are the same shared model. If you save both, they conflict. | Delete one file, or use Save as… on one file. |
| Vulcan could not load your shared models. This list shows only this folder. | Vulcan could not load your shared models. | Check your connection, then open Files again. |
| Save first on a disabled Share button | The open model has unsaved edits or a new name. | Save the model, then share it. |
| Rename the model. Its name has a character that shared models do not allow. | The name of an older model has a character that shared models do not allow. | Rename the model, then share it. |
| Too many shares in a short time. Try again later. | You added many people in a short time. | Wait, then try again. |
| Could not share. Try again. | Vulcan could not share the model. | Try again. |
| Could not remove. Try again. | Vulcan could not remove the person. | Try again. |
| Could not load the people with access. Try again. | Vulcan could not load the list in the Share dialog. | Try again. |
