Component and Library Management / Library Health Dashboard Completed Sign In To Save Your Progress
Click if you find this content useful

Component and Library Management

Library Health Dashboard

In the Altium 365 Workspace, you can see which (and how many) components you currently have at your disposal, and you can also view a summary of the health of those components. Digging deeper, you can also access more detailed information regarding component health through a dedicated "Library Health" dashboard. This provides greater detail about issues and enables you to quickly assess and fix components accordingly.

Access your managed components through the "Components" page of the Workspace's browser interface.

A summary of the overall health of your workspace components appears in the top region of the Components page.

Fig.1 - Library Health region of the Components page
Fig. 1 - Library Health region of the Components page

Tip:  The summary becomes populated once an initial component health check is performed. This check is performed automatically the first time the Components page is accessed.

The following information is also presented under Components:

  • The total number of components in your workspace. This is the sum of the ‘healthy’ components plus those with an issue (error).
  • The number of healthy components.
  • The number of components that have an issue. A particular component can have multiple issues.
  • The number of components that have been recently added to the workspace. For example, if two components were created yesterday and three more were added today, the number reflected on the dashboard will be 3 (three).
  • The number of requested components – as part of the "Part Requests" feature (available with the Pro Subscription Plan).
  • The number of unused components. Components not used in a managed schematic sheet or directly within a design.

The health indicator bar visually shows you the health of your components. It reflects healthy components in green and those with an issue in other colors – warnings in yellow, fatal errors in red, or errors in orange.

Click the detail button to access the detailed Library Health dashboard page. The top of the page presents the same summary information found at the top of the main Components page of the interface. Below are the supported health check analyses gathered into different subjects.

Fig.2 - Detailed Library Health dashboard page
Fig. 2 - Detailed Library Health dashboard page 

Enable the “Show and check used components only” option on the top right of the dashboard to only present health checking data for components you are using in your designs or managed schematic sheets. Health checking is performed when the dashboard is refreshed, and all unused components will be excluded from checking.

Fig. 3 - Show and check used components only
Fig. 3 - Show and check used components only

The following issue themes are split into columns, and health check analyses are currently supported:

Supply Chain

  • No Defined Part Choices – a component fails this health check if it does not have at least one Part Choice defined and has no link to a Manufacturer Part.
  • Stock Issues* – a component fails this health check if it has a defined Part Choice that is not in stock.
  • Risky Lifecycle States* – a component fails this health check if it has an obsolete Part Choice, is not recommended for new designs (NRFND), or is invalid. You may encounter challenges in purchasing and supplying your design components in these states.

Component Details

  • Uncategorized Components – a component fails this health check if its type is undefined.
  • Ambiguous Component Parameters* – a component fails this health check if it has one or more parameters that do not comply with the latest version of the applicable component template.
  • Using Outdated Template* – a component fails this health check if it references a component template that is not the latest revision.

Duplicates

  • Duplicates by Name – a component fails this health check if it has the same name as another component.
  • Duplicates by Part Choice – a component fails this health check if it has the same defined Part Choice as another component.
  • Using Outdated Models – a component fails this health check if it references an outdated symbol or footprint model.
  • Using Prohibited Models* – a component fails this health check if it references a symbol or footprint model that is not for design use.

* Available with the Pro Subscription Plan.

Tip:  Each health check analysis tile reflects the number of components that fail a health check. Color coding reflects healthy/no issues in green, fatal errors in red, errors in orange, and warnings in yellow.

Clicking on a health check analysis tile will provide a more detailed description of the check with steps to resolve (where available) and a detailed listing of all components failing that health check.

Fig. 4 - Inspection of components that failed a specific health check
Fig. 4 - Inspection of components that failed a specific health check

By default, the following columns of data are always presented:

  • Name
  • Description
  • Revision ID
  • FootprintName1
  • Revision State

Click the ... control at the far right of the header region to access a window to enable the display of further columns of data.

Fig. 5 - Columns to be displayed
Fig. 5 - Columns to be displayed

Selecting a component entry will present detailed information on the right-hand pane.

Fig. 6 - Risky Lifecycle States
Fig. 6 - Risky Lifecycle States

You can quickly access the component's page within the "Octopart" site on a separate browser. Select the component of interest, click the control at its far right, then choose the "Show in Octopart" command from the associated menu. You also have the option to open a datasheet or delete the component.

Fig. 7 - Show in Octopart
Fig. 7 - Show in Octopart

The detailed Library Health dashboard page is the only place from which you can run another health check – refreshing the dashboard, as it were. This can be performed at two levels: refreshing the dashboard entirely or partially.

Refresh dashboard entirely – runs an update across all issue themes and associated health check analyses. This refresh level is performed by clicking the button at the top right of the main Library Health dashboard page. During the refresh, the button will change , and the text will appear next to each supported issue theme.

Fig. 8 - Refresh dashboard entirely
Fig. 8 - Refresh dashboard entirely

Refresh dashboard partially – runs an update across all associated health check analyses in a particular issue theme. This refresh level is performed from two places – by clicking the R control next to the issue theme entry on the main Library Health dashboard page or by clicking the Rbutton in the heading of the detailed page when inspecting one of the health check analysis types in that issue theme.

Fig. 9 - Refresh dashboard partially
Fig. 9 - Refresh dashboard partially

You can also exclude components from a health check analysis individually. Click on the required health check analysis tile, select the component to be excluded from this check, and click the ... control on its far right side to enable the "Exclude from analysis" option on the associated menu.

Fig. 10 - Exclude a component from the analysis
Fig. 10 - Exclude a component from the analysis
To learn how to perform a Health Check in Altium Designer, please visit: Monitoring the Health of Your PCB in Altium Designer.
 
Some aspects of this feature are only available with the Pro Subscription Plan. To learn more about Altium Subscription Plans, please visit https://www.altium.com/subscription/plans.
Good job! Article is now completed!
Sign In To Save Your Progress

Read Again

Was this article useful?
Yes No
Thank you Glad to hear it