Search In: Doc:Documentation: NEXUS Client
Altium DesignerAltium 365Altium MCAD CoDesignerAltium CircuitMakerCompany DashboardAltium On-Prem Enterprise ServerAltium Infrastructure Server
Ver: Version: 1.1
543.23.13.02.12.01.11.0
Close
Search Search on Documentation
Documentation Altium NEXUS Documentation ... Dialog Reference M to R

Report Manager

Created: August 18, 2017 | Updated: March 06, 2024 | Applies to versions: 1.0 and 1.1
Now reading version 1.1. For the latest, read: Report Manager for version 5

This documentation page references Altium NEXUS/NEXUS Client (part of the deployed NEXUS solution), which has been discontinued. All your PCB design, data management and collaboration needs can now be delivered by Altium Designer and a connected Altium 365 Workspace. Check out the FAQs page for more information.

   

                                                

Three variations of the Report Manager dialog

Summary

The Report Manager dialog enables you to configure a Bill of Materials report, or a Component Cross Reference report. You can configure the information for the report and export it in various formats. 

To learn more about preparing the BOM in the Report Manager, refer to the page, BOM Configuration in the Report Manager.

Access

The dialog is accessed in the following ways:

  • For a Bill of Materials report:
    • Select Reports » Bill of Materials from a schematic or PCB document.
    • Select Reports » Bill of Materials from an ActiveBOM document (BomDoc).
    • Double-click on a Bill or Materials that has been added to an OutJob.
    • The dialog is also accessed from the Default Prints tab of the Project Options dialog (Project » Project Options). In the Report Outputs region, click Bill of Materials then click the Configure button. Use this to define the default layout for the first time the Report Manager is accessed in the current project. Once the dialog has been opened using one of the methods mentioned above and the layout changed, that layout setting is retained. Learn more about where the user-defined layout is stored in the BOM Configuration in the Report Manager page.
  • For a Component Cross Reference report:
    • Select Reports » Component Cross Reference from a schematic document.
    • Double-click on a Component Cross Reference Report that has been added to an OutJob.

Options/Controls

Grouped Columns

  • Show - check the Show box to add the desired corresponding data to the grid area.

All Columns

The All Columns section is sourced from the properties of all components on the document (or the source documents if a project is open) for which the report is being generated.

  • Show - Check the Show box to add the desired corresponding data to the grid area.
You also can drag and drop the desired information from All Columns into the Grouped Columns.

Grid 

The displayed data is defined by the checked boxes in the Grouped Columns and All Columns regions. Click the down arrow next to each heading to filter the information in the grid by the desired listed items.

Source Options

  • Include Not Fitted Components - check this option to include components that are not fitted.
  • Include Parameters From PCB - check this option to include parameters from the PCB (e.g., Layer). If it is checked, the parameters will be shown in the All Columns region.
  • Include Parameters From Server- if the component is from a server, select this option to include parameters. If it is checked, the parameters will be shown in the All Columns region.
  • Include Parameters From Database - include (make available) parameters from an external database that is linked (through a DbLink/DbLib/SVNDbLib file) to components in the design. When this option is checked, the database parameters for the matched component records, and that are not part of the Altium NEXUS components, are presented in the All Columns region.
    • Include in Component Variations - check this option to include parameters from any component variations.
  • Include Alternative Items - check this option to include alternative items in the BOM document. If this option is checked, a column titled Alternative Group Name will appear in the grid. This option is available only when the Bill of Materials uses an ActiveBOM (*.BomDoc) as its data source.

Supplier Options

Supplier data is available only when generating a report for the project. It is not available when generating a report for a PCB document.
  • Supplier Currency - use the drop-down to select the desired currency. 
  • Production Quantity - enter the quantity or use the arrows to select the quantity that needs to be ordered to produce the given product quantity.
  • Round up Supplier Order Qty to cheaper price break - the Supplier Order Quantity is used to determine the Supplier Unit Price that applies. Suppliers typically offer various quantity pricing levels depending on how many units of an item you purchase. To have Altium NEXUS round up the Supplier Order Quantity to take advantage of the next (reduced) pricing level, enable this option.
  • Use cached pricing data in parameters if offline - enable this option when working offline to use the last cached pricing data. 

Export Options

  • File Format - select a format from the drop-down list. The following file formats are supported:
    • CSV (Comma Delimited) (*.csv)
    • Microsoft Excel Worksheet (*.xls, *.xlsx, *.xlt, *.xltx)
    • Portable Document Format (*.pdf)
    • Tab Delimited Text (*.txt)
    • Web Page (*.htm, *.html)
    • XML Spreadsheet (*.xml)
  • Add to Project - check to have the generated report added to the project after it is created.
  • Open Exported - check to open the relevant software application, e.g., Microsoft Excel, once the exported file has been saved.

Excel Options

  • Template - enter the desired Excel template file by either typing the file name into the text box, using the drop-down and selecting a template file (*.xlt), or browsing for the template file by clicking ... .

Additional Controls

  • Menu - click to access a menu of options including the following:
    • Export - click to save the generated data to another location.
    • Report - click to open the Report Preview dialog from where you can print the report. 
    • Column Best Fit - click to adjust the column widths to fit the current view.
    • Force Columns to View - click to view all columns automatically. 
    • Restore from - click to restore from the stated BomDoc. This option is available only when the Bill of Materials uses an ActiveBOM (*.BomDoc) as its data source.
    • Change PCB Document - click to change to another PCB document.
    • Change Variant - click to change the variant.
The above controls also are available on the right-click menu accessible from anywhere in the dialog.
  • Export - click to generate the report.
If you find an issue, select the text/image and pressCtrl + Enterto send us your feedback.