Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Overview

NetBom has configurable report headers for users that want to further modify the web and Excel reports.

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).

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

This is not case-sensitive, and all spaces that are added will be filtered out. 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 to the column names is the SPACER column. This field can be added in place of a header 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.

To add a blank table spacer to your report, use the SPACER column name in your custom report settings.

List of available table column modifiers:

  • WIDTH

  • EDITABLE

  • NO_FILTER

  • FILTER_ORDER

List of available sheet order modifiers:

  • GROUP

Width Modifier

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 width and leave the width calculation up to the web browser. Values outside of this range are unhandled and will produce undefined results.

The default width for columns is calculated by NetBom before the report is created and is based on the contents in all the cells.

In this example, the Comment column has a width of 5 which means it will always use 5% of the total table width.

Editable Modifier

The EDITABLE modifier makes all cells in the column editable (if the report supports editable fields).

The value for the EDITABLE modifier can be 0 or 1.

This setting is disabled by default.

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.

No Filter Modifier

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.

The value for this modifier can be 0 or 1.

The default value for this modifier is 0.

Note: spacer columns are automatically excluded from filtering, so the NO_FILTER modifier will have no effect on them.

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.

Filter Order Modifier

This modifier allows re-ordering of the filter options.

By default, the filter order is the same order as the column headers. The values for this header can be any number, with the lowest number being at the top of the list and going in descending order from there. Columns without a FILTER_ORDER modifier will be at the end of the list in the table header order.

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.

Default Report Settings

This is a snippet of the default report settings file. See below for an explanation of what each line is doing.

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_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 Compare reports.

  • Line 3 marks the beginning of the header and column configuration for the Added Parts report. This ends on line 10, which is the start of the next report configuration.

  • Line 4 configures the A/R column in the Added Parts report. 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.

  • Line 5 has the FILTER_ORDER modifier

  • No labels