A Quick Guide to Component Management with a Workspace Connected to Altium Designer

Altium Designer, with its unified design approach, has traditionally used a component model that extends across all aspects of the electronics design process. However, to seamlessly fit the process of electronics design into the encapsulating product development process as a whole, this model needed to evolve – extending to cover other aspects including other design processes (in particular MCAD and Industrial Design), as well as business processes (such as procurement and manufacturing) that intersect with the product development process.

This evolved object model is known as the Unified Component Model.

Under this modeling paradigm, the design component, as seen by the designer, is separated from the Manufacturer and/or Vendor parts. This information is not defined as part of the component. Instead, Part Choices are used to map the design component to one or more Manufacturer Parts, listed in a Part Catalog, which in turn can be mapped to one or more Vendor parts, allowing the designer to state up-front, what real parts can be used for any given design component used in a design.

These components, along with their part choices, are stored in your connected Workspace – one centralized secure location for all your design data, accessible for your entire design team.

Importing Existing Libraries

Altium Designer provides a streamlined, simple process to quickly import your existing libraries to your connected Workspace. The GUI to this process – the Library Importer – presents an intuitive flow that takes initially selected libraries, and imports them to the Workspace (to which you are actively connected). Catering for all types of libraries relating to older component management methodologies – SchLib, PcbLib, IntLib, DbLib, SVNDbLib – the Library Importer is the perfect solution to quickly building your company's Workspace Library, and the many benefits that such components enjoy – high-integrity, centralized storage and management, ease of design reuse, real-time supply-chain information.

The Library Importer offers a minimalist Simple interface mode where the selected database and file-based component libraries are imported to Workspace Library through a single step, while the importer automatically takes care of type classification, the target source folder, parameter inclusion and value type, and the transfer of all relevant data. The interface is also available in an Advanced mode that provides a full preview of the proposed library import, and access to its related data and settings. And while the import is a single-click process by default, the importer also offers advanced configuration options through the Properties panel for enhanced control over exactly how that import is performed.

While access to the Library Importer is available in Altium NEXUS, should you wish to access a database or file-based library to make pre-import tweaks, or access the Available Libraries list, you will need to enable the use of legacy component management methodologies. Use of such content is disabled by default in Altium NEXUS, as it is not recommended. You can restore this functionality by enabling the Legacy.UnManagedLibraries option in the Advanced Settings dialog – accessed by clicking the button, on the System – General page of the Preferences dialog. You will need to restart Altium NEXUS for the change to this setting to take effect.

All information that is present in an original source library is imported to the Workspace Library components, including all referenced domain models (schematic symbols, PCB footprints, simulation models), parametric information, assigned part choices, datasheet files, etc. Component templates are also created where necessary, and may then be refined and used for subsequent library imports. If your original components have multiple PCB footprints defined, the Library Importer will bring those models across and keep the current default footprint. And if you only work with PCB libraries – your only concern is PCB layout – then the Library Importer supports import of just those libraries, or it can be switched to a models-only import mode where specified models types are imported from integrated or database libraries. Libraries that include multiple component types (monolithic libraries) are automatically detected and processed as well.

The Component Editor

A component is defined/edited using the Component Editor. This editor provides two different modes of operation:

• Single Component Editing mode – provides a streamlined interface when defining/editing a single component. This is the default mode when creating a new component, or editing a single revision of an existing component.
• Batch Component Editing mode – provides the interface for defining/editing multiple components. You can access this mode by choosing the Tools » Switch to Batch Editor command, from the Component Editor's main menus. This mode is also accessed if you have selected multiple component revisions for editing, from the Components or Explorer panel. Each component definition will have a common set of parameters and links to required domain models. Batch editing comes into its own where it makes sense to manage components as a set, such as a set of chip resistors for example.

Domain Models

From a designer's perspective, a component gathers together all information needed to represent that component across all design domains, within a single entity. It could therefore be thought of as a container in this respect. A 'bucket' into which all domain models and parametric information is stored.

In terms of its representation in the various domains, a component doesn't contain the domain models themselves but rather links to the relevant model Items that are also in the Workspace. These links – to symbol, footprints, and simulation models – are specified as part of the component.

Use the following links to take a look at the various domain models that can be stored and managed in your connected Workspace:

• Schematic Symbols
• PCB Footprint Models
• 3D Models
• Simulation Models

Component Templates

Helping to streamline the creation of your components, Altium Designer, in conjunction with your connected Workspace, supports creating and defining Component Templates. Just as a schematic template can be used to predefine information on schematic sheets that reference it, a component template is referenced by a component and provides predefined settings for use when defining that component.

In particular, component templates have been developed with parametric information firmly in mind, allowing you to define, in a single location, a 'bucket set' of parameters that will be made available to the referencing component. Through the template, you can control which of those parameters are to be made visible, fill in default values, and even mark those parameters that are required as mandatory. In addition, you can also force the use of parameters, marking them as required. Validation checks are in-place at the time of component save, to ensure compliance.

The Component Template Editor provides the ability to define explicit data types for component parameters defined within a component template (*.CMPT). In addition, these data types are unit-aware, with a range of popular unit prefixes supported. As such, you can enter a parameter's value using a range of formats – such as 2.2k, 2k2, 4M, 2.5GHz – with the Workspace engineered with the requisite smarts to recognize the numerical value behind those entries.

This feature of a component template facilitates targeted searching through the Workspace's Advanced Search facility – a facility that not only allows you to search by component type but allows you to search smarter, with range searches. Using the power of unit-aware component parameters, you can quickly define a search, for example, to find all capacitors with a capacitance between 47uF and 220uF.

Adding Datasheets

Altium Designer, in conjunction with your connected Workspace, caters for the ability to store component datasheets within that Workspace and, in doing so, link them to target components. This allows you to more fully describe and support a component, in a centralized fashion, while reducing the reliance on external storage mediums (shared network drives for example). Storing datasheets next to the very components that need to reference them also means you no longer need to have a live internet connection, to consult a reference document that can often, and frustratingly, disappear without warning at the whim of the hosting website!

One or more datasheets can be attached (uploaded) to a component – essentially creating a link between the component and the datasheet(s) – when creating/editing that component through the Component Editor.

For an existing component in your Workspace, one or more datasheets can be attached (uploaded) through the Explorer panel. While browsing the required component, switch to its Data Sheet aspect view.

Part Choices

In the Supply Chain Area, a procurement specialist often does not know what a particular component in the design represents. What is required, is an indication of what needs to be procured – which physically manufactured components can be used to implement that design component. The best person to indicate which real-world components can be validly used to implement the design-level components would be the designer. As part of the Unified Component modeling paradigm, Altium Designer caters to exactly that through the concept of making Part Choices.

Part Choices essentially create the mapping from a component in your connected Workspace to nominated Manufacturer Parts in that Workspace's local Part Catalog. In other words, Part Choices specify the 'allowed' manufacturer parts that can be used to implement that component on the assembled board. The actual supply chain intelligence – comprising Manufacturer (and part number), Supplier (and part number), Description, Pricing, and Availability – is sourced from the Workspace's local Part Catalog and the relevant Part Source.

The designer can feel truly empowered by being able to specify Manufacturer Parts that are truly interchangeable at manufacturing time in the context of any usage of that component in their design – the very essence of true part equivalency. And it is this intelligent mapping of a component, that turns the humble component into a truly Unified Component. The unified nature of a component, through the chosen part choices made for it, ultimately creates a link from that component, all the way through chosen Manufacturer Part(s), and on to the Vendor (Supplier) Parts that each itself references. From the designer's perspective, the component is hooked directly into the supply chain.

Real-time data is made available – fed back from the relevant parts database – to let the designer know the current costing and availability of the chosen parts, and from all enabled Vendors that sell those chosen parts (as defined in the local Part Catalog). And the procurement specialist can also keep abreast of supply-chain information, as it is made available in the Workspace for each component therein.

A part is no longer available or has suddenly become cost-ineffective? No matter, provision is made for real-time updates to be sent back to the Design Area as soon as a change occurs. With this vital 'heads-up', the designer can take that choice of part out of the associated list of Part Choices for that component and essentially 'off the radar'. And at any time additional new, truly equivalent parts can be added to the list, should something more appropriate, available, and cost-effective come along.

Part Source Configuration

Each Workspace has its own dedicated Part Catalog. This is a part catalog database, dedicated to the management and tracking of manufacturer parts and their associated supplier parts. The catalog works only with the Workspace.

The Part Catalog stores items representative of actual Manufacturer Parts, along with one or more items representative of Supplier Parts – the incarnations of those Manufacturer Parts, as sold by the Suppliers/Vendors. Each Supplier Part is a reference to an item in a parts database – either the aggregate parts database of the Altium Parts Provider (which itself interfaces to, and gathers the parts from, enabled Suppliers) or a linked local parts database.

Which Suppliers are actually used – a list of Approved Suppliers – is managed by the Workspace, through the Part Providers page of its browser interface. This facilitates centralized supply chain management, with designers across the entire organization using the same approved list of Suppliers, with which to source supply chain intelligence for parts used in their designs.

Library Health

When browsing the content of a connected Altium 365 Workspace, the Explorer panel provides access to the Library Health view from where you can run health checks and inspect component health issues. Select the Library Health entry in the Server Folder region of the panel to access this view in the panel.

The top region of the view provides a summary of the health of your components, since last running a health check. Below are the health check analyses that are supported, gathered into various Issue Themes. Clicking on a health check analysis tile will provide a more detailed description of the check with steps to resolve (where available), as well as a detailed listing of all components failing that health check.

Key Panels to be Aware of

As part of your day-to-day activities with components, you will come to use, and rely on, two particular panels within Altium Designer:

• Components panel – provides a powerful interface with which to interact with all your components – both Workspace and local (database and file-based). And for your Workspace components, the panel provides a filter-based parametric (faceted) search capability, for specifying target component parameters. In addition, the panel also offers options to edit a component through the Component Editor (in its Single Component Editing mode), view the component in its source Workspace, and perform component management functions such as component creation and cloning, or editing the selected component's Part Choices and Type.

• Manufacturer Part Search panel – provides the ability for you to search for real-world manufactured parts by offering a sophisticated search feature based on categories and parametric filtering. The panel harnesses the manufacturer and supplier data resources of the Altium Parts Provider service to source the most pertinent and up-to-date component data. A selected manufactured part can be acquired to a connected Workspace or downloaded as a library, or its parameters and datasheets added to an existing part in the design space. The preferred supplier(s) of that manufactured part may also be selected and added, as Supplier Link parameters, to an existing design part. Acquisition to your own connected Workspace involves creating a new component using the Component Editor in its Single Component Editing mode – pre-filled with information from the searched part – and saving to that Workspace.

Re-use in a Design

Once saved and available in the Workspace, components can be re-used in any new design project. In addition, the concept of component certification is made possible as the components are formally revised and lifecycle-managed. This allows the organization to specify the state of its components and what they can be used for (design, prototype, production, etc). From a design perspective, this results in the creation of the Workspace library, containing a formal collection of components that have been company-approved for use in each new design project embarked upon within that company.

The beauty of using certified components in your designs is that when it comes time to change the lifecycle state of your board design, the integrity of the design becomes greater still, since a design can only be released to "Prototype" or "Production" provided the components it uses are also in a corresponding state. Put another way, you wouldn't start to produce that assembled board if the components are only at a "Design" stage!

And, if we take this to the finest level of granularity in the component management arena itself, the system will flag any attempt to promote the lifecycle state of a component in the Workspace if its referenced domain models are not in a corresponding correct state to be able to do so. In other words, a parent component cannot be further in its lifecycle than its child models.

Design using components that have been certified for use.

Placement of components can be performed either from the Components panel, or the Explorer panel.

Prior to Placement

Placing a component truly is simplicity itself. But before you do anything, first ensure that the schematic sheet (or PCB document) that is to receive the component is open in Altium Designer and is the active document. If documents are open across multiple windows, ensure also that the window containing that active schematic document has focus.

Placement from the Components Panel

Altium Designer supports access to, and placement of components from, the Components panel. The panel sources components from the active connected Workspace (and also any available database and file-based libraries). The panel offers full details of the selected component (Parameters, Models, Datasheets, Part Choices, etc.), component comparison, and for Workspace components, a filter-based parametric search capability for specifying target component parameters.

The Components panel uses the basic search engine functionality and view that is applied in the Manufacturer Part Search panel. While the Manufacturer Part Search panel harnesses the Altium Parts Provider service and focuses on component manufacturer and supplier data searches, the Components panel is populated with ready-to-place components from your Workspace and database/file-based library sources.

The panel gives a reassuring sense of familiarity for those designers who have regularly used it to search for, browse, and place components from any other library format – such as model libraries, integrated libraries, and database libraries.

Commands available to place a Workspace component from the panel depend on its mode:

• Compact Mode – place in one of three ways:
  • Select a component and use the Place command from the right-click context menu.
  • Double-click on the entry for the required component.
  • Click on, drag, and drop the component directly onto the active schematic sheet (or PCB document).

  
  Placing a component from the Components panel in its compact mode.

  
  Placing a component from the Components panel in its compact mode.

• Normal Mode – place in one of four ways:

  • Select a component and use the button at the top-right of the Details pane (accessed by clicking the button)
  • Select a component and use the Place command from the right-click context menu.
  • Double-click on the entry for the required component.
  • Click on, drag, and drop the component directly onto the active schematic sheet (or PCB document).

  
  Placing a component from the Components panel in its normal mode.

  
  Placing a component from the Components panel in its normal mode.

Placement from the Explorer Panel

While your day-to-day workings with components will typically be through the Components panel, placement can also be performed from the Explorer panel:

1. Browse or search for the component you wish to place.
2. Right-click on the specific revision of the component required (typically the latest, in which case just right-click directly on the top-level component entry).
3. Choose the Place command.

The component will float attached to the cursor – just pick a ball-park spot on the active schematic sheet (or PCB document) and click to effect placement. You can fine tune and nudge it into its final location at a later stage.

Place a component from the Explorer panel, using the dedicated Place command.

For more express placement of your components from the Explorer panel, Altium Designer provides the ability to drag & drop revisions of components directly onto the active schematic document (or PCB document). Browse your Workspace for the required component to be placed. Placement involves a specific revision of that component, so be sure to expand the main component entry to list all of its available revisions (click the button at the top-right of the panel and disable the Show only latest option to see all previous revisions). Then click on the required revision and drag an instance of it onto the schematic sheet (or PCB document).

Where-Used Capabilities

The highly relational structure of the data in a Workspace lends itself to powerful 'where used' capabilities. At any time, you are able to see where a particular child Item is used, in terms of parent Items in the Workspace. So for a given domain model, you can quickly identify which components reference it. For a given component, you can see which board designs it has been used in, which managed schematic sheets, and so on. Conversely, and from a parent Item's perspective, you are able to quickly browse its children.

The ability to traverse the content of a Workspace in this way can offer great benefit, not least of a time-saving nature. For example, if a component is deprecated or made obsolete for any reason, you can quickly identify and pull-up the schematic sheets and board-level designs in which it is placed, and update and re-save those content as new revisions using another equivalent and approved component.

And why re-invent that proverbial wheel, when you can find a component that you need to use and see which designs it has already been used in. If those designs are at a production state, that component has been proven already and is therefore good-to-go. It can be re-used in your next design with assured confidence.

Inspecting from the Components Panel

Select a Workspace component in the Components panel to view information about where the latest revision of it is currently used, in the Where Used section (if the panel is in its Normal mode, click the button to access the Details pane). The section provides quick-filter information for:

• Projects – the Workspace projects in which the component has been used. Information is only presented once the project has been saved to the Workspace.
• Managed Sheets – the managed schematic sheets on which the component has been used.

Inspecting from the Explorer Panel

The Explorer panel provides a richer experience with respect to the various parent-child relationships that can exist between data Items in the Workspace:

• For a parent Item, use the Explorer panel's Children aspect view tab.

Example exploring the children of a managed schematic sheet revision, using the Children aspect view tab (top). Notice the information is also available from the Preview aspect view tab (bottom).

• For a child Item, use the Explorer panel's Where-used aspect view tab.

Example exploring where symbol (top) and component (bottom) revisions are used, using the Where-used aspect view tab.