Altium Designer Documentation

Document Options (CmpLib)

Created: April 3, 2020 | Updated: May 1, 2020
All Contents

The Document Options and Template tabs of the Document Options dialog
The Document Options and Template tabs of the Document Options dialog

Summary

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

Access

From the Batch Component Editor, right-click in the bottom table then select Document Options from the context menu.

Options/Controls

Document Options Tab

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

  • Target Server- provides the name of the server in which the active component document resides.
    • Server Admin - click to open the Data Management - Servers page of the Preferences dialog, where you may add or select a new server.
  • Default Folder - type the folder location into the text box or:
    • Choose - click to open the Choose Folder dialog, which is a trimmed-down version of the Explorer panel, where you may select from various server folders.
    • 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.

 

  • 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.
  • Item 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.
  • Update To Latest - click to ensure the current revision state of the document is the latest revision state.
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: