Document Options (CmpLib)

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

The Document Options dialog
The Document Options dialog


The Document Options dialog provides controls to set document options for the active component document.


From the Batch Component Editor, right-click in the bottom table then 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 server for the document. Choose the desired server from the drop-down menu or click Vault Admin to add a new server.
  • Default Folder - type the folder location into the text box or:
    • Choose - click to open the file browser and select a folder location.
    • Show in Explorer - click to open the Explorer panel and select a target folder.
  • Lifecycle Definition - Select a lifecycle definition from the drop-down. The server provides several 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.
Once a defined lifecycle definition is in use by an item in the server, 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 cannot have its lifecycle definition changed.

The default lifecycle definitions are as follows:

  • Basic Lifecycle
  • Component Lifecycle
  • Data-Class Lifecycle
  • Device-Class Lifecycle
  • Extension Lifecycle
  • Simple Lifecycle
  • Simple Lifecycle With Approvals
  • Software Lifecycle
  • Structured Lifecycle
  • Structured Lifecycle With Approvals
Lifecycle definitions featuring dedicated approval states and transitions effectively enable the appropriate authority to have the final decision on whether or not an Item Revision can move, for example, from Design to Prototype or from Prototype to Production.
The 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 server. Schemes are defined in the Edit Revision Naming Schemes dialog. The chosen Revision Naming Scheme cannot be changed after the Item is released. You must choose a naming scheme when you create a new item.
  • Component Naming - if required, enter a component naming scheme. The default is CMP-{00000}.

Template Tab

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

  • Item Revision - displays the template item revision. Click Choose to open the currently connected server and search for target template item.
    • Choose - click to open the Choose Item dialog (a version of the Explorer panel) and select the desired template item.
  • Source- displays the source in which the template item is located.
    • Show in Explorer - click to open the Explorer panel and select a template.
  • 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.
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.