Interactive HTML BOM Export

The Interactive Bom utility generates a bill of materials with the ability to search for components and locate them on a visual preview of a board using the InteractiveHtmlBom tool on your web browser. It is particularly useful for the hand assembly of prototype boards.

Shortcuts

Default Keys: None

Default Menu: Output

Command: Export Interactive BOM

Locating this option

Available from: Output menu > Interactive BOM option

System Requirements

The generation of the Interactive BOM requires Python 3.8 (or later) to be installed.

If you installing Python 3 for the first time, it is recommended that you select the Add python.exe to PATH option in the installer. This will allow Pulsonix to automatically locate your installation.

How To Use The Interactive BOM Option

An interactive BOM can be generated by using the Interactive BOM option from the Output menu. This option will open a dialog of various settings. Pressing OK will export the bill of materials.

Export Configuration

An output file name can be specified, which will have the .html extension added to it automatically. This field supports the following substitutions:

%f: PCB design file name
%c: PCB Author
%r: PCB Revision
%d: Date of export

This field will default to %f if left empty.

An output folder can be specified. If not specified, the BOM will be saved in the same directory as the PCB design.

If Python has not been added to the PATH environment variable, a path to the Python 3 executable must be specified.

If Compress Export Data is ticked, the file size of the resulting HTML document will be reduced at the expense of a longer export and load time.

If Open When Complete is selected, the BOM will open in your default browser when the export is complete.

Exported Data

Two non-electrical layer classes can optionally be selected as Silkscreen and Fabrication. Text and documentation shapes on these layer classes will be exported in the HTML document and be displayed in green and brown respectively. If is selected, this data will not be exported.

Different types of design items can be omitted from the export entirely by deselecting them in the Exported Data.

Wires, such as the ones used to connect bond pads on chip-on-board designs, can optionally be exported as tracks.

View Settings

You can modify the default Interactive HTML BOM view settings directly in Pulsonix. All of these settings can be changed after exporting when viewing the BOM in a web browser. If an existing file is overwritten when exporting, these settings will not have an effect - the configuration of the original file will be retained.

BOM Table

A comma separated list of check boxes can be specified, which will be added to the BOM table.

A blacklist of component names and component name prefix can be provided. Any components that match this blacklist will not be displayed on the BOM Table.

Name and prefix should be comma separated
Spaces after commas should be omitted unless they are part of the component name (e.g. use R1,R2 instead of R1, R2)
Prefix are marked with asterisk symbols (e.g. R*,C*,LED-*)

Associated parts, mounting holes, free pads and testpoints can be optionally included in the BOM. If they are exported but not included in the BOM, they will still be visible on the board preview.

Configure Attributes

If Configure Attributes is pressed on the Export dialog, a new dialog will be displayed which allows you to configure which columns are available on the BOM table. Once exported, columns can be hidden individually when viewing the BOM.

A “Do Not Populate” (DNP) marker attribute can also be optionally specified. If this field is not , any component with a value that is not empty for the specified attribute will be visible in the design preview but removed from the BOM.