State Change and Release Notes for Vault Items

Old Content - see latest equivalent
Modified by Jason Howie on May 31, 2017
Contents

Parent article: Items and Item Revisions

Enhancing the audit trail for Items in an Altium Vault, Altium Designer provides the ability to enter notes when changing the lifecycle state of an Item Revision and, for some Item types, when releasing the source data into planned revisions in the vault.

State Change Notes

When changing the lifecycle state for an Item Revision in a vault, use the State change note region of the subsequent state change dialog to enter a relevant note for that change.

State changes can be effected for an Item Revision either from within the Vaults panel, or from the detailed view for the parent Item in Altium Designer. Access to the latter is made by right-clicking on the relevant Item within the Vaults panel, and choosing Full Item History from the context menu.

Adding a note to explain the change in an Item Revision's lifecycle state.

Release Notes

When releasing source data into a new planned revision of an Item in a vault, use the Release notes region of the subsequent Release Confirmation dialog to enter a relevant note for that release. This facility is available when releasing the following design-side items:

  • Schematic Sheet
  • Schematic Template
  • Output Job File
  • Simulation Model

This facility is only available when releasing singular items directly from within their respective editors. It is not available when releasing through the Release Manager.

The following design-side Items make use of a trimmed variant of the Release Manager, and so do not benefit from this feature for initial release. However, when re-releasing using the file-less editing paradigm, the ability to add release notes becomes available:

  • Component Definition
  • Schematic Symbol
  • PCB 2D/3D Component Model

An example of adding a release note during the re-release of a Component definition to a target vault.

Viewing the Notes for an Item Revision

The notes added for an Item Revision can be viewed in the following places:

  • Detailed Item view – view the associated release note and notes for revision state changes in the Note column within the Timeline region. For each state in a revision's life, the applicable note (if added) can also be seen within the graphical view of the revision's lifecycle.
  • Vaults panel – switch to the Lifecycle aspect view for the Item Revision. For each state in that revision's life, the applicable note (if added) can be seen in the graphical depiction of the revision's lifecycle. In addition, the release note (if added) is presented in the Note column, within the main Item region of the panel.
Hover over the note entry in a lifecycle state cell in the detailed Item view, to pop-up a tool tip with the full note.

Viewing the notes associated to revisions of a Component Item.

You are reporting an issue with the following selected text and/or image within the active document: