A common approach to BOM generation is to export the BOM data from Altium Designer, into a company-preferred Excel format spreadsheet. The BOM is generated from the Report Manager dialog, which can be accessed from:
ActiveBOM 's Report menuThe schematic and PCB editor's Report menu
A Report Output configured in an OutputJob
The Report Manager's Export Options includes Microsoft Excel Worksheet as an option, when this option is selected a pre-defined Excel template can be selected in the Excel Options dropdown. When the Export button is clicked in the Report Manager , the BOM data is loaded into a new Excel Worksheet, in the format defined in the chosen Excel template.
How Design Data is Mapped in the Excel Template
Copy Link
Copied
Altium Designer data is mapped into the spreadsheet by including special Field and Column statements in the Excel template. The Field statement is used to map a single parameter, for example the Title. The Column statement is used to map per-component parameters, for example each component's designator.
Fields
The Field statement is used to map a single parameter, for example the Title, that is to be displayed at the top of the BOM. The Field declaration is replaced by the passed value, as shown in the images below.
Fields are used in the format:
Field=FieldName
An example would be Field=Currency
Fields should be defined above or below the Column region of the template.
Columns
Column declarations are used to map per-component parameters, for example each component's designator, description, user-defined parameters, and so on. This can also include: line numbers, PCB location data, and custom column data entered into the BomDoc, if there is a BomDoc in the project. The Column declaration in the template is replaced by the ColumnName string, with each row below being populated by that column value for each BOM Item, as shown in the two images below.
Columns are used in the format:
Column=ColumnName
An example would be Column=Designator
Notes:
Each column defined in the template must be displayed in the Report Manager , for that column of data to be transferred.
The data will present in the Excel spreadsheet in the same row order that it has in the Report Manager . Use the Report Manager's column sorting and sub-sorting feature to sort the rows as required.
Several example templates are included with Altium Designer, in the \Templates folder of the installation user-files.
The default template location is configured in the Data Management - Templates page of the Preferences dialog.
Project-level information is typically mapped using the Field = statement, into the header of the BOM document.
Available System Fields
Copy Link
Copied
Field
Description
Currency
The currency chosen in the Supplier Options region of the Report Manager
DataSourceFileName
The filename of the source used for the BOM data.
DataSourceFullPath
The full path + filename of the source used for the BOM data.
GeneratorDescription
For a BOM, this field displays Bill of Materials.
GeneratorName
Name of the generator - BOM when output is generated by the Report Manager.
OutputName
Title of the BOM, as displayed in the Report Manager (excluding the text "For BOM Document [<DataSourceFileName>]").
OutputType
For a BOM, this field displays BOM_PartType.
PCBDataSourceFileName
The filename of the PCB data source.
ProductionQuantity
Production quantity defined in the Report Manager dialog.
ProjectFileName
Name of the PrjPcb file (including file extension).
ProjectFullPath
Full path + the project filename.
ReportDate
Date on which the report was created.
ReportDateTime
Date and time at which the report was created.
ReportTime
Time at which the report was created.
TotalQuantity
Sum of the values in the BOM Items Quantity column.
Title
Title displayed at the top of the BOM Reports dialog.
VariantName
Name of the variant, as defined in the Variant Management dialog.
VersionControl_RevNumber
Current revision of the BomDoc.
VersionControl_ProjFolderRevNumber
Current revision of the project (incremented when a Commit Whole Project is performed).
<UserProjectParameter_n>
Displays the value assigned to the user-defined UserProjectParameter-n.
Mapping Document and Project Parameters
Copy Link
Copied
As well as the Field statements listed above, schematic Document Parameters (both default and user-defined parameters entered in the schematic document's Properties panel) and Project Parameters (Options for PCB Project dialog) can also be used as Fields, or as Columns.
Default Document Parameters
Copy Link
Copied
Address1
Address2
Address3
Address4
ApprovedBy
Author
CheckedBy
CompanyName
ConfigurationParameters
CurrentDate
CurrentTime
Date
DocumentFullPathAndName
DocumentName
DocumentNumber
DrawnBy
Engineer
ImagePath
Index
ModifiedDate
Organization
Revision
Rule
SheetNumber
SheetTotal
Time
If the same parameter exists as both a document parameter and a project parameter, the project parameter takes precedence. If the same document parameter exists in multiple documents, the document parameter that is higher up in the heirarchy takes precedence.
The core region of a BOM is the grid of BOM Items, typically using a row for each component. Each column in this grid represents a component property, such as the designator, value, and so on. Columns are defined by entering the component property/parameter (BOM column heading), in the format:
Column=ColumnName
An example would be Column=Description , or Column=Designator
Column information can be taken from several sources, including:
Component Parameters
Copy Link
Copied
These ColumnNames are available for all components
Comment
ComponentKind
Description
Designator
DesignItemId
Footprint
LibRef
LogicalDesignator
PartType
PhysicalPath
Quantity
UniqueIdName
UniqueIdPath
<UserParameter_n>
PCB Component Data
Copy Link
Copied
PCB component location information can also be included. In order to use these columns, the Include Parameters From PCB option must be enabled in the Report Manager dialog.
Center-X(Mil)
Center-Y(Mil)
Center-X(mm)
Center-Y(mm)
Pad-X(Mil)
Pad-Y(Mil)
Pad-X(mm)
Pad-Y(mm)
Ref-X(Mil)
Ref-Y(Mil)
Ref-X(mm)
Ref-Y(mm)
Layer
Rotation
Supplier Data
Copy Link
Copied
It is possible to retrieve online data from suppliers, and include that into the BOM. Note that these are updated live, and are retrieved when the BOM is generated. Multiple suppliers can be set up for each component . In the table below, these have been described as Supplier Info x - replace x with the appropriate number.
Manufacturer x
Manufacturer Part Number x
Supplier x
Supplier Currency x
Supplier Order Qty x
Supplier Part Number x
Supplier Stock x
Supplier Subtotal x
Supplier Unit Price x
User-Defined Columns
Copy Link
Copied
User-defined columns are includes in the same way:
Column=ColumnName
