Altium Designer Documentation

Managed PCB Footprint Models in an Altium Vault

Modified by Jason Howie on Apr 11, 2017

Parent page: Vault-based Domain Models

From a designer's perspective, a vault component (Component Item) gathers together all information needed to represent that component across all design domains, within a single entity. It could therefore be thought of as a container in this respect. A 'bucket' into which all domain models and parametric information is stored. In terms of its representation in the various domains, a vault component doesn't contain the domain models themselves, but rather links to these models. These links are specified as part of the source component definition - from which the released Component Item is generated. As such, before you can delve into the process of defining and releasing vault components, you must first ensure that all the domain models themselves have been created and released.

Altium Designer, in conjunction with Altium Vault, caters for the ability to create and manage Footprint Items in an Altium Vault. Such Items are created directly within the target vault. Once a Footprint Item has been created (and data released into a revision of it), and its lifecycle state set to a level that the organization views as ready for use at the design level, it can be reused in the creation of one or more vault components.

For more information about creating a component Footprint, see the Creating the PCB Footprint page.

PCB Domain Terminology

Before taking a look at the process of releasing a PCB 2D/3D component model, it is worth taking a moment to become familiar with the related terminology involved. In the past, items within a PCB Library have been generically referred to as Footprints, however this term is no longer strictly correct in the present-day context. Altium Designer includes capabilities that allow designers to model both the footprint (land pattern) of the component as well as its 3D physical shape.

The following terminology is used to distinguish elements within the PCB domain:

  • Model - a generic term that refers to any domain-specific representation of a component that is useful when analyzing or working with the component in a specific context.
  • Footprint - a model that refers to the two-dimensional pattern of copper, masks, and overlays that describe the area on the PCB (where the physical component will be mounted).
  • 3D Body - a model that refers to the three-dimensional representation of the physical component to be mounted on the PCB.
  • PCB Component - a complete PCB domain model of the component that includes its Footprint and 3D Body. This can also be more fully referred to as the PCB 2D/3D Component model.

Designers are encouraged to adopt a similar vocabulary to ensure minimal confusion between the different descriptive terms.

When a defined PCB 2D/3D component model is released to the vault, it is released into a revision of a Footprint Item. While this naming conjures the picture of 2D footprint only, remember that the Item Revision may well represent the full PCB Component, with 3D Body information defined. In addition, that 3D Body information may make reference to a 3D Model Item, also in the vault.

Folder Type

When creating the folder in which to store Footprint Items, you can specify the folder's type. This has no bearing on the content of the folder - releasing a PCB 2D/3D component model will always result in a corresponding Footprint Item. It simply provides a visual 'clue' as to what is stored in a folder and can be beneficial when browsing a vault for particular content. To nominate a folder's use as a container for Footprint Items, set its Folder Type as Footprints, when defining the folder properties in the Edit Folder dialog.


Specifying the folder type - its intended use - gives a visual indication of the content of that folder when browsing the vault!

Another important aspect of the parent folder is the Item Naming Scheme employed for it. This defines the format of the unique ID for each Item created in that particular folder. Several default example schemes are available, utilizing the short-form code for either the folder type (PCBCL - PCB Component Libraries) or the content type (PCC - PCB Component):

  • $CONTENT_TYPE_CODE-001-{0000} - for example, PCC-001-0001.
  • $CONTENT_TYPE_CODE-001-{A00} - for example, PCC-001-A01.
  • $FOLDER_TYPE_CODE-001-{0000} - for example, PCBCL-001-0001.
  • $FOLDER_TYPE_CODE-001-{A000} - for example, PCBCL-001-A001.

Using a default naming scheme, the software will automatically assign the next available unique ID, based on that scheme, having scanned the entire vault and identifiers of existing Items. This can be a great time-saver when manually creating Footprint Items prior to release.

A custom scheme can also be defined for a folder, simply by typing it within the field, ensuring that the variable portion is enclosed in curly braces (e.g. PCBMODEL-001-{0000}).


The Item Naming Scheme of the parent folder is applied to the Unique ID for each Item
created within that folder.

The Item Naming Scheme employed for the parent folder can be changed at any time. The modified scheme will then be applied to any subsequent newly-created Items within that folder.

Item Type

When creating a target Footprint Item in which to store your PCB 2D/3D component model, ensure that its Content Type is set to Footprint, in the Item Properties dialog. If you are creating the Item in a Footprints type folder, this Item type will be available from the right-click context menu when creating the Item.


Creating a Footprint Item within a Footprints folder - the correct Content Type is available on the context menu.

When defining a Footprint Item, be sure to specify the type of lifecycle management to be used for the Item, and the naming scheme employed for its revisions, respectively.

Control over which Item types can use a particular lifecycle definition or revision naming scheme, can be defined and enabled at a global level from within the Content Types dialog, when defining each schema. For a newly-installed vault, the default schemes assigned for use by a Footprint Item are: Component Lifecycle and 1-Level Revision Scheme, respectively.

Once a PCB 2D/3D component model has been released into the initial revision of a Footprint Item, these schemes cannot be changed for that particular Item.

Specify the required schemes in the Item Properties dialog, using the Lifecycle Definition and Revision Naming Scheme fields respectively.

If the option to control use of lifecycle definitions and revision naming schemes per content type is enabled for any definitions/schemes, and the Footprint Item type is not set to use a particular definition/scheme, then that definition/scheme will not be available in the applicable drop-down list.


Selecting the Lifecycle Definition and Revision Naming schemes for a manually created Item.

Observing standard revision naming schemes and lifecycle definitions, across the various types of design item in a vault ensures smooth, consistent management of those items.
It is a good idea to add a comment and description as part of the Item's definition. This information is used when searching the vault and enables quick identification of what a Footprint Item offers.

Releasing a PCB 2D/3D Component Model

So far, we've discussed the support for a Footprint Item in the vault, in terms of related folder and item types. Releasing an actual defined PCB 2D/3D component model into a revision of such an item can be performed in a single streamlined way.

A PCB 2D/3D component model can be edited and released into the initial revision of a newly-created Footprint Item, courtesy of the vault's support for direct editing. Direct editing frees you from the shackles of separate version-controlled source data. You can simply edit a supported Item type using a temporary editor loaded with the latest source direct from the vault itself. And once editing is complete, the entity is released (or re-released) into a subsequent planned revision of its parent Item, and the temporary editor closed. There are no files on your hard drive, no questioning whether you are working with the correct or latest source, and no having to maintain separate version control software. The Altium Vault handles it all, with the same great integrity you've come to expect, and in a manner that greatly expedites changes to your data.

When you create a Footprint Item, you have the option to edit and release a PCB 2D/3D component model into the initial revision of that item, after creation. To do so, simply enable the option Open for editing after creation, at the bottom of the Create Item dialog (which is enabled by default). The Item will be created and the temporary PCB Library Editor will open, presenting a .PcbLib document as the active document in the main design window. This document will be named according to the Item-Revision, in the format: <Item><Revision>.PcbLib (e.g. PCC-001-0003-1.PcbLib).


Example of editing the initial revision of a Footprint Item, directly from the vault - the temporary PCB Library Editor provides the document with which to define your PCB 2D/3D
component model.

Use the document to define the PCB 2D/3D component model as required. For more information on doing this, see Creating the PCB Footprint.

The PCB Lib Standard toolbar provides three relevant controls when direct editing:

  •  - Save Active Document. Use this button to save the changes made to the document. This is required before you can release the document back to the vault.
  •  - Release Document. Use this button to release the defined PCB 2D/3D component model to the vault, storing it within the initial (planned) revision of the target Footprint Item. The Create Revision dialog will appear, in which you can change Comment, Description, and add release notes as required. The document and editor will close after the release. The library document containing the source PCB 2D/3D component model, *.PcbLib, will be stored in the revision of the Item.
  •  - Cancel Editing. Use this button if you wish to cancel editing. The document and editor will close, and nothing will be released to the target Footprint Item.

The released data stored in the vault consists of the source PCB 2D/3D component model, saved in a PCB Library file named using the Footprint Item's Comment. In the Vaults panel, switch to the Preview aspect view to see the model graphics.


Browse the released revision of the Footprint Item, back in the Vaults panel. Switch to the Preview aspect view to see the model graphics.

Reusing a Managed Footprint Item

Related page: Managed Components in an Altium Vault , Controlling Access to Vault Content

Once a PCB 2D/3D component model has been released to an Altium Vault, and its lifecycle state set to a level that the organization views as ready for use at the design level, that model can be reused in the creation of one or more vault components . When directly editing a Component Item from a vault, a Footprint Item revision is added for use to the resulting Component Library's Model Links region. This region can be thought of in terms of a 'bucket' of domain models that can be accessed by any component definition in the Component Library document. Assignment is simply a case of specifying which links are required for each definition.


Example of referencing a revision of a Footprint Item as a model link in a Component Library, when direct editing the definition for a Component Item (vault component).

You can edit a Footprint Item revision directly from the Model Links region by right-clicking and choosing the Edit command from the context menu.

Re-Releasing a Footprint Item

At any stage, you can come back to any revision of a Footprint Item in the vault, and edit it directly. Simply right-click on the revision and choose the Edit command from the context menu. Once again, the temporary editor will open, with the library (containing the source PCB 2D/3D component model) contained in the revision, opened for editing. Make changes as required, then commit the release of the document into the next revision of the item.

Right-clicking on the top-level entry for an Item itself, will edit the latest revision of that Item.


Accessing the command to launch direct editing of an existing revision of a Footprint Item.

Updating Related Component Items

When you make a change to a vault-based domain model - be it a symbol, footprint model, or simulation model - the moment you release that change into a new revision of the model's Item, any Component Items that use that model will become effectively out of date, still using the previous revision. In most cases, you will no doubt want to re-release those components, with the respective model links updated to use the latest revisions available. To streamline this process, Altium Vault, in conjunction with Altium Designer, facilitates the ability to update related Component Items - at the point of re-releasing a model Item - after having made any modifications to that model through the direct editing feature.

The option to perform this update to the parent Component Items, can be found in the Create Revision dialog, that appears when releasing the modified model back to the target Altium Vault. This option - Update items related to <ModelItemRevision> - is enabled by default.

<ModelItemRevision> is the current revision of the model Item, that is, the revision currently being used by any related Component Items. Once the model itself is released, this would naturally be the previous (earlier) revision, and no longer the latest.


Accessing the option to update related Component Items, that are referencing the Footprint Item
being re-released.

If you want to keep all related Component Items using the current revision of the Footprint Item, simply disable this option. Only the model itself will then be released.

Once you click OK in the Create Revision dialog, the modified model is released back to the vault, and its associated temporary editor closed. A Component Library document is then opened in its associated temporary editor (for direct editing), presenting the following:

  • Definitions for all components that are associated to (reference) the Footprint Item.
  • The Model Links region shows the latest (just released) revision for that Footprint Item.
  • The entry for the linked model - in the applicable Models field of each component definition - is set to use that latest revision of the just-released Footprint Item.
When multiple Component Items use the Footprint Item, rather than separate instances of Component Libraries being opened, a single CmpLib document presents a merged view of the world, with all parameters and model links - used by the source component definitions - presented.


Example of pushing a change made to a Footprint Item, through to a Component Item that references it.

Unless you need to make any further adjustments, simply click the  button (in the editor's standard toolbar), to release the modified definition(s) into new revision(s) of the corresponding Component Item(s), back in the target vault:

  • If only a single Component Item is affected, the Create Revision dialog will appear. Change Comment, Description, and add release notes as required. After clicking OK, the release will proceed, and the temporary Component Library editor then closed.
  • If multiple Component Items are affected, the Release Manager dialog will appear. This lists all component Items that are scheduled to be released - by default all enabled for inclusion in the release. Make any changes - to Comment, Description, and inclusion (Enabled option) - as required, then click the Release Items button. View the impending release changes in the subsequent Confirm Release dialog, then click OK. Once the release process completes - indicated by Release Successful in the applicable Action-Status field(s) - close the dialog. The temporary Component Library editor will also then be closed.

Downloading Released Data

Download the data stored in a revision of a Footprint Item by right-clicking on that revision and choosing the Operations » Download command from the context menu. The PCB Library file will be downloaded into a sub-folder under the chosen directory, named using the Item Revision name. The file can be found in the Released folder therein.

Access the Download command from the top-level entry for a Footprint Item itself, to download the PCB library file stored in the latest revision of that Item.
Click the Explore button in the Download from Vault dialog, to quickly explore to the download folder.

Migrating Existing PCB Libraries

Main page: Streamlined Migration of Existing Libraries to an Altium Vault

Altium Designer, in conjunction with Altium Vault (3.0 or later) provides a streamlined, simple process to quickly migrate your existing libraries to an Altium Vault. The GUI to this process - the Library Migrator view - presents an intuitive flow that takes initial selected libraries, and migrates them to a target Altium Vault. Catering for all types of libraries, relating to older component management methodologies - SCHLIB, PCBLIB, INTLIB, DBLIB, SVNDBLIB - the Library Migrator is the perfect solution to quickly building your company's set of vault components, and the many benefits that such components enjoy (high-integrity, lifecycle management, centralized storage and management, where-used functionality, ease of design resuse). And while the migration process can be configured - giving you enhanced control over how that migration is performed - at its most simplistic, you can simply accept the default settings and set the migration in motion within a matter of clicks.

All information that is present in an original source library is migrated, in order to arrive at a folder of unified components (vault components that have assigned part choices), with all referenced domain models (schematic symbols, PCB footprints, 3D Models, Simulation Models), and parametric information. Component templates can even be created, and used to create those vault components. And if your original components have multiple PCB footprints defined, you can rest assured that the Library Migrator will bring those models across, and keep the current default footprint too.

And if you only work with PCB libraries - your only concern is PCB layout - then the Library Migrator supports migration of just those libraries only.


Accessing the Library Migrator view - the user interface to the component migration process.

While migration may seem daunting, the defaults have been defined to enable you to get your collection of vault components without having to change a thing - start the process and design with the fruits of the Migrator's labor. The system conducts and handles a number of validations, for example to ensure no duplicate IDs for the resulting vault components, or to ensure no duplicate models or component templates are created, and that such entities are reused across (linked to) components where needed. And if issues do arise, the system flags them, with suggestions on how to resolve those issues, aiming to get the migration back on track as quickly, and as smoothly as possible.

Batch Releasing File-based PCB Libraries

If you have a set of file-based PCB libraries (*.PcbLib) that you need to release to a target Altium Vault quickly, and simultaneously, then you can use Altium Designer's Release Manager. Use it to batch-release PCB 2D/3D component models stored across multiple source documents, in a nominated source folder location.

The Release Manager is considered to be a legacy tool. It is highly recommended to use the Library Migrator when migrating your existing component libraries into an Altium Vault.

Accessed the Release Manager dialog by running the File » Release Manager command.


Release PCB 2D/3D component models, stored in one or more source documents, using the Release Manager.

Setting up for release couldn't be simpler:

  • Set the Document Type to PCBLIB.
  • Point to a top-level folder containing the PCB library files you want to release. Files can be stored in sub-folders within this folder.
  • Choose the target vault.
  • Choose to create a top-level folder in the vault based on the nominated top-level Windows folder, or choose an existing vault folder. You can optionally create sub-folders in the nominated vault folder, for each Windows sub-folder. Additionally, you can opt to create a vault folder for each source PCB library file.
  • Use the Default Options for New Released PCB Components region of the Release Manager to control how required new Items are created as part of the release process - in terms of Lifecycle Definition, Item Naming (default is PCC-{00000}) and Item Revision Naming schemes, and starting index.
  • Hit the Analyze Folders button.

Analysis of source folders and target vault folders (and Items) based on your chosen options will be performed and the source PCB library files detected will be listed. For each entry, the target Item will be displayed, its current and/or next revision (as applicable) and the action that will be performed by the release process.

Enable the PCB 2D/3D component models that you want to release and then click the Prepare Items and Documents button to effectively commit the link information to the source PCB library files involved in the release. Once saved, proceed with the release by clicking the Release Items button.

 

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.

ALTIUM DESIGNER FREE TRIAL
Altium Designer Free Trial
Let’s get started. First off, are you or your organization already using Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

In that case, why do you need an evaluation license?

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

Got it. You actually don’t need an evaluation license for that.

Click the button below to download the latest Altium Designer installer.


Download Altium Designer Installer

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

Please fill out the form below to get a quote for a new seat of Altium Designer.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

If you are on Altium Subscription, you don’t need an evaluation license.

If you are not an active Altium Subscription member, please fill out the form below to get your free trial.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Why are you looking to evaluate Altium Designer?

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

You came to the right place! Please fill out the form below to get your free trial started.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Sounds exciting! Did you know we offer special discounted student licenses? For more information, click here.

In the meantime, feel free to request a free trial by filling out the form below.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.

That’s great! Making things is awesome. We have the perfect program for you.

Upverter is a free community-driven platform designed specifically to meet the needs of makers like you.

Click here to give it a try!

If would like to speak with a representative, please contact your local Altium office.
Copyright © Altium Limited

Got it. You can download a free Altium Designer Viewer license which is valid for a 6 months.

Please fill out the form below to request one.

By clicking “Get Your Free Trial”, you are agreeing to our Privacy Policy.
You may receive communications from Altium and can change your notification preferences at any time.