Altium Designer Documentation

LinkToVault

Created: August 8, 2017 | Updated: August 8, 2017

Parent page: UnifiedComponent Commands

The following pre-packaged resource, derived from this base command, is available:


Applied Parameters: None

Summary

This command is used to access the Document Options dialog, which offers controls for linking the library to a specific target Altium Vault, and folder within that vault - in which the Component Items, generated from the source component definitions, will be created. This dialog also enables you to specify the lifecycle definition and revision naming schemes to be employed for those Items. You can also define a default Component Naming scheme for components released from the CmpLib file, ensuring a unique ID for each resulting Component Item in the vault.

Access

This command is accessed from the Component Library Editor by choosing the File » Link Library to Vault command, from the main menus.

The command is only available for a Component Library that has not been accessed through the vault's direct editing feature. That is, a CmpLib file accessed from outside of an Altium Vault, and not through use of the Edit command associated with a Component Item in the Vaults panel.

Use

After launching the command, the Document Options dialog will appear. Use this dialog to determine:

  • The target Altium Vault (from a list of those you are currently connected to).
  • A default folder within the target vault in which to store the released Component Items.
  • The Lifecycle Definition and Revision Naming schemes to be employed for the generated Component Items (from defined schemes currently available for the targeted vault).
  • A default scheme for component naming. The entry here will be used as the template for automatically naming a newly-added component definition (in its associated Name field). The software will automatically assign the next available unique ID, based on that scheme, having scanned the entire vault and identifiers of existing Itemsable for the targeted vault.

The dialog also provides the means to reference a defined Component Template Item - choose a template using the controls available on the dialog's Template tab. A Component Template provides predefined settings for use by component definitions defined within the Component Library.

After clicking OK, ensure that the file is saved - the link information is saved as part of the CmpLib file.

Tips

  1. If the Component Library references a Component Template, the various elements (not target vault) in the Document Options dialog will only be editable if the corresponding Allow Override option was enabled, in that template.
  2. A default Item naming scheme – CMP-{00000} – is provided, but you can of course create your own scheme, simply by typing it within the field, ensuring that the variable portion is enclosed in curly braces (e.g. CMP-001-{0000}). Alternatively, you can override the auto-assigned ID for a component, simply by entering the ID required directly in the Name field for a definition. You always have full control and final say over how the Items are identified!
  3. The vault used in which to release and store components can be the same, or different to that in which the released domain models – referenced by those components – are stored.

 

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: