DocumentOptions

Applied Parameters: None

Summary

This command is used to access the Document Options dialog, which offers controls for specifying the target vault, and Vault 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 can also define a default Component Naming scheme for components released from the CmpLib file, ensuring a unique ID for each resulting Component Item in the vault.

Access

This command can be accessed from the Component Library Editor by:

• Choosing the Edit » Document Options command from the main menus.
• Right-clicking over the definitions region and choosing the Document Options command from the context menu.

Use

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

• The target Altium Vault (from a list of those you are currently connected to). If editing an existing Component Item using file-less editing, this field will be read-only, and reflect the vault in which that Component Item resides.
• A default folder within the target vault in which to store the released Component Items.
• The Lifecycle Definition and Revision Naming schemes to be employed for the generated Component Items (from defined schemes currently available for the targeted vault).
• A default scheme for component naming. The entry here will be used as the template for automatically naming a newly-added component definition (in its associated Name field). The software will automatically assign the next available unique ID, based on that scheme, having scanned the entire vault and identifiers of existing Itemsable for the targeted vault.

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. 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 (not target vault) 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 of course create your own scheme, simply 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, simply by entering the ID required directly in the Name field for a definition. You always have full control and final say over how the Items are identified!
3. The vault used in which to release and store components can be the same, or different to that in which the released domain models – referenced by those components – are stored.