Altium Designer Documentation

Vault Library

Created: July 26, 2016 | Updated: June 19, 2017
Now reading version 17.0. For the latest, read: Vault Library for version 17.1
Applies to Altium Designer versions: 15.1, 16.0, 16.1 and 17.0

The Folder Settings tab of the Vault Library dialog.
The Folder Settings tab of the Vault Library dialog.


The Vault Library dialog is used to map nominated vault folders to the library name you want displayed in the Libraries panel.

For information about integrated libraries, see Working With Integrated Libraries.


To open the Vault Library dialog, follow these steps:

  1. Access the Available Libraries dialog (either by clicking the Libraries button at the top-left of the Libraries panel, or by running the Design » Add/Remove Library command).
  2. Ensure the Installed tab of the dialog is the active tab.
  3. Click the Install button and select Install from Vault


Folder Settings Tab

First, choose the source Altium Vault, from where to source the vault components. Click on the current vault name at the top-left of the dialog to access a drop-down listing of all connected vaults.

Define a name for the 'vault library' - this is a name that you are giving to a specific set of vault folders, so make it meaningful to you. Enter the name into the Library name field at the top of the dialog. This name only exists in the Libraries panel, you are not modifying the vault contents in any way.

Define the path to each vault folder you want included in this 'library' - click the Add button to browse the folders of the nominated source vault, and add the folder you want included in your 'library'. Multiple folders can be added, and if you select a parent folder, the components in all child sub-folders will be included too.

Parameter Settings Tab

The Parameter Settings tab of the Vault Library dialog.The Parameter Settings tab of the Vault Library dialog.

The parameters, taken from all components in the folder, will appear listed in the region. Use the Visible On Add checkbox associated with each parameter to control its visibility, when a component that has that parameter is placed on a schematic sheet.

The Comment parameter is also shown. This is a system parameter.
Parametric data is stored as part of the vault folder properties, in the vault itself, and is global to all users of the vault, and with whom the relevant folder(s) have been shared. Folder hierarchy is also taken into account, so parameter visibility configured for a parent folder will be passed down to (inherited by) all child folders below.

Once you have defined a name and added the required folders, click OK to return to the Available Libraries dialog. The entry for the named 'library' will be added to the list of installed libraries. Note that the Path region of the dialog includes a line for each folder you included in your 'vault library.'

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: