DocumentOptions

Applied Parameters: None

Summary

This command is used to access the Document Options dialog, which offers controls for specifying the target 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, when configured in either Single Component Editor, or Batch Editor mode, by choosing the Edit » Document Options command from the main menus.

Use

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

• A default folder within the target Vault 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 Vault.
• 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, having scanned the entire Vault and identifiers of existing Items 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 (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 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 Item ID field (Batch Editor mode) or Id field (Single Component Editor mode) for a definition. You always have full control and final say over how the Items are identified!
3. The Target Vault field is read-only. It reflects the Vault in which the existing component(s) being edited reside or, for a new component, the Vault to which you are currently signed-in.