Browser-based Lifecycle Management

Vault Message

This documentation page references Altium Vault, which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace.

 

Parent page: Browser-based Access & Management

The Altium Vault provides the ability to define and manage your Vault's lifecycle definitions through its browser-based interface, complementing the ability to do this through Altium Designer. And providing better visibility of the states and transitions involved, each lifecycle is built in a graphical way, showing at-a-glance the flows involved. Many of the management controls you are accustomed to from the Edit Lifecycle Definitions dialog are present, but in a far more intuitive setting, allowing you to quickly build and modify your definitions with streamlined ease.

Currently, this functionality works well in Google Chrome only. Functionality for other browsers will be addressed moving forward.
Various documents are available that pertain to lifecycle management defined through Altium Designer, which equally apply here, with similar controls through the browser interface. For details on lifecycle definitions, see Item Lifecycle Management. For more detail on controlling state transitions, see Controlling Lifecycle State Transitions.

Access

Access to your vault's lifecycle definitions can only be made by an administrator for the vault (a member of the Administrators role). Once signed in to your vault through a Web browser, navigate to the ADMIN » SETTINGS page. Then, in the left-hand tree, click on the Lifecycle Definitions entry (a child of the Vault category).

Accessing lifecycle definitions through the vault's browser-based interface.
Accessing lifecycle definitions through the vault's browser-based interface.

A Graphical Interface

Defining and managing a lifecycle definition through the vault's browser-based interface is very much a visual affair. A definition is built rather like a flow diagram, using various graphical objects representing the states and state transitions (and stages if using an Advanced style of management).

Define your lifecycle definitions in a visual way, with graphical objects representing the sttages, states, and transitions.
Define your lifecycle definitions in a visual way, with graphical objects representing the sttages, states, and transitions.

Adding & Defining a Lifecycle Definition

Add a new definition by clicking the add new link, back on the summary page. A single-stage default definition will be created, using the Advanced style of management.

A newly added lifecycle definition, Advanced-style, with single stage, initial state, and released state. A single transition connects the two states.
A newly added lifecycle definition, Advanced-style, with single stage, initial state, and released state. A single transition connects the two states.

The controls available will be familiar from management on the Altium Designer side, including:

  • Giving the definition a name.
  • Defining which content types the definition can be used by - click the see all/change link to access a pop-up dialog with which to enable and define use of the definition per content type.
  • Choosing the lifecycle management style - Simple or Advanced.
  • Linking stages to the levels of revision naming scheme (for an Advanced-style definition only).

Then create the (stages), states, and transitions as required to build up the definition 'diagram'. Key things to note in doing this are:

  • There is always an initial state (usually called Planned).
  • Click the Add State button to add a new state graphical entity. Click and drag this to the position required. Define state properties through the State Properties pop-up dialog, accessed by double-clicking on the state graphic.
  • Click& hold on the border of a state graphic to add a state transition - drag to the required target state and release when an orange 'valid' circle appears. Define transition properties through the Transition Properties pop-up dialog, accessed by double-clicking on a transition entity. Newly added state transitions will be public by default - change control as required through properties.
  • To remove a stage, state, or state transition entity, hover over it and click the removal cross that appears.
  • To change the point along a state at which a state transition enters/leaves, hover over the transition, and click and drag an end arrow.

A quick play with the lifecycle management interface!
A quick play with the lifecycle management interface!

A legend at the bottom of the diagram reflects what various icons mean - whether a state is visible in Vaults panel and/or allowed to be used in designs, as well as the control over a state transition being performed (public, non-public, or requiring approval).

Once defined as required, click the Save button. Clicking the Redraw Diagram button will essentially restore the diagram to its last saved state.

Changes to definitions through the browser interface will appear in the Edit Lifecycle Definitions dialog when next accessed, and vice-versa.

Removing a Lifecycle Definition

To remove a lifecycle definition, simply click on its close cross, on the page presenting the summary listing of definitions. If that definition is currently being used by at leased one revision of an Item in the vault, then a pop-up will alert you to the fact that it cannot be deleted.

 

If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.
Content