Item Properties

Created: July 28, 2015 | Updated: July 27, 2020 | Applies to versions: 15.1, 16.0 and 16.1

The three variations of the Item Properties dialog

Summary

The Item Properties dialog allows designers to create, edit or view properties of an Item within the Vault.

Find the desired dialog in the following list and click on the link to access the information about that variation of the Item Properties dialog.

For more detailed information see Creating and Editing Items Directly Through an Altium Vault.

Create Item

The Create Item variation of the Item Properties dialog

Access

The dialog is accessed from the Vaults panel by clicking Add an Item in the top right region then choosing Create Item or one of the available item types from the drop-down menu.

Options/Controls

Item ID – the unique ID for this Item. The ID itself is typically a code in accordance with established naming conventions. For example, D-810-XXXX may be used to reflect a fabricated Blank Board Item, while D-820-XXXX may reflect an Assembled Board Item. The Item ID cannot be changed after the Item is released.
Content Type – this field lists the item type. A different content type can be selected from the drop-down menu.
Item Sharing - click to open the Permissions For Folder or Item dialog in which you can specify permissions for this new item.
Revision Naming Scheme – this field determines the scheme employed when assigning Revision IDs. Use the drop-down to choose from the schemes currently defined for the vault. Schemes are defined in the Edit Revision Naming Schemes dialog, which can be accessed by clicking the button at the right of the field. As schemes are chosen at the Item-level, you are free to have different schemes applied to different Items. The chosen Revision Naming Scheme cannot be changed after the Item is released.
Revision ID – the revision of the Item in accordance with the chosen revision naming scheme. This field is read-only.
Lifecycle Definition – this field determines which Lifecycle definition is used to model the state transitions that an Item-Revision may undergo over time. Use the drop-down to choose from the definitions currently defined for the vault. The definitions are defined in the Edit Lifecycle Definitions dialog, which can be accessed by clicking the button at the right of the field. As Lifecycle definitions are chosen at the Item-level, you are free to have different definitions applied to different Items. The chosen Lifecycle definition cannot be changed after the Item is released.
Revision State – the state of the revision of this Item specified in the Revision ID field. This field is read-only and newly created Items will always be set to Planned.
Revision Sharing - use this link to open the Permissions For Folder or Item dialog in which you can specify permissions for this item.
Comment – use this field to enter any further comments regarding this Item.
Description – use this field to enter a meaningful description of what is represented by this Item.
Folder – the vault folder in which this item is stored. Click the button to open the Choose Folder dialog and select or create a different folder.
Ancestor Revision – the preceding revision from which this Item is created/branched. Click the button to navigate to and select an existing item revision. Click the Clear button to remove the current Ancestor Revision.
Open for editing after creation - enable to open the new item after clicking OK.

Edit Item

The Edit Item variation of the Item Properties dialog

Access

The dialog is accessed from the Vaults panel by right-clicking on an Item in the top-right region of the panel in the Planned State then selecting Properties from the context menu.

Options/Controls

Item ID – the unique ID for this Item. The ID itself is typically a code in accordance with established naming conventions. For example, D-810-XXXX may be used to reflect a fabricated Blank Board Item, while D-820-XXXX reflects an Assembled Board Item.
Content Type – lists the item type. Use the drop-down menu to select a different content type.
Item Sharing - click to open the Permissions For Folder or Item dialog in which you can specify permissions for this item.
Revision Naming Scheme – this field determines the scheme employed when assigning Revision IDs. Use the drop-down to choose from the schemes currently defined for the vault. Schemes are defined in the Edit Revision Naming Schemes dialog, which can be accessed by clicking the button at the right of the field. As schemes are chosen at the Item-level, you are free to have different schemes applied to different Items. The chosen Revision Naming Scheme cannot be changed after the Item is released.
Revision ID – the revision of the Item in accordance with the chosen revision naming scheme. Use the button accessed by hovering over the right of the field to access the Set initial values dialog from where you can manually set the ID for the initial revision of a newly-created Item in an Altium Vault.

Access to the Set initial values dialog is only possible provided you have enabled the Allow manual initial revision Id option, on the Data Management – Vaults page of the Preferences dialog.

Lifecycle Definition – this field determines which lifecycle definition is used to model the state transitions that an Item Revision may undergo over time. Use the drop-down to choose from the definitions currently defined for the vault. The definitions themselves are defined in the Edit Lifecycle Definitions dialog, which can be accessed by clicking the button at the right of the field. As lifecycle definitions are chosen at the Item-level, you are free to have different definitions applied to different Items. The chosen lifecycle definition cannot be changed after the Item is released.
Revision State – the state of the revision of this Item specified in the Revision ID field. This field is read-only.
Revision Sharing - use this link to open the Permissions For Folder or Item dialog in which you can specify permissions for this item.
Comment – use this field to enter any further comments regarding this Item.
Description – use this field to enter a meaningful description of what is represented by this Item.
Folder – the vault folder in which this item is stored. Click the button to open the Choose Folder dialog and select or create a different folder.
Ancestor Revision – the preceding revision from which this Item is created/branched. Click the button to navigate to and select an existing item revision. Click the Clear button to remove the current Ancestor Revision.

View Item Properties

Access

From the Vaults panel, right-click on a Released or New from Design item and select Properties from the context menu.

Options/Controls

Item ID – the unique ID for this Item. The ID itself is typically a code in accordance with established naming conventions. For example, D-810-XXXX may be used to reflect a fabricated Blank Board Item while D-820-XXXX reflects an Assembled Board Item. The Item ID cannot be changed after the Item is released.
Content Type – this is the type of Item (for example, an altium-schematic-sheet or an altium-component).
Item Sharing - click to open the Permissions For Folder or Item dialog in which you can specify permissions for this item.
Revision Naming Scheme – this field determines the scheme employed when assigning Revision IDs. Use the drop-down to choose from the schemes currently defined for the vault. Schemes are defined in the Edit Revision Naming Schemes dialog, which can be accessed by clicking the button at the right of the field. As schemes are chosen at the Item-level, you are free to have different schemes applied to different Items. The chosen Revision Naming Scheme cannot be changed.
Revision ID – the revision of the Item in accordance with the chosen revision naming scheme. This field is read-only.
Lifecycle Definition – this field determines which Lifecycle definition is used to model the state transitions that an Item-Revision may undergo over time. Use the drop-down to choose from the definitions currently defined for the vault. The definitions are defined in the Edit Lifecycle Definitions dialog, which can be accessed by clicking the button at the right of the field. As Lifecycle definitions are chosen at the Item-level, you are free to have different definitions applied to different Items. The chosen Lifecycle definition cannot be changed after the Item is released.
Revision State – the state of the revision of this Item specified in the Revision ID field. This field is read-only.
Revision Sharing - use this link to open the Permissions For Folder or Item dialog in which you can specify permissions for this item.
Comment – use this field to enter any further comments regarding this Item.
Description – use this field to enter a meaningful description of what is represented by this Item.
Folder – the vault folder in which this item is stored.
Ancestor Revision – the preceding revision from which this Item is created/branched.