Search In: Doc:Documentation: Altium Designer
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Ver: Version: 25
25242322
Close
Search Search on Documentation

Creating the BOM Document

Created: November 21, 2024 | Updated: November 21, 2024 | Applies to version: 25

Creating the BOM Document

ActiveBOM's working BOM document is referred to as a BomDoc. Add a new BomDoc to the project via the File » New sub-menu or right-click on the project in the Projects panel. When there is at least one component in the project, a new BomDoc can be created by clicking the + Create control next to the ActiveBOM entry within the project structure in the Projects panel. Note that each PCB project can only include one BomDoc.

The + Create control is available when the BOM.ActiveBOMDesignPreview option is enabled in the Advanced Settings dialog.

When you add a new BomDoc to your project, the schematic is automatically compiled, and all existing components are listed in the BomDoc. For Workspace Library components that include Part Choices, Solutions will be detailed in the lower region of the interface, as explained in the Understanding the Solution section below.

As additional components are placed on the schematic, they are automatically added to the BomDoc. Additional BOM Items and additional parameters can also be manually added directly in ActiveBOM via the Add new button located above the component list. Refer to the Custom BOM Items and Columns section to learn more.

  • When the BomDoc is opened, the project is automatically compiled, and the list of design parts and their supply chain details are refreshed. This can take some time when a large design is initially opened and can result in the BomDoc being flagged as a modified file, even though it was just opened.
  • The BomDoc is automatically refreshed upon activating if the project contains components edited and saved back to the connected Workspace. The Revision Status column displays the Out of date status for changed components, so you can immediately see what components should be updated to their latest revisions. 
  • Each design project can only include one BomDoc.

The BOM Items List

The upper region of the BomDoc is a tabular list of all of the components detected in the PCB design project, as well as additional BOM Items you have added directly into the BomDoc. This region is referred to as the BOM Items list.

The components, or BOM Items list, displayed in the Base view.
The components, or BOM Items list, displayed in the Base view.

There are 3 view modes available to display the BOM Items. Select the required mode using the buttons located above the list:

Flat view button, click to display each BOM Item in its own row in the BOM Item list  Flat view - a row for every component.

Base view button, click to cluster common BOM Items into the same row in the BOM Item list Base view - a row for each unique component in the project; the Designator column lists the designators of all components of this type. Multiple presentation options are available for grouped designators. Select the required Designator Grouping mode in the Properties panel.

Consolidated view button, click to display a consolidated BOM when the project includes variants Consolidated view - used when the project includes variants to display a consolidated BOM for all variants.

BOM Items List Editing Features

The component list supports a number of spreadsheet-like editing features, including:

  • Use the Column tab of the Properties panel to display/hide a column and define a name Alias for a column. An alias can also be defined using the Enter Column Properties dialog, accessed by right-clicking on a column name in the column header region of the BomDoc and then selecting the Rename Column command from the context menu. Note that the alias is the column name in generated BOM outputs.

  • Columns can also be added and removed by using the Select Columns dialog accessed by right-clicking on a column name in the column header region of the BomDoc and then choosing Select Columns.

    The Select Columns dialog
    The Select Columns dialog

    If you use the SiliconExpert or Z2Data integration functionality, you can also select columns of SiliconExpert or Z2Data parameters, respectively. Refer to the Pulling Part Data from SiliconExpert and Pulling Part Data from Z2Data pages to learn more.
  • Drag and drop to change the order of columns.
  • Sort by any column, hold Shift to sub-sort on subsequent column(s).
  • Click the Filter icon to filter by column values Grid displays include a Filter icon, click this to configure filtering based on values present in this column
  • Select cells using standard Windows selection techniques.
  • Copy cell contents from ActiveBOM, and paste values from an external spreadsheet editor into custom ActiveBOM columns.
  • User-configurable line numbers can be defined when the BOM is in Base view. In the Base view, click the Set line numbers button (Set Line Numbers button, click the arrow to configure line numbering) to add a line number to each row. Click the dropdown icon on the right of the button to open the Line # Options dialog, where the start and increment values can be defined. Refer to the Line Number Column section to learn more.
  • Click the Add New drop-down (Add new button, click to add an additonal row or column to the BomDoc) to add additional rows or columns. Refer to the Custom BOM Items and Columns section to learn more.
  • Click the Group by button (Group by button, use this to group the grid by the enabled column) to group the grid by the enabled column. Multiple Group By columns can be enabled (show image), and their order changed using drag and drop. This is a grid display feature, the grouping is not transferred to the Report Manager dialog when the Bill of Materials command is run.
  • Click the Reset Supply Chain button () to remove user-defined solution ranking and manually assigned SPN priorities from the selected BOM Items.
  • The current configuration of the BOM Items grid can be saved as a BOM Set. Refer to the Configuring and Saving the Display of the BOM Items Grid section to learn more.
  • Use the standard Windows shortcuts to scroll through the list of BOM Items:
    • Vertical scroll = MouseWheel Roll
    • Horizontal scroll = Shift + MouseWheel Roll

Many of the configuration and BOM display options are set in the ActiveBOM Properties panel.

Identifying Identical Components

To be able to group identical components in the Base and Consolidated views, ActiveBOM uses the following mechanisms:

  • For Workspace Library components - by DesignItemID.
  • For non-Workspace Library components - by DesignItemID and Library Name, and also by the component parameters enabled in the Component Grouping dialog. This approach allows designers to create generic non-Workspace Library components in the library, and then populate them with specific component detail once they have been placed. The default parameters enabled in the Component Grouping dialog are Comment, Description, and Value. Click the Component Grouping Edit button in the ActiveBOM Properties panel to open the dialog. Note that this button is only available when there are non-Workspace Library components in the design.

Notes about Component Grouping:

  • The Component Grouping dialog is used to identify identical components so they can be grouped. Although other parameters/properties, such as PCB component properties, can be listed in the Component Grouping dialog, only component parameters can be used to define identical components.
  • If you want to group components in the BomDoc or in a custom BOM for some other purpose, for example to group top-side components and bottom-side components, switch to the List view and then use the Group by button in ActiveBOM (show image), or use the Column grouping feature in the Report Manager (show image). The parameters available in the ActiveBOM Group by dropdown list are those parameters that are currently set to visible in the Columns tab of the Properties panel.

The Column Groups

The ActiveBOM components list has distinct groups of columns that present in each view mode, the image above shows the Base view.
The ActiveBOM components list has distinct groups of columns that present in each view mode, the image above shows the Base view.

The BOM Items grid is clustered into the following major groups:

  1. Item Details (orange highlight in the image) - these columns display parametric component details, such as the Designator, Description, Library Reference, and other component parameters.
  2. Solutions (green highlight in the image) - the highest-ranked manufacturer + supplier(s) from the Supply Chain. The number of solutions (manufacturer parts), and the number of suppliers of each solution, are configured in the ActiveBOM Properties panel - these are indicated by a  solid, colored banner in the supplier tile. Ranking is automatic, and can also be manually defined, as discussed in the Understanding the Solution section below.
  3. BOM Status (cyan highlight in the image) - an indication of the current risk associated with each component. Hover over an icon for a description, or alternatively, enable the detailed BOM Status column in the Properties panel to display the description.
In Consolidated View, an additional Group, titled Variants, is added just before the BOM Status column. This group includes a pair of columns for each variant, displaying the quantity and price (per unit) of each component (show image). Refer to the Working with Variants section for more information.
The display of columns and the definition of Aliases can be managed in the Columns section of the ActiveBOM Properties panel. To add a custom row, component, or column, click the Add new button above the component list.

Custom BOM Items and Columns

Image showing a custom row being added to a BomDoc

BOM management for a PCB design project requires the management of components and BOM Items beyond those placed in the schematic and PCB, for example, yet-to-be-detailed parts, fasteners, the blank board, or the mounting glue. There are many cases when custom BOM Items or parameters are used in the PCB design project. For these situations, ActiveBOM supports adding additional BOM Items and columns (parameters), which can then be included in the generated BOM:

  • Custom row -  an easy way to add a custom BOM Item that needs to be accounted for in the design (bare board, glue, etc). All fields in a custom row are user-defined. Custom rows are not managed by ActiveBOM, for example, if the quantity is set to 3, there will not be 3 separate items displayed in Flat view. Supply chain searching is also not supported for custom rows.
  • Custom column - additional BOM column, managed in ActiveBOM, that can contain any user-defined text.
  • Custom Item - an additional BOM Item, this is typically for those items that will be needed but are as yet not fully known or do not yet exist in the library. This allows these items to have their cost included in the overall board cost estimation.

  • Managed Component - an additional BOM Item, that is managed manually in the BOM document. The Component Search dialog will open, listing the components in the currently connected Workspace.

    The Component Search dialog 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 Component Search dialog is populated with ready-to-place components from your Workspace library and file-based library sources.

    The chosen additional BOM Item can be changed at any time via the right-click Operations sub-menu.
    • Use the Column tab of the Properties panel to quickly find, view and manage column visibility, name or aliases. When there is an alias defined for a column name, this is displayed in the BOM Items grid.
    • All additional BOM Items and parameters added in ActiveBOM are available for other BOM-outputs, and also via the software API.

Adding Instances of a Managed Component or Custom Item

After adding a Managed Component or a Custom Item, right-click on it and select the Operations » Add Instances of command to access the Add to BOM Components dialog. Use this dialog to define the number of instances of the component to the BOM.

Specify the Designator prefix, optional Separator (which can be defined to give results such as X-1, or X:1) and the Quantity of components required (this value is used to define the designator range and will also appear in the ActiveBOM Quantity column). All other parameters, such as the Description, can be edited directly in the BOM Items grid.

Changing/Removing a Managed Component or Custom Item

To edit the designator, or to remove an instance of a managed component or a Custom Item, right-click on it and select the Operations » Edit item command. The Change / Remove dialog will open.

Data Sources

The default data sources available in ActiveBOM are the schematic component parameters (Icon indicating that this parameter was sourced from a schematic component), the Workspace component parameters for Workspace content (Icon indicating that this parameter was sourced from a Workspace Library component stored), and data provided by ActiveBOM (Icon indicating that this parameter was sourced from the ActiveBOM document (BomDoc)). From these sources, ActiveBOM generates the main project BOM Item grid. Data sources are enabled and their display controlled in the Columns tab of the ActiveBOM Properties panel.

By enabling the relevant Sources button (above the Columns list), the BOM can also include information taken from the following additional data sources:

Click the PCB source button to include parameters from the PCB The PCB - enable these to include PCB location/rotation/side of board data in the available Columns, for each of the components. If the project contains multiple PCB documents, the Choose PCB to Use dialog will open, from which to select the required PCB.

Click the Database source button to include parameters from the database (database components only) Database - to load additional component parameters from an external database (via *.DbLib, *.SVNDbLib, or *.DbLink).

Click the Altium Cloud Services source button to include parameters from the Altium Parts Provider Altium Cloud Services - enable this to access a broad range of additional component data, for those BOM Items that have been identified by the Altium Parts Provider and show a supply chain solution.

Click the Document Parameters source button to include parameters from the project schematic documents Document Parameters - enable this to include all detected schematic document parameters, across all schematics in the PCB project in the available Columns.

The source of each parameter is indicated by the icon in the list of columns.
The source of each parameter is indicated by the icon in the list of columns.

  • The buttons above the Columns list enable/remove that data source, if a source is disabled then all data from that source is removed from the grid.
  • The checkboxes below the Columns list are convenient filters for the Columns list, use these to add/remove a data source from the Columns list, without removing the data from the grid.

As well as using the Altium Parts Provider it is also possible to connect to an existing company database via an ODBC connection. This is achieved by enabling the Custom Parts Provider Synchronization feature in Altium Designer (select the Custom Data Synchronization option in the Configure Platform page (under Importers\Exporters)) and enabling it as a provider in the Data Management - Parts Providers page of the Preferences dialog. This feature effectively allows the company database to behave as a Workspace parts provider.

To learn more, read about Custom Database Parts Providers on the Part Source Configuration page (Altium 365 Workspace, Enterprise Server Workspace).

Line Number Column

For PCB designs with assembly drawings, or for BOM data exchange between design engineers, cost engineers or purchasing specialists, the BOM line number (BOM Item position No) is a simple method used to individually distinguish BOM lines, which can then be used to explicitly identify or find the corresponding callout, component and depiction in the design.

As the project BOM data source, ActiveBOM supports user-defined Line #’s for the project BOM and has both manual and automatic Line # (BOM Item position No) management features.

  • To automatically set the position number for all project BOM Items (in Base view), click the Set Line # button. Line numbers are displayed in the Line # column, in the Item Details group of columns. Click the dropdown icon on the right of the button to open the Line # Options dialog, where the start and increment values can be defined.

    The Line Number Options dialog
    The Line Number Options dialog

    • Start number - the value to use if the first Line # cell is empty.
    • Increment - increment each blank Line # field by this amount.
    The values entered in the dialog are retained for subsequent uses of the Line # command.
  • To manually change Line #'s, switch to Base view mode then select the required cell(s) in the Line # column and:
    • Press Delete on the keyboard to clear the cells, then
    • manually type in new values, or
    • paste a range of values from the Windows clipboard.

  • To renumber or continue numbering from a custom-added number, click on the required item Line # cell, then click the Set Line # Set Line Number button button. The Line Numbering dialog will open, where you can use the existing numbers as references and continuously number the selected or all empty cells, starting with the nearest non-empty cells above (Continue numbering) or delete all existing numbers and renumber all rows (Renumber all). The base and increment values last defined in the Line # Options dialog are used to calculate the numbers added, if required you can enter a seed value in the selected Line # cell to define the start number.

    The Continue numbering variation of the Line numbering dialog opens when SOME of the line numbers in an ActiveBOM document (*BomDoc) have already been defined.

    The Renumber all variation of the Line numbering dialog opens when ALL of the line numbers in an ActiveBOM document (*BomDoc) have already been defined.

The Line # management features are only available in Base view mode.

Configuring and Saving the Display of the BOM Items Grid

Like any good spreadsheet application, the BOM Items grid can be configured to suit your requirements. As well as the traditional column ordering and sorting features, the current configuration can be saved as a BOM Set.

Working with BOM Sets

Any number of BOM Item grid configurations can be saved - each of these is referred to as a BOM Set. After configuring the grid to your requirements, click the Add button in the BOM Sets region of the ActiveBOM Properties panel to add a BOM Set to the list.

Click the eye icon to enable a BOM Set.
Click the eye icon to enable a BOM Set.

BOM Sets are configured in the ActiveBOM Properties panel.

The preferred BOM Set can be selected during BOM generation in the Report Manager.

Replacing a Component

It's not uncommon to identify an issue with a component when the BomDoc is being checked and made ready for ordering the parts. For example, the designer may have forgotten to finalize the selection of a component, or a component has gone EOL and the designer wants to explore the price and availability of potential replacements. Previously the only way to resolve this was to return to the schematic and edit the component, select a suitable part, then refresh the BomDoc.

Alternatively, you can change a component in the BomDoc, and then pushing that change back to the schematic via an Engineering Change Order. Right-click on the selected component(s) and select the Operations » Change <ComponentName> command. The Replace Component dialog will open, where the replacement component can be searched for.

An existing part can be replaced via the right-click menu The Replace Component dialog is used to replace an existing component

When the Replace Component OK button is clicked the Engineering Change Order dialog will open, detailing the changes needed to synchronize the schematic with the BomDoc.

  • The Replace Component feature searches for a new component in the currently connected Workspace. If a suitable component is not returned by your search, the dialog will display a link to open the Manufacturer Part Search panel, where you can right-click and either: Acquire the component to your own Workspace (via the Create New Component dialog and Component Editor); or Download the component locally as an Integrated Library Package in a zip archive. These commands will only be available if the part you choose in the Manufacturer Part Search panel includes Altium Designer models (look for the Icon that displays when a part includes schematic and PCB design models icon).
  • As an alternative to using the Search, Categories and Filters features in the Replace Component dialog, you can also right-click on a result and access the Find Similar Components dialog. The power of this dialog is that it takes the values of the component you right-clicked on and based on that, you can quickly locate multiple components that share common properties and parameters, over a range of values (show image).
  • If the component change also affects the board design, an Update PCB should also be performed from the schematic.

Learn more about Applying the ECOs.

Working with Variants

ActiveBOM supports PCB projects that include Design Variants. The Design Variants feature allows a single base PCB design to be created, which is then populated (loaded) in different ways. Each different loading of the assembled board is called a design variant.

Working with Design Variants:

  • Design variants are configured in the Variant Management dialog or the Variant Manager (Project » Variants).
  • To examine a variant, double-click on its name in the project's Variants folder in the Projects panel, as shown in the image below.

Image showing how to select a variant of the project

ActiveBOM supports variants in the following ways:

  • Display the BOM for a specific variant in Base view mode or Flat view mode
  • Option to include the Not Fitted items in the BOM Items list
  • Display a consolidated list of all parts used in all variants, in Consolidated view mode
  • Define manual solutions for both base components and varied components

Variants in Base View Mode

For the selected variant, enable the Show Not Fitted option in the Properties panel to include these parts in the BOM Items grid. When this option is enabled, the Fitted column is automatically displayed in the Item Details.

In Base view mode the Fitted column will display either Fitted or Not Fitted. If a part is varied (an alternate part was chosen in this variant), the details of the alternate part are automatically displayed for that BOM Item.

Note that the current variant is displayed in the ActiveBOM status line.
Note that the current variant is displayed in the ActiveBOM status line.

Variants in Consolidated View Mode

The Consolidated view mode displays all components used in all variants. The Consolidated view offers the following features:

  • If a component is varied, there will be a BOM Item for each alternate component that is used, with each of these BOM Items having the same designator. For example, in the image below, components DS1 and DS2 are each list twice, as the BGA variant uses a different colored LED from the TSOP variant. Component R1 appears three times because both the BGA and TSOP variants use a different resistor than the original in the base design.
  • In Consolidated view mode, when the Show Not Fitted option is enabled the Fitted column will display Fitted or Varied. Because the Consolidated view shows all components used in all variants, every component displayed is fitted in either the base or a variant.
  • For each variant, there is a <VariantName> - Qty column (indicating how many of this component are used in this variant) and a <VariantName> - Price column, which is the unit price times the value in the quantity column.
  • Because some designers create build documentation off the base design as well as the variants, there is also a Quantity column, reflecting the number of instances of this component used in a build of the base design. Hide this column if you do not generate build documentation off the base design.
  • The grid in Consolidated view mode uses color to indicate a cell whose value is different from that cell's value in the base design, as shown below.

Color in a cell indicates that the value in this cell is different from the value for that cell in the base design.
Color in a cell indicates that the value in this cell is different from the value for that cell in the base design.

To learn more about variants, refer to the Design Variants page.

Working Between the BomDoc, the Schematic and the PCB

There are two features available to help you work between the BomDoc, the schematic and the PCB design: Cross Select and Cross Probe. The behavior of these features is configured in the System - Navigation page of the Preferences dialog.

Both of these features can be used to locate the same component in other documents. The difference between Cross Select and Cross Probe is that Cross Select Mode selects the component in the target document but does not actively present that document, whereas Cross Probe actively presents the target document, and can also switch and make the target document's editor the active editor.

You can Cross Select or Cross Probe from the BomDoc to the schematic and PCB, you can not Cross Select or Cross Probe from the schematic or PCB, to the BomDoc.

Cross Select Mode

Cross Select Mode must be enabled in each editor in which you wish to use it. Select the Tools » Cross Select Mode command (Shift+Ctrl+X). When Cross Select Mode is enabled the menu icon will be highlighted with an outline Cross Select icon, displays in the Tools menu when Cross Selection is enabled in an editor.

Cross Select Mode requires the target document to be open. When you select a component in the BOM Items list of the BomDoc, that component will be selected and centered in the target schematic and PCB documents (if Zooming is enabled in the Cross Select Mode options on the System - Navigation page of the Preferences dialog). Note that the target document will not present as the active document.

If the BomDoc is in Base view mode, then all instances of that part are selected on the schematic and PCB, as shown in the image below.

Cross Select Mode display behavior is controlled using the Cross Select Mode options on the System - Navigation page of the Preferences dialog.

The target document will not be made the active document. It is therefore a good idea to have both source and target documents open side-by-side.

Cross selection from the schematic (or PCB) to the BomDoc is also supported.

Use the Cross Select feature to locate and select the component chosen in the BOM Item list, in the schematic and on the PCB.
Use the Cross Select feature to locate and select the component chosen in the BOM Item list, in the schematic and on the PCB.

Cross Probing

Where Cross Select is simply a mode, which when enabled, displays the result each time you click in the BOM Items list, Cross Probe is a deliberate action.

Choose the Tools » Cross Probe command from the main menus or right-click on a BOM Item and select Cross Probe from the context menu to cross probe to that component on the schematic, the PCB component will also be cross probed to if the board file is open.

A key feature of Cross Probe is the ability to switch to the target document's editor. To Cross Probe and switch editors, hold the Ctrl key as you select the Cross Probe command.

Right-click to access the Cross Probe command, there will be an entry for the designator of each component present in that BOM Item.
Right-click to access the Cross Probe command, there will be an entry for the designator of each component present in that BOM Item.

During Cross Probing, it is more efficient to have the BomDoc (source) and schematic (target) documents displayed side-by-side, either by splitting the main design window, or opening the schematic in a new window. Commands for both of these are available in the document tab right-click menu.

Properties Panel

When the active document is a BOM document (*.BomDoc), the Properties panel presents the Document Options.

The following collapsible sections contain information about the options and controls available:

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

The features available depend on your Altium product access level. Compare features included in the various levels of Altium Designer Software Subscription and functionality delivered through applications provided by the Altium 365 platform.

If you don’t see a discussed feature in your software, contact Altium Sales to find out more.

Content