Altium Designer Documentation

Validating Component Status

Modified by Jason Howie on Jul 4, 2019

Parent page: Working with the Project Releaser

Managed components offer the designer a formal collection of high-quality, high-integrity, design building-blocks. Revision-controlled and lifecycle-managed, a company can authorize the 'set' of components that can be formally used by their designers, in each new design project embarked upon within that company. However, while Component Items may be authorized for design reuse, there also needs to be automated checking at the release validation stage, to verify that they are indeed in the right state to be used.

Altium Designer, in conjunction with your managed content server, provides an elegant solution to this, in the form of Component State Checking. A validation-based outputter is available for addition to an Output Job file - Components states. This can be configured to check for components that are in restricted states. As part of configuration, you determine the action to be taken for each currently defined state, of each currently defined Lifecycle Definition in the server - no action, a warning, or generate an error. The latter will prevent release of the design. In addition, running the check will generate a handy HTML-based report, allowing you to see at-a-glance which design components are not in valid states.

Issues with using design items in restricted states can also be detected much earlier in the design cycle, by the Compiler. This concerns an Item Revision's applicability based on its current state, and whether it is allowed to be used in designs while in that state. This is controlled through use of a dedicated attribute at the individual state level. A project compiler violation can be configured to detect and flag any server items being used in a design, whose revisions are in non-applicable states - catching and averting issues prior to release. For more detail, see Controlling Item Revision Visibility and Applicability.

Add an output generator of this type from the Validation Outputs section of the OutJob file. Configuration is performed in the Server Objects State Validation dialog.

Add and configure a component state check as part of your overall validation regimen during board design release.

The dialog presents all lifecycle definitions defined for the managed content server to which you are actively signed in. For each definition, each uniquely-defined state is listed, along with its description. For each state associated with a lifecycle definition you employ for components in your designs, simply specify the checking action to be taken. Click within a state's Check Action field, and select the required action from the associated drop-down menu. Available checking options are None, Warning, and Error.

Click the  button to refresh the dialog with the latest lifecycle definition information, directly from the server.

Revisions of Component Items used in the design that are in a restricted state (one whose Check Action has been set to Error) will prevent the release of the board from happening. The generated report file will list all warnings and errors.

Example board release failing at the validation stage while checking component states. Hover over the image to see the generated report. Here, the design is found to contain a single component revision in a restricted lifecycle state, and the release process is terminated in failure.

If you are using managed output job configurations, ensure the component state check is added to the relevant source Output Job file and configured BEFORE releasing that OutJob to the managed content server. Once managed, the OutJob file - specifically the configuration of an output generator - can not be changed. You would need to make changes and re-release into the next planned revision of the target Item. For more information, see Managed Output Job Files.

 

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.

We're sorry to hear the article wasn't helpful to you.
Could you take a moment to tell us why?
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.