...
The report settings file exists in the NETBOM_REPORT_SETTINGS CSET, and if it is not defined the default report settings will be used. When a report is created with the default settings, the settings that were used will be printed to an output file called netbom_report_settings.txt in the output directory (same directory as the generated reports are in).
| Info |
|---|
In order to customize your report settings, point the NETBOM_REPORT_SETTINGS CSET to your custom report settings file. |
Report Settings Modifiers
There are many tweaks that can be done to the reports. As more configuration settings are added, this page will be updated. The syntax for adding modifiers to a column is: COLUMN_NAME::MODIFIER_1=VALUE_1::MODIFIER_2=VALUE_2
...
| Expand | ||
|---|---|---|
| ||
|
| Info |
|---|
In order to customize your report settings, point the NETBOM_REPORT_SETTINGS CSET to your custom report settings file. |
Table Column Order
The table column order and which columns appear are configurable in the report settings file. Column names are converted such as COLUMN_NAME → Column Name. Only the column headers that exist in the default report file are supported (an exception is the Spacer column, see below). The columns can be re-ordered in any configuration (just make sure to keep the same names) and columns can also be removed from view by simply taking them off the list (or commenting them out with the number sign #).
| Note |
|---|
Be careful when removing net name, part number, or single-node columns. These are typically used in the background to support the various web report features. Expect things (such as cross-report linking, cross probing, net tracing, etc) to not work if removing these types of columns. See the HIDE modifier section for a work-around for this. |
Below is an example snippet of the column order for the Added Nets report. The modifiers have been stripped for clarity.
| Code Block |
|---|
ADDED_NETS_HEADERS:
A/R # Column 1 (farthest left)
NEW_NET_NAME # Column 2
NEW_NET_VOLT # Column 3
NEW_NET_NODES # Column 4
COMMENT # Column 5 |
If running a report with these column settings, the A/R column will be farthest to the left and the Comment column will be farthest to the right.
The PARTLIST_INFO report is unique in that any partlist property can be added and displayed in the partlist by simply adding the name of the property to the REPORT_HEADERS section.
Spacer Column
An exception to the column names is the SPACER column. This field can be added in place of a header placed between headers to add an empty column to the report. It takes the same modifiers as a regular table column. For an example, see the default report settings section below.
...
can have modifiers attached to it like a regular header, though the only useful one is the width modifier. This column will not appear in the search filter drop-down.
...
Here is an example of the spacer column being placed between two columns with a width modifier of 1 (see example code in Default Report Settings section).
Report Settings Modifiers
There are many tweaks that can be done to the reports. As more configuration settings are added, this page will be updated. The syntax for adding modifiers to a column is: COLUMN_NAME::MODIFIER_1=VALUE_1::MODIFIER_2=VALUE_2
This is not case-sensitive, and all spaces that are added will be filtered out.
List of available table column modifiers:
WIDTH
EDITABLE
NO_FILTER
FILTER_ORDER
HIDE
List of available sheet order modifiers:
GROUP
Column Modifier: Width
...
When adding the WIDTH modifier to a column, it will force the column to be a specific percentage of the total table width. This is useful when the auto-sizing that NetBom does to all reports is not desirable.
Values accepted for this modifier are any whole numbers between 1 and 100, with -1 being an exception that will force NetBom to not use the internally calculated recommended skip calculating width and leave the width calculation up to the web browser. Values outside of this range are unhandled and will produce undefined results.
...
In this example, the Comment column has a width of 5 which means it will always use 5% of the total table width.
Column Modifier: Editable
...
The EDITABLE modifier makes all cells in the column editable (if the report supports editable fields).
...
In this example, the Old Net Volt column has the editable modifier set to 1, so the report will allow editing in all of this column's cells.
Column Modifier: No Filter
...
This modifier removes the column from the search filter list. This is useful for reports that have many columns and/or reports that have columns that aren’t going to be filtered.
...
In this example, the A/R column (behind the drop-down) is not available in the filter drop-down. This is because it has the NO_FILTER modifier set to 1.
Column Modifier: Filter Order
...
This modifier allows re-ordering of the filter options.
...
In this example, the Nodes Added To Net column should be, if using the default order, above the new and old net volt. But because its FILTER_ORDER modifier has been set to 2, it is behind the Net Name column which has the highest FILTER_ORDER value.
Column Modifier: Hide
The HIDE modifier enables columns that are critical for the operation of certain features (typically net name, part number, and single-node columns) to be visually removed from the report without breaking the report. This modifier will also remove the item from the search filter drop-down, so the NO_FILTER modifier will have no effect.
Sheet Modifier: Group
This modifier can be attached to the sheet order configurations to specify which reports should be in which drop-downs.
...
In this example, the Renamed Nets, Added Nets, and Removed Nets reports are assigned to the Net Diffs group.
Below is an example snippet of the sheet order for the Netlist Compare reports.
| Code Block |
|---|
SHEET_ORDER:
RENAMED_NETS::GROUP=NET_DIFFS
ADDED_NETS::GROUP=NET_DIFFS
REMOVED_NETS::GROUP=NET_DIFFS
ADDED_PINS::GROUP=NODE_DIFFS
REMOVED_PINS::GROUP=NODE_DIFFS
ADDED_REMOVED_PINS::GROUP=NODE_DIFFS
MOVED_PINS::GROUP=NODE_DIFFS |
Using this example will produce the screenshot above. Renamed Nets, Added Nets, and Removed Nets will belong to the Net Diffs group, in the order that they appear in the text. The Node Diffs group will contain the Added Pins, Removed Pins, Added Removed Pins, and the Moved Pins reports.
| Tip |
|---|
Group names are fully customizable - any name is fine and any number of different groups can be used. Just remember the naming conversions: GROUP_NAME → Group Name. |
Default Report Settings
This is a snippet of the default report settings file. See below for an explanation of what each line is doing. Some parts have been removed for brevity.
| Note |
|---|
If your NETBOM_REPORT_SETTINGS CSET is blank or contains an invalid file path, NetBom will create and use the default settings, and will make a file containing the default settings it used in the NetBom output directory. |
| Code Block |
|---|
PARTLIST_COMPARE= ADDED_PART_NUMBERS_HEADERS: A/R::NO_FILTER=1::WIDTH=1 NEW_PART_NUMBER::FILTER_ORDER=1 DESCRIPTION::FILTER_ORDER=2 QTY COMMENT::WIDTH=5::EDITABLE=1 CHANGED_PARTS_HEADERS: A/R::NO_FILTER=1::WIDTH=1 REFDES::FILTER_ORDER=3 OLD_PART_NUMBER::FILTER_ORDER=1 OLD_DESCRIPTION::WIDTH=15 OLD_PART_VOLT::EDITABLE=1 OLD_PART_NET_NAMES (...) SPACER::WIDTH=1 NEW_PART_NUMBER::FILTER_ORDER=2 NEW_DESCRIPTION::WIDTH=15 NEW_PART_VOLT::EDITABLE=1 NEW_PART_NET_NAMES(...) COMMENT::WIDTH=5::EDITABLE=1 (...) SHEET_ORDER: ADDED_PARTS::GROUP=PART_DIFFS DELETED_PARTS::GROUP=PART_DIFFS CHANGED_PARTS::GROUP=PART_DIFFS PART_QTY_CHANGE::GROUP=PART_DIFFS PART_NUMBER_CHANGES::GROUP=PART_DIFFS DELETED_PART_NUMBERS::GROUP=PART_DIFFS ADDED_PART_NUMBERS::GROUP=PART_DIFFS PART_(...) PART_PROP_CHANGES::GROUP=PART_DIFFS NETLIST_COMPARE= (...) |
Line 1 has the name of the report. Everything after this line until line 28 (name of next report) will be applied to the
Partlist Comparereports.Line 3 marks the beginning of the header and column configuration for the
Added Partsreport. This ends on line 10, which is the start of the next report configuration.Line 4 configures the
A/Rcolumn in theAdded Partsreport. It has NO_FILTER set to 1, and WIDTH set to 1. This means that this column will not be available in the drop-down filter menu and the width of the column will take up 1% of the total table width. Also, note that this column will be farthest to the left in the table because it is first in the list.Line 5 has the FILTER_ORDER modifier set to 1, which means it will appear at the top of the search filter list and will be the default search option. The following line has the modifier set to 2, so it will be the second in the list.
Line 7 has no modifiers, which means it will appear in the search list in the order it appears in the table and the width will be calculated by NetBom based on the contents of the cells in the column.
Line 8 will be editable because it has the editable modifier set to 1, and the width will be set to 5% of the total table width.
Line 10 marks the end of the
Added Partscolumn and the beginning of theChanged Partscolumn.Line 13 is a blank column spacer with its width set to 1% of the total table width.
Line 19 begins the sheet order and sheet configuration for the
Partlist Comparesheets.Line 20 puts the
Added Partsreport in thePart DiffsGroupLine 22 does the same as line 20, but for the
Part Prop Changesreport.