Altium Designer Documentation


Created: March 20, 2019 | Updated: March 20, 2019
Now reading version 20.1. For the latest, read: DocumentOptions for version 21
Applies to Altium Designer versions: 19.0, 19.1, 20.0, 20.1 and 20.2

Parent page: UnifiedComponent Commands

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

Applied Parameters: None


This command is used to access the Document Options dialog, which offers controls for specifying the target server folder in which the component items generated from the source component definitions will be created and also the lifecycle definition and revision naming schemes to be employed for those Items. You also can define a default Component Naming scheme for components released from the CmpLib file, ensuring a unique ID for each resulting component item in the server.


This command can be accessed from the component library editor when configured in either Single Component Editor or the Batch Component Editor mode by choosing Edit » Document Options from the main menus.

When configured in Batch Editor mode, access can also be made by right-clicking over the lower grid region then choosing Document Options from the context menu.
Switch between modes for the Component Library Editor (Single Component Editor or Batch Component Editor) using the applicable command from the main Tools menu.


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

  • A default folder within the target server in which to store the released Component Items (only relevant when in Batch Editor mode).
  • The Lifecycle Definition and Revision Naming schemes to be employed for the generated Component Item(s) from defined schemes currently available for the targeted server.
  • A default scheme for component naming (only relevant when in Batch Editor mode). The entry here will be used as the template for automatically naming a newly-added component definition (in its associated Item ID field). The software will automatically assign the next available unique ID, based on that scheme after scanning the entire server and identifiers of existing Items for the targeted server.

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 (only relevant when in Batch Editor mode). A Component Template provides predefined settings for use by component definitions defined within the Component Library.


  1. If the Component Library references a Component Template, the various elements 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 create your own scheme 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 by entering the ID required directly in the Item ID field (Batch Editor mode) or Id field (Single Component Editor mode) in the component editor. You always have full control over how the Items are identified.
  3. The Target Vault field is read-only. It reflects the server in which the existing component(s) being edited reside or, for a new component, the server for which you are currently signed in.


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: