The “List Of …” commands are used to report design items. The lists require that other commands are used within them to report specific entities. The indented commands following the “List Of …” command will be repeated for each item in the list.
For example, List of Components could report the Component Name and Footprint Name for each component.
They can also be used within other “List Of …” commands to access items within other items. For example, List of Parts could include a List of Components which would report all components using each part in turn. This command could then include a List of Pins command that would report each pin on the component.
These commands can be found in the middle section of the command list to the left of the Report Maker dialog. Double click on the command, or press the Add button to put a command into the command script.
Editing a “List Of” Command
Double click on a “List Of …” command in the script, or press the Edit button to display the Edit List Command dialog to change the sort criteria to define the order that the items will be reported within the list.
Example use of a “List of” command
List Of Parts
Part Name
End Of Line
List Of Components
Component Name
Footprint Name
List Of Pins
Node Name
End Of Line
The report output looks like this:
006035C102KATDA
C1 SM0603 C1.1 C1.2
C2 SM0603 C2.1 C2.2
RES
R1 R R1.1 R1.2
R2 R R2.1 R2.2
List of Areas
This command will report all the Areas in a design (if used at the top level of the script), or in a particular component (if used within a List of Components command). The following commands are available under a List of Areas command: Alternative Thermal Gap, Board Cutout, Board Plated Cutout, Component Keep, Component Keep Height, Component Pad Keep, Copper Keep Out, Copper Pour Avoid, Drill Keep Out, Micro Via Keep, Mount Hole Keep, Area Name, Power Plane Avoid, Testpoint Keep, Track Keep, Use in Area DRC, Use in Footprint Rules, Via Keep.
List of Ascii File Lines
This command will read and report lines from an Ascii file. The file name and location is set up by editing the command to display the Edit Ascii File Lines Command dialog. This can be used to insert Excel tables into your designs.
List of Associated Parts
This command will report all the Associated Parts in a design (if used at the top level of the script), or attached to a particular component (if used within a List of Components command). See the Associated Parts help page for more details.
List of Attributes
This command will report each attribute on the design (if used at the top level of the script), or each attribute on the current item in turn. When using this command, for each attribute you can report its name, value and (if present) position. It is available on many items that can have attributes, including Designs, Symbols, Parts, Part Pins, Nets, Pins, etc.
List of Attribute Positions
This command will report each design level attribute position in the design (if used at the top level of the script), or each attribute position on the current item in turn. When using this command, for each attribute position you can report its attribute name, value, position and rotation, and also the layer or page it is on and if it is displayed. It is available on many items that can have attribute positions, including Designs, pages, Symbols, Pins, etc.
List of Back Drill Spans
This command will report all the Back Drill spans in a PCB design, used to generate your own manufacturing report or drill table.
List of Boards
This command will report all the boards in a PCB design. Use List of Segments and List of Cutouts within it to report the shape of the board outline.
List of Bond Pads
This command will report all the bond pads on a Component or in a Net.
List of Columns
Available in the PDC context, use this command under a List of Records will report all the columns in a record. The commands available in a List of Columns are Table Name, Field and Value.
List of Components
This command will report all the Components in a design, or that use a specified Part, or are part of a specified Component Group (see below).
List of Component Groups
This command will report groups of components in a design. The criteria for defining which components are members of each Component Group are set up by editing the command to display the Edit Comp Group List Command dialog. Parameters can be defined such that components are in the same group if the value of the parameter (e.g. Footprint name or Value attribute) match. This is very useful when producing parts list reports to divide components that use generic parts into groups that use the same value attribute. For an example of this, see the “Parts List.rff” format file provided with Pulsonix.
List of Cutouts
Use within List of Boards or List of Panel Shapes to report each cutout in a shape. Use List of Segments to report all segments within the cutout.
List of Diff Pair Gaps
Used this command for a Schematic or PCB Design within a List Of Differential Pairs command to report the minimum gaps defined. See the Differential Pairs help page for an example of its use.
List of Differential Pair Chains
At the top level this command will report all the Differential Pair Chains in a PCB or Schematic Design, or use it in a within a List of Nets to report all chains containing nodes on each specified net.
Within this command you can use List of Differential Pairs to report each link in the chain.
See Differential Pair Commands for more details.
List of Differential Pairs
At the top level this command will report all the Differential Pairs in a PCB or Schematic Design, or use it within a List of Differential Pair Chains to report all links in the chain, or use it in a within a List of Nets to report all differential pairs containing nodes on each specified net.
Within this command you can use List of Pin Pairs to report the pads and track lengths in each half of the pair.
See Differential Pair Commands for more details.
List of Doc Symbols
This command is available for Schematic and PCB designs and will list all the Documentation Symbols used. Within this command you can also report various items about the Pad (or pin) and the Pad Attribute. The Pin Count reports the number of pins on a Documentation Symbol.
Within Schematics, all Doc Symbol types can be reported such as Signal References, Testpoints etc. You can refine the reporting of specific Doc Symbols by using the Type command and If.
List of Drill Holes
Use within List of Drill Sizes to report the position of each hole using the current drill size. This enables you to produce a drill output suitable for a NC Drilling machine.
List of Drill Sizes
This will run through a PCB design and report the different drill sizes that are present. This enables you to define your own format drill table report. You can also use it on a layer span to produce a drill table for each layer span in the design.
Within this command you can use List of Drill Holes to produce an output suitable for driving a NC Drilling machine.
List of Errors
This will run through the design and report any error markers that are present. In order that they exist, the markers must have been generated by the Design Rules Checker or the Online DRC options. Various entities of the error markers can be reported, i.e. the Error Description or its Position. When run on a Schematic design, this will report any Electrical Rules Check errors.
List Of Extra Matches
Use within List of Track Length Match Rules or within List of Rules to report extra match strings to be used when gathering items to have their track lengths matched. See Rules for more details.
List of Files
This command will read and report all files in a selected folder. The folder name and location is set up by editing the command to display the Edit Files List Command dialog.
List of Footprint Names
Use this command within a List Of Parts command to list the names of all the footprints that can be used by the part. Use “Is Default” within it to check which is the default to be used by the part.
List of Free Pads
When this command is used for PCB designs and PCB nets it will list all the pads in the design or net, that have been added using Insert Free Pad. This does not include Component pads, vias or Mounting Holes.
Also, you can use this command within a List Of Symbols command to list all pads or pins in the symbol. This can be used for example to list all the pad style names used in a library.
List of Gates
This command will report all the Gates in a Schematic design, on a specified Schematic page, or in a Component.
List of Groups
Use this command to report all the Groups in a PCB or Schematic design, or all Groups that a specific component is in. See Groups for more details.
List of Items
This command can be used to report all the items in a PCB or Schematic group, see Groups for more details. It can also be used to report all items that use an attribute based rule, see Rules for more details.
List of Length Rule Items
Use within List of Track Length Rules to report the name of each net, signal path, sub net, differential pair, and differential pair chain that uses the rule. See Rules for more details.
List of Libraries
This command is only available when running a report on symbol or part libraries. It forces you to report the items in each separate library in turn. If you do not use this, and you are reporting with the library manager dialog for “[All Libraries]” then the items will be processed in the order they appear in the library manager dialog.
List of Layers
This command will report all the layers in a PCB design, and can be used to generate your own manufacturing report. It can also be used to list all layers used in a PCB footprint. It can also be used to list all electrical layers used by a via, allowing you to report what type of item the via is attached to on each layer.
List of Layer Spans
This command will report all the layer spans in a PCB design, used to generate your own manufacturing report or drill table.
List of Match Rule Items
Use within List of Track Length Match Rules to report the name of each net, signal path, sub net, differential pair, and differential pair chain that uses the match rule, i.e all items that will have their track lengths matched. See Rules Commands for more details.
List of Mounting Holes
This command will report all the Mounting Holes in a PCB design, Panel design, in a specified Component or in a specified Net.
Also, you can use this command within a List Of Symbols command to list all mounting holes in a footprint. This can be used for example to list all the pad style names used in a library.
List of Nets
This command will report all the nets in a design, or all nets attached to a specified component. See Net Commands for more details.
List of Pages
This command will report all the pages in a Schematic design, or can be used on a net to report all pages the net appears on.
List of Panel Shapes
This command will report all the special panel shapes in a Panel design. This includes Panel Outlines, Tab-Routs and V-Scores. Use List of Segments and List of Cutouts within it to report the shape of the shape.
Using the commands available under List of Panel Shapes, you can report the shape Type or use it in an If command to differentiate between the three types of panel shape. The values will be “Outline”, “Tab-Rout” or “V-Score”.
List of Part Gates
Use this command within a List Of Parts command, or within a List Of Representations, command to report information on each gate in the part or representation. The parts may be in a design, or in a parts library.
List of Part Pins
Use this command within a List Of Part Gates command to report information on each pin in the gate. The parts may be in a design, or in a parts library.
List of Parts
This command will report all the Parts in a design, or if used within a List Of Libraries command it will report all Parts in the library, or if used at the top level from the parts manager it will report all Parts in the library manager list.
It can also be used within a List of Vault Folders to report all parts that belong in a folder, or if used at the top level of the format script from the Vault Browser it will report all parts in the current vault browser search results, or from the selected vault folder, or from the entire vault.
List of PCB Instances
This command will report all the PCB Instances in a Panel design. Using the commands available under List of PCB Instances, you can report the PCB Design Path, PCB Design Name and PCB Instance Name, as well as the position and rotation of each instance.
List of Pins
This command will report all the component pins in a component, gate, net or sub net.
List of Pin Pairs
Use this command for a PCB Design within a List of Nets command to report all unique component pin pairs in a net. See the Track Length help page for an example of its use.
Use this command for a Schematic or PCB Design within a List Of Signal Paths command to report each pin pairs in the path.
Use this command for a Schematic or PCB Design within a List Of Differential Pairs command to report the two pin pairs in the differential pair, or chain.
List of Records
Available in the PDC context, this command will report all the records in the specified table using the currently setup PDC database connection. You can configure the table and criteria by editing this command which will open the Edit PDC Record Command dialog. Using the List of Records the Table Name and Value commands are available.
List of Representations
Use this command within a List Of Parts command to report information on each representation in the part. The parts may be in a design, or in a parts library.
List of Rules
Used at the top level, this command will report all attribute based Rules in a PCB or Schematic design. Use within List of Nets, List of Signal Paths, List of Sub Nets, List of Differential Pairs and List of Differential Pair Chains to list all rules applying to each item.
Use List of Items within it to report the names of items that use each rule. See Rules Commands for more details.
List of Segments
Use this command within a List of Boards, List of Cutouts or List of Panel Shapes command to report information about each segment in the current shape or cutout.
List of Signal Paths
At the top level this command will report all the Signal Paths in a PCB or Schematic Design, or use it within a List of Nets to report all signal paths containing nodes on each specified net.
Within this command you can use List of Pin Pairs to report the pairs of pins in each signal path.
See Signal Path Commands for more details.
List of Star Points
This command will report all the Star Points in a design, on a page or on a net. For each Star Point you can report its Name and use the Net field to report a string showing all nets that the star point joins, or use List of Nets to report each net yourself.
List of Sub Nets
At the top level this command will report all the Sub Nets in a PCB or Schematic Design, or use it within a List of Nets to report all sub nets in each net in turn.
Within this command you can report details about the sub net (name, net name, track length, via count, etc.), also you can use List of Pins to report the names of pins in the sub net. See Sub Net Commands for more details.
List of Symbols
Use this command within a List of Libraries command to report all all symbols within the current schematic or documentation library, or all footprints within the current PCB footprint library. If used at the top level on a report run from the library manager, it will report all the symbols or footprints in the current library manager list. If used at the top level on a design it will report all schematic symbols in the design, or footprints in a PCB design.
List of Symbol Names
Use this command within a List Of Part Gates command to list the names of all the alternate schematic symbols that can be used by the part gate. Use “Is Default” within it to check which is the default to be used by the part gate.
List of Tables
Available in the PDC context, use this command to list the available tables in the current PDC database connection. In a List of Tables the Table Name command is available.
List of Testpoints
This command will report all the Testpoints in a design.
List of Tracks
Available in a PCB Design, this command provides details of the tracks present in the design. It is also accessible within List of Nets.
List of Track Length Rules
Used at the top level, this command will report all Track Length Rules in a PCB or Schematic design. Use within List of Nets, List of Signal Paths, List of Sub Nets, List of Differential Pairs and List of Differential Pair Chains to list all track length rules applying to each item.
Use List of Length Items within it to report the names of items that use each rule. See Rules Commands for more details.
List of Track Length Match Rules
Used at the top level, this command will report all Track Length Match Rules in a PCB or Schematic design. Use within List of Nets, List of Signal Paths, List of Sub Nets, List of Differential Pairs and List of Differential Pair Chains to list all track length match rules applying to each item.
Use List of Match Items within it to report the names of items that use each rule, i.e the items that will have their track lengths matched. See Rules Commands for more details.
List of Unfitted Components
This command will report all the unfitted Components in a design, or that use a specified Part, or are part of a specified Component Group (see List of Component Groups).
List of Variants
Using this command, you can report various items on Variants. Variants can be listed for a design or when reporting a Component or a design level Attribute. This applies to both Schematics and PCB.
Within the items available under List of Variants, you can report Variant Name and Variant Description. These are taken from the Variants Manager dialog as defined by you.
List of Vias
When this command is used for PCB designs, Components and PCB nets it will list all the vias in the design, component or net.
Also, you can use this command within a List Of Symbols command to list all vias in the footprint. This can be used for example to list all the pad style names used in a library.
List of Vault Folders
Use this command at the top level of the format script from the Vault Browser to report all the virtual vault folders.
See Vault Commands for more details.
List of Vault Items
Use this command within a List of Vault Folders to report all vault items of a specified type that belong in a folder, or if used at the top level of the format script from the Vault Browser it will report all vault items of a specified type in the current vault browser search results, or from the selected vault folder, or from the entire vault.
See Vault Commands for more details.
List of Vault Item Attributes
Use this command within a List of Vault Items to report for each item its attributes that have been made accessible in the vault for reporting and searching.
See Vault Commands for more details.
List of Vault Item Audit Entries
Use this command within a List of Vault Items to report the audit trail of actions on each vault item.
See Vault Commands for more details.
List of Vault Item Revisions
Use this command within a List of Vault Items to report all the different revisions of each vault item.
See Vault Commands for more details.
List of Vault Symbols
Use this command within a List of Vault Folders to report all symbols of a specified type that belong in a folder, or if used at the top level of the format script from the Vault Browser it will report all symbols of a specified type in the current vault browser search results, or from the selected vault folder, or from the entire vault.
See Vault Commands for more details.
List of Wires
This command will report all the Wires in a PCB design or within a PCB net. The wires reported will be for jumpers and ‘free’ wires, and wires attached to bond and die pads when used in the Chip Packaging Toolkit.
Related Topics
Commands | Edit List Command | Report Maker | Rules Commands | Vault Commands