Altium NEXUS Documentation

DocumentOptions

Modified by Susan Riege on Mar 20, 2019

Parent page: UnifiedComponent Commands

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


Applied Parameters: None

Summary

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.

Access

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.

Use

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.

Tips

  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.

You are reporting an issue with the following selected text
and/or image within the active document:
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 © 2019 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 © 2019 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 © 2019 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 © 2019 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.

Great News!

Valid students can get their very own 6-month Altium Designer Student License for FREE! Just fill out the form below to request your Student License today.

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 © 2019 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.