WorkspaceManager_Dlg-ShareProjectShare_AD

Created: March 24, 2020 | Updated: March 06, 2024 | Applies to versions: 3.1 and 3.2

Now reading version 3.2. For the latest, read: WorkspaceManager_Dlg-ShareProject((Share))_AD for version 5

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

The Share Project and Snapshot on the Web tabs of the Share dialog

Summary

The Share dialog supports the ability to share your design projects with others, anywhere around the world, directly from within the software. The Share dialog will present guidance in order to properly prepare you for sharing your chosen design project.

For more information about the Altium 365 platform, visit the Altium 365 Workspace page.

Access

The Share dialog is accessed by clicking the button at the top-right of the main application window.

The Share dialog is only available when connected to an Altium NEXUS Workspace, such as the Altium 365 platform. For more information regarding sharing a design, visit the Sharing a Design within Altium NEXUS page.

Options/Controls

In order to be able to begin sharing a design, you must be signed in to your Altium account (using your AltiumLive credentials), have an active (valid) Altium Subscription for your Altium NEXUS licensing, be connected to your Altium 365 Workspace, and the design project must be registered with (made available to) the Workspace.

Choose a drop-down below to access information about the multiple iterations of the Share dialog.

Ensure the project that you wish to share is the selected project entry within the Projects panel.

Share Project Tab

The Share Project tab of the Share dialog when signed in to your Altium account and connected to a Workspace

Summary

With a design project registered with (made available to) an Altium 365 Workspace, you have the ability to share that design with other people using the Share Project tab of the Share dialog. This can be to other members of your Workspace team (for viewing or editing), or to people outside of the team (for viewing and commenting through a Web browser only). In the case of the latter, they get to see the live (or WIP) design, synchronized to reflect each and every change that is committed by members of the Workspace team who have editing rights.

Only a Workspace team member who has editing rights to a project can share that live design with other people. Administrators can always share a project. When shared with a person outside of the Workspace team - for viewing and commenting of the design through the Altium 365 Platform Interface - that person is able to 'onward share' with others, from within that interface.

Access

This iteration of the Share dialog is accessed by clicking the button at the top-right of the main application, then selecting the Share Project tab on the left-hand side of the dialog when you are signed in to your Altium account and are connected to a Workspace.

Options/Controls

Share Project - set the sharing access permissions for the added people/roles from the associated drop-down menu by selecting Can View () or Can Edit (), where the latter option inherently includes viewing capability. The setting initially applies to all entries (people/roles) included in the field. Use the optional note field to include information that relates to the sharing arrangement for this project.
Shared with - click the drop-down to check who already has access to the project. The region will expand to show with whom the project is shared and whether they have editing rights (Can Edit) or can view and comment on the project only (Can View). The (Can View) drop-down also allows you to remove shared access from individuals, or everyone in the team, if desired.

At any time, an Administrator (or Workspace team member with editing rights) can modify the existing access permissions for a project. For more information on modifying access rights for existing people, visit the Sharing a Design from within Altium NEXUS dialog page.

If you attempt to share a project with a person outside of the team, the Sharing Outside of the Workspace dialog will appear. For more information on this dialog, visit the Sharing Outside of the Workspace dialog page.

If you are sharing an unmanaged project, the project will be made available in the currently connected Workspace at the time the project is shared with nominated people. When sharing for viewing only, the project is made available through Simple Sync. For more information on this functionality, see Making an Existing UnManaged Project Available Online.

Snapshot on the Web Tab

The Snapshot on the Web tab of the Share dialog when signed in to your Altium account and connected to a Workspace

Summary

The Snapshot on the Web tab allows you to capture a snapshot of the select project in its current state, which is made available for viewing and commenting, providing for wider collaboration with others through the Web. This can be useful for an on-the-fly design review, sharing a particular design milestone, or even to stimulate contextual discussion. The Snapshot on the Web tab is available on each iteration of the Share dialog, meaning any user who is currently viewing a project within Altium NEXUS can share a snapshot of that design - irrespective of whether or not they have shared access to that design themselves.

Access

This iteration of the Share dialog is accessed by clicking the button at the top-right of the main application, then selecting the Snapshot on the Web tab on the left-hand side of the dialog.

Options/Controls

Share with specific people - click the Share with specific people control to switch the sharing mode (for sharing a design snapshot) to allow you to share with one or more specific people. The invitation will be sent via email. Recipients will have access to view the design snapshot through the Web-based Altium 365 Platform Interface. Such a design snapshot is available permanently through the platform and commenting on the design is possible with this level of sharing. After entering the full email of a person with whom you want to share the snapshot and press Enter, click the button. The project itself is packaged into a Zip archive using Altium NEXUS's Project Packager, then uploaded to the Altium 365 platform. Confirmation of upload is provided once the process completes.

This level of sharing requires that you be signed in to your Altium account within Altium NEXUS (using your AltiumLive account credentials). If you are not currently signed in to your Altium account the dialog will present a link to do so (to access the Sign In dialog), or to register with AltiumLive, if you don't yet have credentials.

Share by email - once the Share with specific people option has been clicked, use this field to enter the email of individuals you would like to share this project with.
Generate link - click the button to generate the link to the design snapshot. In the background, the project itself is packaged into a Zip archive using Altium NEXUS's Project Packager. Once the link is ready, click the button to copy it and share with the required people as needed. On using the link, a recipient will be taken to an instance of Altium 365 Viewer, on the main altium.com site, with the design processed, loaded, and available for access for 48 hours.