Altium Designer Documentation

Item Properties

Modified by Tiffany Cullen on Jul 27, 2020
This documentation page references Altium Vault, which is no longer a supported product. Altium Vault and its component management features have migrated to Altium Concord Pro.

The three variations of the Advanced versions of the Item Properties dialog

Summary

The Item Properties dialog allows you to create, edit or view properties of an item within a managed content server. 

For more information about creating and editing items in a server, click here.
Find the desired dialog in the following list then click on the link to access the information about that variation of the Item Properties dialog. 

On the left, an incarnation of the Create New Item variation of the Item Properties dialog if signed into an on-site server; on the right,an incarnation of the Create New Item variation of the Item Properties dialog if signed into an Altium Designer Workspace

Access

The Create New Item dialog is accessed from the Explorer panel by right-clicking on an item, choosing Create Item, then selecting one of the available item types (except Component) from the sub-menu. 

Options/Controls

  • Name - enter the name of the new Item.
  • Description - use this field to enter a meaningful description of what is represented by this Item.
  • 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.
  • Share Item - click to open the Share For dialog in which you can specify permissions for this new item.
  • Advanced - click to open the advanced version of the dialog to access additional options, such as Revision Naming Scheme and Lifecycle Definition.
    • Folder – the server folder in which this item is stored. Click  to open the Choose Folder dialog to select or create a different folder.
    • 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 server. Schemes are defined in the  Edit Revision Naming Schemes dialog, which is accessed by clicking  on the right side of the field. Since schemes are chosen at the Item-level, you can have different schemes applied to different Items. The chosen Revision Naming Scheme cannot be changed after the Item is released.
    • 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 server. The definitions are defined in the Edit Lifecycle Definitions dialog, which is accessed by clicking  on the right side of the field. Since lifecycle definitions are chosen at the Item-level, you can have different definitions applied to different Items. The chosen Lifecycle Definition cannot be changed after the Item is released. The field to the right displays 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.
    • Share Revision - click to open the Share For dialog in which you can specify permissions for this new item revision.
    • Ancestor Revision – the preceding revision from which this Item is created/branched. Click  to open a dialog to navigate to and select an existing revision. Click Clear to remove the current Ancestor Revision.
    • Revision ID – the revision of the Item in accordance with the chosen revision naming scheme. This field is read-only.
    • Open for editing after creation - enable to open the new item after clicking OK. Doing so allows you to take advantage of the option to edit and release the associated data entity into the initial revision of that item, after creation. Therefore, instead of creating the source data outside of the server and releasing it, you may start working on the source directly from the moment the empty Item is created, courtesy of direct editing. When that editing is complete, the entity is released into the initial planned revision of its parent Item, and the temporary editor closed.

 On the left, an incarnation of the Edit Item Properties variation of the Item Properties dialog if signed into an on-site server; on the right,an incarnation of the Edit Item Properties variation of the Item Properties dialog if signed into an Altium Designer Workspace

Access

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

Options/Controls

  • Name - the name of the Item.
  • Description - a meaningful description of what is represented by this Item.
  • 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.
  • Share Item - click to open the Share For dialog in which you can specify permissions for this item.
  • Advanced - click to open the advanced version of the dialog to access additional options, such as Revision Naming Scheme and Lifecycle Definition.
    • Folder – the server folder in which this item is stored. Click  to open the Choose Folder dialog to select or create a different folder.
    • 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 server. Schemes are defined in the Edit Revision Naming Schemes dialog, which is accessed by clicking  at the right of the field. Since schemes are chosen at the Item-level, you can have different schemes applied to different Items. The chosen Revision Naming Scheme cannot be changed after the Item is released.​
    • 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 server. The definitions themselves are defined in the Edit Lifecycle Definitions dialog, which is accessed by clicking  at the right of the field. Since lifecycle definitions are chosen at the Item-level, you can have different definitions applied to different Items. The chosen lifecycle definition cannot be changed after the Item is released. The field to the right displays the state of the revision of this Item specified in the Revision ID field. This field is read-only.
    • Share Revision - use this link to open the Share For dialog in which you can specify permissions for this item.
    • Ancestor Revision – the preceding revision from which this Item is created/branched. Click  to open a dialog to navigate to and select an existing item revision. Click Clear to remove the current Ancestor Revision.
    • Revision ID – the revision of the Item in accordance with the chosen revision naming scheme. Use  to access the Set initial values dialog in which you can manually set the ID for the initial revision of a newly-created Item in a server.
    

On the left, an incarnation of the View Item Properties variation of the Item Properties dialog if signed into an on-site server; on the right,an incarnation of the View Item Properties variation of the Item Properties dialog if signed into an Altium Designer Workspace

Access

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

Options/Controls

  • Name -the name of the Item.
  • Description - a meaningful description of what is represented by this Item.
  • 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, a Component or Footprint).
  • Share Item - click to open the Share Fordialog that displays the permissions for this item.
  • Advanced - click to open the advanced version of the dialog to access additional options, such as Revision Naming Scheme and Lifecycle Definition.
    • Folder – the server folder in which this item is stored. 
    • Revision Naming Scheme – this field displays the scheme employed when assigning Revision IDs. Click  to open the Revision Naming Scheme dialog to edit the naming scheme if desired. Since schemes are chosen at the Item-level, you can have different schemes applied to different Items. 
    • Lifecycle Definition – this field displays which lifecycle definition is used to model the state transitions that an Item-Revision may undergo over time. Click  to open the Lifecycle Definition dialog to view the lifecycle definition of the item. Since lifecycle definitions are chosen at the Item-level, you can have different definitions applied to different Items. The chosen lifecycle definition cannot be changed after the Item is released. The field to the right displays the state of the revision of this Item specified in the Revision ID field. This field is read-only.
    • Ancestor Revision – the preceding revision from which this Item is created/branched.
    • Revision ID – the revision of the Item in accordance with the chosen revision naming scheme. This field is read-only.
  • Share Revision - click to open the Share For dialog in which you can specify permissions for this item.
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.