Altium Designer Documentation

Share

Created: September 3, 2021 | Updated: October 21, 2021

The Share Project and Snapshot on the Web tabs of the Share dialogThe 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 members of your Workspace and 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 on sharing a design from within Altium Designer, see the Sharing a Design in Altium Designer page.

Access

The Share dialog is accessed in the following ways:

  • By clicking the button at the top-right of the main application window when the project that you wish to share is the active project entry in the Projects panel.
  • By selecting the Project » Share command from the main menus when the project that you wish to share is the active project entry in the Projects panel.
  • By right-clicking on the entry for the project that you wish to share in the Projects panel and then choosing the Share command from the context menu.
  • When commenting a design document, by posting a comment with a mentioned user that does not have access to the current project.

Options/Controls

Choose a collapsible section below to access information about the multiple iterations of the Share dialog.

The Share Project tab of the Share dialog when connected to a WorkspaceThe Share Project tab of the Share dialog when connected to a Workspace

Summary

With a design project registered with (made available to) a connected Workspace, you have the ability to share that live (WIP) design with other people using the Share Project tab of the Share dialog. This can be to members of your Workspace or, for an Altium 365 Workspace, to people outside of the Workspace.

Access

This iteration of the Share dialog is accessed by selecting the Share Project tab on the left-hand side of the dialog when you 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 (such as administrators, Workspace members, or individuals) and whether they have editing rights (Can Edit) or can view and comment on the project only (Can View). The Can Edit / Can View drop-down also allows you to remove shared access from individuals, or everyone in the Workspace if desired.

    If you attempt to share a project with user(s) outside of the Altium 365 Workspace, the confirmation dialog will open that warns you that these users will have access to project source documents and placed comments. Click OK to proceed with sharing.
    When connected to a Concord Pro Workspace, a live design cannot be shared with those that are not registered users of that Workspace (non-Workspace members).
  • Advanced Settings (available to Workspace administrators and the project owner only when connected to an Altium 365 Workspace) – provides access to the Sharing Settings dialog for specifying the re-sharing and download rights for users that the design is to be shared with.
If you are sharing a project that is not under Workspace's VCS, 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.

When connected to a Concord Pro Workspace, a project to be shared with another Workspace user and that is not under Workspace's VCS is automatically added to the Workspace's VCS. The now managed project will be shared with the specified Workspace user with View or Edit rights, as was selected in the Share dialog.

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

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 stimulating 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 Designer 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 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 Designer'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 Designer (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.
  • Advanced Settings (available for projects that are not under version control of an on-site server) – provides access to the Sharing Settings dialog for specifying the re-sharing and download rights for users that the design snapshot is to be shared 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 the Project Packager tool of Altium Designer. Once the link is ready, click the button to copy it and share it 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.

    Note that design snapshots shared by a link may be indexed by search engines and available to its users.

The Share dialog when attempting to post a comment with a mentioned user who has no access to the project
The Share dialog when attempting to post a comment with a mentioned user who has no access to the project

Summary

If you are connected to the Workspace and are attempting to post a comment with a mentioned user who has no access to the project, the dialog opens to provide this user with access to this project.

Access

This iteration of the Share dialog is accessed when you are connected to the Workspace and are attempting to post a comment with a mentioned user who has no access to the project, the dialog opens to provide this user with access to this project.

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.
  • Advanced Settings (available to Workspace administrators and the project owner only when connected to an Altium 365 Workspace) – provides access to the Sharing Settings dialog for specifying the re-sharing and download rights for users that the design is to be shared with.

The Share dialog when not signed in to your Altium account and not connected to a Workspace
The Share dialog when not signed in to your Altium account and not connected to a Workspace

Summary

If not signed in to your Altium account and not connected to a Workspace, 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.

Access

This iteration of the Share dialog is accessed when not signed in to your Altium account and not connected to a Workspace.

Options/Controls

  • Sign in – click to open the Sign In dialog where you may sign in to your Altium account.
  • Register – click to be redirected to the Altium 365 registration page where you may register or sign in with your AltiumLive credentials.

The Share dialog when attempting to share an open project that is not registered with a Workspace and you don't have a Workspace available
The Share dialog when attempting to share an open project that is not registered with a Workspace and you don't have a Workspace available

Summary

If you are signed in to your Altium account and are attempting to share an open project that is not registered with a Workspace (i.e. it is a local project or a project under external version control), and you don't have a Workspace available to you, the dialog will present a control to create an Altium 365 Workspace for your company.

Only one Altium 365 Workspace can be created per organization.

Access

This iteration of the Share dialog is accessed when you are signed in to your Altium account, don't have a Workspace available to you, and are attempting to share an open project that is not registered with a Workspace.

Options/Controls

The Share dialog when you are connected to a different Workspace
The Share dialog when you are connected to a different Workspace

Summary

If you are signed in to your Altium account and are attempting to share an open project that is registered with a different Workspace, you will be prompted to switch to the Workspace in which that project resides to share.

Access

This iteration of the Share dialog is accessed when you are signed in to your Altium account and are attempting to share an open project that is registered with a different Workspace.

Options/Controls

  • <Company Workspace> – click on the Workspace name button to be automatically connected to the Workspace in which the project you want to share is located.

The Share dialog when attempting to share an open project that is not registered with a Workspace and no Workspace is connected
The Share dialog when attempting to share an open project that is not registered with a Workspace and no Workspace is connected

Summary

If you are signed in to your Altium account and are attempting to share an open project that is not registered with a Workspace (i.e. it is a local project or a project under external version control), and you are not currently connected to a Workspace, the dialog will present a list of all Workspaces available to you, prompting you to select which Workspace to register the project with.

If you are already connected to a Workspace, then that will be used as the target in which to register the project. Note that the project will be made available in the target Workspace at the time the project is shared with nominated people.

Access

This iteration of the Share dialog is accessed when you are signed in to your Altium account, are attempting to share an open project that is not registered with a Workspace (i.e. it is a local project or a project under external version control), and are not currently connected to a Workspace.

Options/Controls

  • Choose the Workspace in which to make the project available – select one of the listed Workspaces in which to make the current project available.

The Share dialog when attempting to share an open project and you don't have permissions for doing this
The Share dialog when attempting to share an open project and you don't have permissions for doing this

Summary

If you are signed in to your Altium account, are attempting to share an open project, and don't have permissions for doing this, the dialog will show you the message stating this fact. This could happen if you don't have editing rights for this project or if a Workspace administrator or the project owner restricted the re-sharing ability for editors inside and/or outside the Workspace.

Access

This iteration of the Share dialog is accessed when you are signed in to your Altium account, are attempting to share an open project, and don't have permissions for doing this.

Found an issue with this document? Highlight the area, then use Ctrl+Enter to report it.

Contact Us

Contact our corporate or local offices directly.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
200 characters remaining
You are reporting an issue with the following selected text
and/or image within the active document: