Defining Lifecycle Definitions for a Workspace

Parent page: Server Items

Each Item in a managed content server is comprised of a series of revisions, with a new revision used to accommodate new data, each time that data is modified and committed/uploaded/released. The revision therefore reflects the progress of the Item as it undergoes changes. Or to say that the other way around, if the data entity represented by the Item changes, the revision must be incremented to reflect that.

For any revision of an Item, it is also important to reflect the current state of that revision - what stage of its 'life' it has reached. This status is referred to as the Item Revision's Lifecycle.

The lifecycle allows a company to manage the Item from a business perspective, and in accordance with company policies and practices. With this lifecycle information, people that need to use an Item in a Server - from a designer contemplating reuse of a released design 'building block', to the supply chain needing the data to fabricate and assemble a board - are able to see, at-a-glance, what stage a revision of an Item has reached in its 'life' and therefore what it can be safely used for.

Modeling the Lifecycle

While different organizations may choose to model or label the lifecycle of design items slightly differently, they will all follow a similar theme. For example, the general cycle of a product’s life will be something like: it starts as a design idea, then becomes a prototype, then goes into production, then at some point becomes obsolete and is no longer made or sold.

Using lifecycle status information on every component of a design helps to ensure that a design can only be promoted to a higher state if that new state is less than or equal to the lowest-state component within the design. For example, if a design is ready to move into production, it should only be allowed to do so if all components within it are also in production - i.e. components that are still In Prototype (or New From Design) must be promoted to In Production before the design as a whole can be promoted to that level.

In many cases, the revisions of Design Items will progress through the various lifecycle states linearly however it should not be assumed that this is the only path that can be taken. For example, some Item Revisions may end up being abandoned before they have even reached the prototyping stage. In managed content servers, the allowable states that an Item's revision can move between are defined by a Transition table included in the lifecycle definition.

A managed content server supports two levels of lifecycle management: Simple or Advanced. These essentially determine the style of management, upon which the lifecycle definitions themselves are then built. For a lifecycle definition based on the Simple management style, only states and state transitions are involved. For a lifecycle definition based on the Advanced management style, states can be further clustered into defined stages.

States, Stages and Transitions

Related page: Accessing the Detailed Item View

Each point in an Item Revision's lifecycle is referred to as a State, for example In Production. When an Item's revision changes state it is referred to as a Transition, which can only be to another State.

Lifecycle definitions based on the Advanced management style support States being clustered into Stages. Stages allow labels to be created that identify where an Item's revision is in its development. For example, it could be in Design, or in Prototype, or in Production.

An example lifecycle definition whose states are clustered into three stages.

The image below shows a snippet from the detailed Item view for an Item that employs a 3-level Revision Naming Scheme: Model, Prototype and Revision. Each Model is shown as a separate block. Within a Model, each Prototype is a sub-block. Below each Prototype are the Revisions of that Model/Prototype, then within each Revision are the different States that the revision existed in.

Example lifecycle states for various revisions of an Item.

Default Lifecycle Definitions

The Altium NEXUS Server provides seven default lifecycle definitions. These default definitions can be used 'as is', or modified to suit company (or personal) requirements. New, custom definitions can also be added and configured, as required.

The default lifecycle definitions are as follows:

• Basic Lifecycle
• Component Lifecycle
• Extension Lifecycle
• Simple Lifecycle
• Simple Lifecycle With Approvals
• Structured Lifecycle
• Structured Lifecycle With Approvals

The lifecycle definition applied is chosen at the individual Item level, when creating an Item. Different Items can therefore have different lifecycle definitions assigned to them.

Managing Lifecycle Definitions

From within Altium NEXUS, lifecycle definitions can be viewed and managed from within the Edit Lifecycle Definitions dialog. To access this dialog for the Active Server to which you are currently signed in:

1. Open the Data Management - Servers page of the Preferences dialog.
2. Click the Properties control, at the far right of the Active Server's entry.
3. Choose the Lifecycles command from the associated menu.

Lifecycle Definitions for the Active Server are created and edited - in Altium NEXUS - through the Edit Lifecycle Definitions dialog. Roll the mouse over the image to see the
dialog when signed in to an Altium NEXUS Server.

Browser-based Lifecycle Management

Your managed content server provides the ability to define and manage lifecycle definitions through its browser-based interface, complementing the ability to do this through Altium NEXUS. 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.

Defining and managing a lifecycle definition through the Server'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 sta te transitions (and stages if using an Advanced style of management).

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

Adding a New Definition

To create a new Lifecycle Definition, click the Add New Definition link at the top of the Edit Lifecycle Definitions dialog. A new tab will appear in the dialog, ready to be configured.

Create your own, custom lifecycle definition.

Configuring a Definition

Use the controls available within a lifecycle definition's tab to configure that definition as required.

First, enter a meaningful name for the definition in the Definition Name field. The tab will dynamically reflect the name entered.

Use the Lifecycle Management controls to select the style of lifecycle management - either Simple or Advanced. The simple style means there are only States and State Transitions involved. The advanced style allows definition of Stages, into which the states are clustered.

Specify name and style for the lifecycle definition.

Initial State

Use the Initial State of Revisions field to determine the starting state for an Item Revision, that is, the state for the revision in which it contains no released data - the 'pre-release state' as it were. By default, this state is named Planned. To change it, click the link and use the State Properties dialog to determine its name and a description, as well as text and background colors.

Configure the initial state for revisions.

Stages

If the Advanced style of lifecycle management is chosen, controls for adding and defining the required stages become available. A single stage - named Design - is provided by default, with the possibility to add a further two stages. To add an additional stage, simply click the Add Stage link.

Enter names for the stages as required by typing directly into the respective Stage Name field.

Add stages as required, which will be used to cluster states and create a more enriched, structured lifecycle definition.

To remove a stage, simply click the  control, to the right of the respective Stage Name field.

States

The next step is to add the required states for the lifecycle definition. For a lifecycle definition based on the simple style of management, this will be a flat listing. For the advanced style of management, this will require adding states to the various defined stages.

Click the  control below a state listing to add a new state. Use the State Properties dialog that appears to define that state, in terms of its name, description and color attributes.

Adding a state to the lifecycle definition.

A new state is added to the bottom of the list. Click on a state to select it, then use the  controls to move it to the required location in the list.

When defining states for an advanced-style lifecycle definition, addition controls are available to move a state between stages. Depending on the position of the stage, push the state to the stage on the right (), or left () as required.

To edit the properties of a state, click to select it, then click on the  control, to the right of the state name. To delete a selected state, use the  control.

Example states defined across a two-stage lifecycle definition.

Transitions

The last step is to define the State Transitions - the paths between the different states. Click to select a state, then click the  control to the right of the state name to add a new state transition. Use the State Transition Properties dialog that appears to define the transition, in terms of its name, target (next) state, menu text, and permissions.

Adding a state transition.

A new transition is added to the bottom of the list. Click on a transition to select it, then use the  controls beneath the state listing to move it to the required location in the list.

Where the next state for a transition resides in a different stage, an indication arrow - in the color of the target state - will be displayed to show this.

Example of fully defined states and state transitions across a two-stage lifecycle definition. Arrows are used to indicate transitions across stages.

To edit the properties of a transition, click to select it, then click on the  control, to the right of the transition's name. To delete a selected transition, use the  control.

Linking Stages to Levels of the Revision Naming Scheme

Revisions and Lifecycle States can be incremented from the applicable right-click menu in the Item view, or the Explorer panel. While establishing a new Revision and Promoting the Lifecycle are completely separate tasks that are done for different reasons (a new revision when there is a design change, a new lifecycle state to reflect the enhanced usability of that Item Revision), they are inter-related.

For a lifecycle definition based on the advanced style of management, the defined stages can be linked to the revision levels of the employed revision naming scheme. Do this using the option at the bottom of the Edit Lifecycle Definitions dialog.

Option to link stages to revision levels.

This creates a relationship between the Lifecycle State and the Revision Level. What that means is when an Item Revision's Lifecycle is incremented so that it moves from a state in one stage to a state in another stage, then the available Revision modification type commands - on the right-click menu - will change too.

Consider the default lifecycle definition Structured Lifecycle With Approvals, and a 3-level Revision naming Scheme (with levels for Revision, Prototype and Model). If an Item Revision is in the state New From Design, in the first stage, then the Revision-type options on the right-click menu include: establish a new Revision; a new Prototype; or a new Model.

If the lifecycle is then incremented to the point where it is now In Prototype, it will have moved to the second stage. Right-clicking on it, the available Revision-type options now include: establish a new Prototype; or a new Model, that is, there is no option to start a new Revision. This behavior is intuitively expected - if the design has progressed to Prototype, then if a design change was needed, a new Prototype would be needed, or even a new Model, depending on the scope of that change.

Once the Item Revision reaches the In Production state, in the third stage, the Revision-type option to establish a new model is available only, again as expected.

When linked, revision-type commands change as the Item Revision's lifecycle state progresses through the different stages defined.

Saving a Definition

Whether a new lifecycle definition has been added, or an existing lifecycle definition has been modified in some way, that lifecycle definition must be saved. Although there is no actual 'save' command, there are controls available to perform this:

• For a new lifecycle definition - distinguished by a '+' suffix - either use the Add Definition control (at the top-right of the definition's tab), or click the dialog's main Apply button.
• For an existing lifecycle definition that has been modified - distinguished by a '*' suffix - either use the Apply Changes control (at the top-right of the definition's tab), or click the dialog's main Apply button.

In either case the suffix will be removed and the definition will be added as part of the set of lifecycle definitions available to the Server.

In the spirit of facilitating a clear and transparent audit trail - of whom changed what, and when - details of when a lifecycle definition was last modified are provided at the bottom-right of its tab.

Identifying when a lifecycle definition was last modified, and by whom.

Renaming a Definition

To rename an existing, used lifecycle definition:

1. Access the Edit Lifecycle Definitions dialog for the Active Server.
2. Click the tab for the definition whose name you need to change.
3. Modify the name in the Definition Name field.

Example of renaming a lifecycle definition, and verifying the change in the properties of an Item already using that definition.

Cloning a Definition

New lifecycle definitions do not need to be created from scratch. The Edit Lifecycle Definitions dialog provides the ability to quickly clone any of the existing definitions. To do so, make the required lifecycle definition that is to be cloned, the active definition, then click the Clone control at the top-right of that definition's tab.

An exact copy of the definition will be taken, creating a new definition with initial default name of New Lifecycle Definition. Rename as required and click the Add Definition control (or the main Apply button) to effectively save the new definition.

Deleting a Definition

To delete an existing lifecycle definition, simply select it - making it the active definition in the Edit Lifecycle Definitions dialog - then click the Delete control, at the top-right of the definition's tab.

Permanent deletion of a lifecycle definition is effected upon clicking the dialog's main Apply button (or clicking OK). Prior to this, the delete operation can be undone by clicking the Undo control, at the top-right of the dialog.

The operation to delete lifecycle definitions can be undone.

Exporting and Importing Definitions

User-defined lifecycle definitions are available for use only in the managed content server in which they are defined. Providing the ability to port definitions between Servers, the Edit Lifecycle Definitions dialog features Export and Import capabilities.

To export a lifecycle definition, click on the Export control, at the top-right of its tab. Use the subsequent Save Lifecycle Definition dialog to determine where, and under what name, the file is to be saved.

To import a lifecycle definition, click on the Import Definition control, at the top of the Edit Lifecycle Definitions dialog (above the tabbed definitions). Use the Open Lifecycle Definition dialog to browse to, and open, the required Lifecycle Definition file. The lifecycle definition will be added to the list of existing lifecycle definitions available to the Server.

Controlling the Use of a Lifecycle Definition

Control over which Item types can use a particular lifecycle definition, can be defined and enabled at a global level, when defining each definition. If this feature is enabled, then only those allowed definitions will be available when choosing the lifecycle definition for a particular Item type. This gives you that extra level of control to ensure created Items of a particular type only use the lifecycle definition you require.

Control is performed from within the Content Types dialog. Click on the tab for the particular definition whose access you wish to configure, then click the Content Types link, at the top-right of the definition's tab.

Accessing the Content Types dialog - command central for determining which Item types can use the lifecycle definition being configured.

The Content Types dialog lists all of the supported Item types that can be created in your active managed content server. The option above the list - Control Lifecycle Definition per Content Type - provides global control over whether the feature is active (enabled) or not (disabled), for that particular definition. Enable this option, then enable the associated Use option for each Item type that you would like to be able to use that definition.

Switching between Advanced and Simple Lifecycle Management Modes

You can switch an existing lifecycle definition from using the Advanced style of lifecycle management (states, state transitions, and stages) to using the Simple style of management (states and state transitions only). When you enable the Simple option, the Confirm Merge States dialog will appear. Use this dialog to determine how to handle the switch as follows:

• Click Yes - all defined states (and state transitions) across Stages 1, 2, and 3, are merged into a single flat listing of states.
• Click No - all defined states (and state transitions) in Stages 2 and 3 are deleted. Only those states (and state transitions) in Stage 1 (the left-most stage) will remain in a single flat listing of states.

Switch style of lifecycle management - from Advanced to Simple - with control over how the states (and state transitions) in other stages are handled.