Document Options (CmpLib)

Now reading version 17.1. For the latest, read: Document Options (CmpLib) for version 21

The Document Options dialog.
The Document Options dialog.


This dialog allows users to set Document Options for the active Component Library document.


From the Component Library Editor, right-click in the bottom table in the workspace and select Document Options from the context menu.


Document Options Tab

The Document Options tab of the Document Options dialog.
The Document Options tab of the Document Options dialog.

  • Target Vault - Select a Target Vault for the document. Choose the desired Vault from the drop-down menu, or click Vault Admin to add a new Vault.
    • Vault Admin - Click to open the Data Management -  Vaults page of the Preferences dialog.
  • Default Folder - Select a Default Folder for the document. Type the folder location into the text field, or click Choose to open the file browser.
    • Choose - Open the file browser and select a folder location.
    • Show in Explorer - Open the Vaults panel and select a target folder.
  • Lifecycle Definition - Select a Lifecycle Definition from he drop-down. The Altium Vault provides seven default lifecycle definitions, as well as the ability to define your own. You must choose a lifecycle definition when you create a new Item.
The lifecycle definition applied is chosen at the individual Item level, when creating an Item. Different Items can therefore have different lifecycle definitions employed for them.
Once a defined lifecycle definition is in use by an Item in the vault, that definition can no longer be edited (with the exception of the Definition Name, which can be renamed), nor can it be deleted. Conversely, once an Item is created and an initial release into a planned revision of that Item is made, that Item can not have its lifecycle definition changed.

The default lifecycle definitions are as follows:

  • Basic Lifecycle
  • Component Lifecycle
  • Extension Lifecycle
  • Simple Lifecycle
  • Simple Lifecycle With Approvals
  • Structured Lifecycle
  • Structured Lifecycle With Approvals
Lifecycle definitions featuring dedicated approval states and transitions effectively enable the appropriate authority to have the final say on whether or not an Item Revision can move from, for example, Design to Prototype, or from Prototype to Production.
These default definitions can be used 'as is', or modified to suit company (or personal) requirements. New, custom definitions can also be added and configured, as required.
  • Revision Naming - This field determines the scheme employed when assigning Revision IDs. Use the drop-down to choose from the schemes currently defined for the vault. Schemes themselves are defined in the Edit Revision Naming Schemes dialog. The chosen Revision Naming Scheme can not be changed after the Item is released.
  • Component Naming - If required, enter a component naming scheme. Otherwise, the default CMP-{00000} is used.

Template Tab

The Template tab of the Document Options dialog.
The Template tab of the Document Options dialog.

  • Item Revision - Show the template Item revision, click Choose button to open currently connected vault, and search for target template item.
    • Choose - Open the Vaults panel and select the desired template item.
  • Vault - Show the vault in which the template Item locates, click Show in Explorer to select a target vault.
    • Show in Explorer - Open the Vaults panel and select a target vault.
  • Revision Details - Displays any supplied revision details.
  • Revision State - Displays the current revision state of the document. If the revision is not current, click Update To Latest.
    • Update To Latest - Click to update to the most current revision.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.

The features available depend on your Altium product access level. If you don’t see a discussed feature in your software, contact Altium Sales to find out more.