Altium Designer Documentation

Accessing an Altium Vault from Altium Designer

Modified by Jason Howie on Jul 31, 2017

Parent page: Working with an Altium Vault

Once you have installed and licensed your Altium Vault, you can access it. This can be done from two places:

The Altium Vault is a separate product from Altium Designer, and is installed and licensed separately. For more information, see Installing the Altium Vault and Altium Vault Licensing, respectively.

This page takes a look at accessing your Altium Vault from within Altium Designer.

Signing-In to Your Altium Vault

To ensure the integrity of your valuable data - stored within your Altium Vault - is maintained, each user is required to sign into that vault with a username and password.

The Altium Vault relies on a number of Microsoft runtime components for successful operation and access, in some situations these may not be present on the target machine. If you receive an error message about a missing library (DLL) when you attempt to sign into an Altium Vault, it indicates that there are missing Microsoft runtime components. To-date, this is only known to occur on Windows Server 2008 R2 x64 Datacenter.

Use this link to download and install these missing components: http://www.microsoft.com/en-us/download/confirmation.aspx?id=29

Signing into an Altium Vault from within Altium Designer can be performed from a variety of places:

  • From the main DXP menu. Use the DXP » Sign in to Altium Vault command. The Connecting to Altium Vault dialog will appear, in which to enter the URL for the vault, and your vault access credentials. Once entered, click the Login button.
If you want to sign in using your Windows login credentials - taking advantage of the vault's support for Windows Authentication - enable the Use Windows Session credentials option.


Sign-in to your Altium Vault from the main DXP menu.

Once signed in, the command will change to Sign out from Altium Vault.
If you want to sign in using your Windows login credentials - taking advantage of the vault's support for Windows Authentication - enable the Use Windows Session credentials option.


Sign-in to your Altium Vault from the Data Management - Vaults page of the Preferences dialog.

Once signed in, the button will change to Sign out.
If you want to sign in using your Windows login credentials - taking advantage of the vault's support for Windows Authentication - enable the Use Windows Session credentials option.


Sign-in to your Altium Vault from the System - Altium Vault page of the Preferences dialog.

  • When creating a new Managed project. When you access the New Project dialog and set the Project Kind to Managed, the Connecting to Altium Vault dialog will appear, in which to enter the URL for the vault, and your vault access credentials. Once entered, click the Login button.
If you want to sign in using your Windows login credentials - taking advantage of the vault's support for Windows Authentication - enable the Use Windows Session credentials option.


You will need to sign-in to your Altium Vault before you can create a new Managed project.

Checking Sign-In Status

You can check whether you are currently signed in to your Altium Vault from the following places:

  • The main banner of the Altium Designer application window. When signed in, text will appear in the format <VaultUserName> is signed in <VaultName>.
  • The Data Management - Vaults page of the Preferences dialog. When signed in, the status entry for the relevant vault will show . In addition, the button will be Sign out (rather than Sign in).
  • The DXP menu. When signed in, the command will be Sign out from Altium Vault.
  • The Vaults panel. When signed in, the relevant vault will be available from the menu associated with clicking on the name of the vault currently being browsed.

Managing Your Vaults

Management of the connections to Altium Vaults is performed from the Data Management - Vaults page of the Preferences dialog. The main region lists all vaults that you currently have a connection to. Typically, you would access one Altium Vault for your organization, that is locally installed on a server within that organization. You can however connect to other vaults, for example if your organization does have multiple Altium Vaults, or if you still had some legacy vault technology (Personal Vault, Satellite Vault). This can be done by using the Add Vault (legacy) command, on the drop-down menu associated to the Sign in/Sign out button.

While it is possible to have a connection to multiple Altium Vaults, you can only be signed in to one such vault at any given time. This vault is distinguished in the list by appearing in BOLD, and appears at the top of the list.

In addition, you can connect to the Altium Content Vault - Altium's very own cloud-based vault, offering design collateral (including board templates, vendor-specific families of components, as well as generic components including capacitors and resistors).


The Data Management - Vaults page - command central for managing connections to Altium Vaults.

The Status column reflects whether the connection to a vault is active and 'live', disabled, or whether there is an issue with the connection.

Use the menu associated to the Properties button to access commands for various aspects of management for the currently selected vault in the list:

  • Edit Connection to Vault (not available for the vault to which you are actively signed-in).
  • Edit Vault Properties
  • Edit Revision Naming Schemes
  • Edit Lifecycle Definitions
  • Edit Operation Permissions.

To clear a vault from the list, select it and click the Disconnect From Vault button. Again, this cannot be used for the vault to which you are actively signed in - you would need to sign out first. Alternatively, to keep a connection, but simply not enable it for use, disable its associated Enabled option.

Automatic Sign-in

Altium Designer can be configured to sign you in to your Altium Vault on start-up. The option to control this - Sign me in when I start Altium Designer - is available on the System - Altium Vault page of the Preferences dialog. The Altium Vault used is taken from the Saved credentials region of the page.

When you sign-in to an Altium Vault, through the Connecting to Altium Vault dialog, you can enable the option Automatically sign in after start. This will enable the option in preferences, and store the current server address and access credentials to the Saved credentials region.

If you want to sign-in to your vault using Windows Authentication and your usual Windows login credentials, enable the option to Use Windows Session credentials.


Configure automatic sign-in, when Altium Designer starts, as part of your preferences.

Signing into an Altium Vault from Different Computers

Support is provided for signing into an Altium Vault, using the same credentials, but from different computers. If you attempt to sign in to a vault that you are already signed into from another computer - either through Altium Designer, or the vault's browser-based interface - a pop-up dialog will alert you to this. You can choose from two options offered in the dialog:

  • Terminate existing session - close the existing session that you have on the other computer, and continue to login to the vault from the current computer.
  • Start new session - login to the vault from the current computer by using an additional connection license, and thereby keep logged into the vault from the other computer as well.
You will only be able to login from the current computer as well, provided you have enough Vault Connector licenses remaining.

Signing-out from your Altium Vault

You can sign out from your Altium Vault by:

Your access to the vault will also be terminated when you exit Altium Designer. In addition, and for an Administrator of your Altium Vault, there is the provision to kill a session from the Users - Sessions page of the vault's browser interface. This can be used to terminate an existing session, and thereby free up a Vault Connector license.

Working in the Vault

Related page: Working with the Vaults Panel - Feature How-Tos

Once you are signed-in to your Altium Vault, you can access and create vault content. The primary interface to the vault from Altium Designer is the Vaults panel.

To display the Vaults panel:

  • Click the System button at the bottom-right of Altium Designer, and select Vaults from the menu that appears.
  • Select Vault Explorer from the DXP menu.
Click the the text at top-left of panel to display a management menu, where you can select the required vault from the currently connected vaults, refresh all vaults, or open the Preferences dialog at the Data Management - Vaults page.


When you are working in Altium Designer, you access vault content via the Vaults panel.

 

English
If you'd like to comment on the content on this page, use the Ctrl+Enter keyboard shortcut to send us your feedback. To include a section of the page in your comment (a typo, missing/wrong info, or incorrect imagery), highlight the text (max. 200 chars) and/or image first. Please restrict your feedback to documentation issues - for technical assistance refer to the Altium Forums.

Contact Us

Contact our corporate or local offices directly.

You are reporting an issue with the following selected text and/or image within the active document:
Request Free Trial

Complete this form to request a free 15 day trial of Altium Designer: