====== Parts list ======
The parts list is a central element in product data management.

It describes the complete composition of a product and lists the components required for it. This makes it an essential basis for manufacturing companies. Parts lists are important for areas such as production control, parts procurement, quality control and product liability, as they ensure that the right components are installed and that the right materials are procured, stored and provided (see also //[[https://de.wikipedia.org/wiki/St%C3%BCckliste|Wikipedia: parts list]]//).

The parts list module //[[https://speedy-pdm.de/module/speedybom|speedyBOM]]// of speedyPDM automatically adopts parts lists that are created in CAD applications from 2D designs or 3D models. In addition, parts lists can also be manually assigned to an article if required.

__**Important functions of the parts list module**__
  * Automatic creation of parts lists from CAD data
  * Support of different display types:
    * Normal parts list (modular parts list)
    * Sum parts list
    * Structured parts list
  * Predefined filtered parts lists (e.g. purchased parts list, spare parts list, ...)
  * Flexible filter options via column filters
  * Export to various formats (Microsoft® Excel, PDF, ...) or direct print output
  * Automated export on status change (e.g. for transfer to an ERP system)
  * Output of parts lists as modular, structured or totalised parts lists
  * Option for customised formatting

----

===== Edit parts list =====
**Ribbon bar: Parts list ⇒ Edit**\\
**Document list: Context menu ⇒ Parts list ⇒ Edit**\\
**Document list: Double-click on the parts list symbol**\\
**Structure: Context menu ⇒ Parts list ⇒ Edit**

[{{speedy:stueckliste:dwbom.png?450|Parts list window with navigation area}}] \\
If the parts list is called up in the context of a specific document, the parts list dialogue only displays the parts list of this document. If, on the other hand, the parts list is called up without a selected document or in the context of a container, all documents with parts lists from the selected folder structure are displayed in the parts list dialogue.

==== Structure area ====
The hierarchical parts list structure is displayed in the structure area.\\
The system assembly is at the highest level and is displayed in bold type. Assemblies that are neither installed in the system assembly nor in a sub-assembly and are therefore not part of the hierarchy are also displayed at the top level, but are labelled with a thin font.\\

Via the tab //**"View" tab**// tab to show or hide the structure area and preview window. The functions //**"Expand**// and //**Collapse"**// functions are only available if the selected assembly contains a structure with subassemblies.

In addition, all documents with their associated parts lists can also be displayed in the structure area in the context of a container.
[{{speedy:stueckliste:baumstruktur_stuecklistenfunktion.png?nolink|}}]

==== Parts list area ====
The parts list area displays the parts list selected in the structure area. \\
Tabs are available in the lower area which can be used to switch between different parts list types. For a better overview, additional information is highlighted using different text or background colours:

^Colour ^Meaning ^
|<color /#90EE90>Light green</color>  |Line grouping          |
|<color #FF0000>Red colour</color>        |Invalid or non-existent document (error message)          |
|<color /#DCDCDC>Light grey</color>  |Write-protected property          |
|<color /#FFC0CB>Light pink</color>  |Properties in the parts list differ from the article master        |
|<color /#DCD8F8>Light blue</color>  |Manual position          |
|<color /#00FFFF>Light cyan</color>  |Standard or norm part (e.g. toolbox or content centre), not managed  |
|<color /#FFFF00>Light yellow</color>  |Semi-finished welded part      |
|<color /#C0C0C0>Grey</color>      |Released article         |
|<color /#FF0000>Red</color>       |Withdrawn release         |

==== Preview ====
All files and the preview image of the selected item are displayed in the preview window. In addition, a tooltip with a model preview can be displayed by holding down the centre mouse button over an item. It is not necessary to select the item beforehand.

==== Search ====
**Ribbon bar (parts list): Parts list ⇒ Search**\\
**Menu bar (parts list): Search input field**

The parts list search allows you to search through all the displayed properties of the parts list items using a number of filters. The search input field can also be used to perform a quick search using these properties.\\
It is also possible to search directly in the columns and to set column filters.

==== Column description and language ====
The display and definition of the columns can be specified via a column description. This allows different column descriptions to be used for a parts list type in order to display the desired view. The selection is made in the //**"View" tab**// in the //**"Table"**// or via the quick selection at the top right.\\

In addition, the output language of the parts list can be customised by selecting a different language.
[{{speedy:stueckliste:dwbom_coldesc.jpg|}}]

==== Edit assembly properties ====
**Ribbon bar (parts list): Parts list ⇒ Properties / Assembly properties**\\
**Structure (parts list): Context menu ⇒ Item properties**

Opens the item properties of the selected assembly for editing.

==== Edit item properties of the item ====
**Ribbon bar (parts list): Parts list ⇒ Item properties**\\
**Parts list area: Double-click on parts list item**\\
**Parts list area: Context menu ⇒ Edit item properties of the parts list item**\\
**Parts list area: Direct editing in the properties field**

Opens the item properties of the selected document from the parts list.

==== Edit properties of the parts list item ====
**Ribbon bar (parts list): Parts list ⇒ Item properties**\\
**Parts list area: Context menu ⇒ Edit item**

Properties of parts list items such as **item number** and **quantity** can be customised at any time as standard. In addition, further BOM-related properties can be added administratively. CAD-specific configuration parameters can be added in the //**"CAD" TAB**// tab.

==== Add manual parts list item ====
**Ribbon bar (parts list): Parts list ⇒ New item**\\
**Parts list area: Context menu ⇒ New item**

Via the function //**"New item" function**// function can be used to add manual parts list items. There are three options to choose from:
  * **Manual item**
  * **speedy Document**
  * **New document**

[{{speedy:stueckliste:dwbom_newposition.png?400|}}]\\
In addition, manual BOM items can also be added in a simpler and faster way:
  * __**Drag & Drop**__\\ The desired document via **drag & drop** from the document list into the parts list area. This automatically creates a new manual parts list item.\\

  * __**Double-click**__\\ Alternatively, by holding down **[Ctrl]**-key and **double-click** on a desired document in the document list. A new manual parts list item is also automatically created here.

==== Parts list views ====
**Ribbon bar: Parts list ⇒ Show articles / Show all articles / Show article structure**\\
**Document list: Context menu ⇒ Parts list ⇒ Show articles / Show all articles / Show article structure**\\

When working with assembly structures, it can be helpful to display the items in a parts list directly as a search result. In this case, the speedyPDM parts list is not opened. Instead, an overview of the items installed in the respective version is displayed in the document list. Three different views are available for this:
[{{speedy:stueckliste:stuecklisten_anzeigen.jpg?|}}]\\

^ View  ^ Description  ^
| Show articles          | Shows all items of the first level of an assembly          |
| Show all articles      | Shows all articles in the summarised parts list of an assembly          |
| Show article structure  | Shows all articles of the entire parts list structure of an assembly  |

<WRAP left important 100%>\\
Released items can only be opened for viewing in a parts list view, but cannot be edited. When opening a released item, a message appears informing you that changes can only be made in the item's storage location.</WRAP>
----

===== Export =====
**Ribbon bar: Parts list ⇒ Print / Save**\\
**Document list: Context menu ⇒ Parts list ⇒ Print / Save**\\
**Ribbon bar (parts list): File ⇒ Export / Save as / Print**

There are various options for exporting parts lists:
  * **Export**\\ The parts list is exported based on a previously defined export description.
    * The export description is defined administratively (see //[[speedy:40_admin:io|Input/output description]]//).
    * It is necessary for the export description to be //**"bom"**// in the name so that it is available for selection.
    * Depending on the administrative default, either a file name can be specified or this is already defined by the export description.
  
  * **Save as**\\ The parts list is saved to an Excel file, for example, using the current column description and the specified output language. You will be prompted to specify a file name and a file type.
  
  * **Print**\\ The parts list can be printed using conventional printers. The output on paper is as defined in the print template.
  
  * **Multiple printing**\\ All parts lists in the dialogue can be printed simultaneously or after selection with conventional printers. The output on paper is as defined in the print template.

^File type  ^Meaning  ^
|.pdf      |Portable Document Format        |
|.csv      |Comma Separated Value\\ Comma-separated value table, can be read by Excel.                                |
|.xlsx       |Excel workbook\\ Excel (version 9 or higher) must be installed on the workstation.                            |
|.rptsnp       |Report snapshot in Ascii format\\ Customised file format for saving printouts.                                     |
|.rptsnx       |Report snapshot in binary format\\ Own file format for saving printouts.                                     |
|.tif / .tiff  |Tagged Image File Format\\ TIFF file with several pages, e.g. used for faxing or long-term archiving.  |
|.xml      |Extensible Markup Language          |
|.bom      |Byte Order Mark      |

----

===== Import =====
The parts list import allows you to import either individual parts list items or complete parts lists. The decisive factor here is how the parts list was created. \\

__**Parts list was created manually**__\\
If a parts list was created manually, either the entire parts list can be imported (this overwrites the existing parts list) or the imported items are added at the end. \\

__**Parts list was created by a CAD application**__\\
In this case, speedyPDM can only add the items to the existing parts list as manual items. \\ \\

-> A parts list import is always based on an import description (see [[speedy:40_admin:io|Input/output description]]). \\
-> The assignment of the values to be imported to the item properties is defined by the import description. \\
-> The import description can already specify the file type (e.g. .xml, .csv, etc.). \\
-> For the import description, it is necessary that it is //**"bom"**// in the name so that it is available for selection.

When importing from a .csv file, the 1st line should contain the names of the columns. The 2nd line should contain the parts list header. The actual items therefore start from the 3rd line. \\

=== XML import ===
In order to import parts lists in XML format, they must either already correspond to the speedyPDM import format or be converted to this format.\\
With the help of XSL, XML files can be converted into other formats or structures. The speedy import can perform this conversion automatically during import. Only one XSL file needs to be created in the directory **...speedy_bin$\config** whose name matches the import description. \\

Example of an XML parts list file:
<code xml>
<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
<speedy>
    <data>
       <bom>
           <head>
              <bom_docno>0210-BG-0000189</bom_docno>
              <bom_pos></bom_pos>
              <bom_qty></bom_qty>
           </head>
           <position>
              <bom_docno>$:0210-ET-0000669:1</bom_docno>
              <bom_pos>1</bom_pos>
              <bom_qty>1</bom_qty>
           </position>
        </bom>
    </data>
</speedy>
</code>

----

===== Bill of material =====
**Ribbon: Bill of material >> Bill of material type >> Sum BOM on / off**

By selecting the command //**"Sum BOM" command**// command, the current list view is displayed as a quantity BOM or assembly BOM.
The quantity BOM summarises all items starting from the current assembly including all sub-assemblies. 
Normally, a quantity BOM only contains the individual parts of the assemblies and sub-assemblies installed in each case, but if an assembly does not contain any individual parts, the assembly itself is listed in the quantity BOM.
The assembly BOM only shows the items that are contained in the currently selected assembly.

===== Child component list =====
**Toolbox Child component list on / off** {{speedy:stueckliste:cmdbomshowchild.jpg?25|}}

By selecting the command //**"Child component list" command**// the current list view is displayed as a child component list or assembly parts list. The child component list totals all items starting from the current assembly including all sub-assemblies depending on the child component switch in SolidWorks.
----
===== Compare parts lists =====
**Ribbon: Parts list >> Compare**

In speedyPDM there is the possibility to compare parts lists with each other. To do this, either select an assembly in the document list to compare the versions or two assemblies to compare them with each other. 
[{{speedy:30_modules:bomcompare.jpg?|}}]

=== Navigation area ===
The navigation area displays the parts list structure. The items result from the parts list items of the individual assemblies. These are compared and contrasted with each other. If the same item is installed on the left and right, an equals sign (=) is displayed in the centre. If a value of the assembly is incorrect, this value is highlighted in red and an unequal sign (≠) is displayed in the centre. If the items on the left and right are completely different, the entire line is highlighted in red. \\
If a parts list item is only on one side, an arrow is displayed in the centre.

=== Filter ===
The list can be filtered using the buttons in the ribbon bar. These filters affect the result of the parts list comparison.

=== Export ===
The parts list comparison offers two options for exporting the list:
    - **Save as...** --> The parts list comparison is exported to an .xlsx file (Excel).
    - **Print** --> The parts list comparison can be printed using the normal printer. It is also possible to print the whole thing to a PDF file.

=== Sorting ===
Sorting can be used to set whether the comparison should be made according to the item numbers or the articles.

=== Settings ===
For the parts list comparison to work correctly, a column description //**"BomTableCompare"**// must be created. This column description is used to set which columns are analysed and displayed on the left and right.
----

===== Parts list display =====
The parts list structure is defined by a [[speedy:40_admin:coldesc|column description]]. Special field formatting can be used for the parts list:
  * **Barcode**
  * **QR code**
  * **Thumbnail**

=== Barcode ===
To specify a barcode for an item in the printout of the parts list, define a text with the barcode formatting in the column description of the corresponding cell (see also [[speedy:40_admin:coldesc#barcode|Column description barcode]]):
<code>barcode={wert, encoding [, penwidth] [, row-height-scale] }</code>

^Formatting^Description^
|value |Value to be displayed as a barcode (e.g. document number) |
|encoding |Barcode type |
|penwidth |Smallest line width, default value = 1 (optional) |
|row-height-scale |Scaling of the row height. The row height is calculated from the column width / row height scaling, default value = 4 (optional) |
 \\

Example of cell property in the column description:
<code>=STRCAT('barcode={', $dm_docno, ', code128a, 2, 8}');</code>

The type of the column must be set to //**"Formula"**// must be set. The barcode of the document number is now entered in the column in the //**"Code128a"**// is displayed. \\

The following barcode types are available:
^Encoding^Type description^
|code39 |Code 39 |
|i25 |Interleaved 2 of 5 (only digits) |
|code93 |Code 93 |
|code128 \\ code128a|Code 128 (a,b,c: autoselection) |
|code128b |Code 128b (full printable ascii) |
|code128c |Code 128c (compact form for digits) |
|ean |EAN |

=== QR code ===
To specify a QR code for an item in the printout of the parts list, define a text with the QR code formatting in the column description of the corresponding cell (see also [[speedy:40_admin:coldesc#qr-code|Column description-QR code]]):
<code>qrcode={wert[,version, ecLeve, encodeMode, casesensitive]}</code> \\

The column type must be set to //**"Formula"**// must be set. Example of cell property in the column description:
<code>=STRCAT('qrcode={', $dm_docno, '}');</code> 

The QR code of the document number is now displayed in the column.

=== Thumbnail ===
A column can display a small preview of the CAD model or drawing, for example. For this purpose, the image formatting is specified in the column (see also [[speedy:40_admin:coldesc#thumbnail|Column description-Thumbnail]]):
<code>image={dateiname[,stretch,alignment,transparent]}</code>

^Value^Description^
|filename |Full path of the file |
|stretch |Should the image be adapted to the cell size 0 or 1, default value = 1. This value should always be 1. |
|alignment |Horizontal and vertical alignment of the image within the cell: \\ Top = 0 \\ Left = 0 \\ Horizontally centred = 1 \\ Right = 2 \\ Vertically centred = 4 |
|transparent |Defines whether the image should be output as transparent. Default value = 1. The colour of the 1st pixel is used as the background colour. |

Example:
<code>=STRCAT('image={', $dm_fullpath_slddrw, '}');</code>
Displays the preview image of the SolidWorks drawing in the column both in the dialogue and in the printout.

=== Display parts list lines in colour [8.0.1] ===
Lines of assembly parts lists can be individually adjusted in colour depending on the properties of the item using scripting. For this purpose, the respective [[speedy:40_admin:coldesc|column description]]. \\
With the script function //**"OnGetRowBkColor" script function**// script function can be used to adjust the background colour of a row. \\
With the script function //**"OnGetRowTextColor" script function**// script function can be used to adjust the text colour of a row. \\

Both functions have the same structure:
<code vbscript>
Function OnGetRowBkColor(color, dict, dictPos, dictDoc)
   On Error Resume Next
   if dictDoc.Item("ERSATZTEIL")<>"" Or dictPos.Item("ERSATZTEIL")<>"" then
	color = "{255,0,0}"
	OnGetRowBkColor = True
   end if
End Function
</code>

The example returns the colour red if a spare part indicator is stored in the item/document property. If a colour is to be set, the respective function must return True. As in the example, the colour can either be set as RGB text //**"{R,G,B}"**// or as a numerical value.
----

===== Configuration parameters =====
=== Parts list ===
^Key^Description^
|bom.allowzero | Defines whether parts list items that are defined via AutoCAD info points remain in the parts list with the quantity 0 or are removed. Default value:= 1 |
|bom.autosavecolumns | Defines whether changed column widths are noted in the parts list dialogue. |
|bom.autosorted | Automatically sort parts list |
|bom.checkrevisions | If the switch is active, the system checks whether documents with an older revision are included when the parts list is created. |
|bom.sort.properties | Enumeration of document properties that are to be used for sorting in the parts list. \\ e.g: "S_CHARACTERISTIC1;BEN1;BEN2" \\ It is first sorted according to "S_MERKMAL1", if entries are the same, they are sorted according to the 2nd criterion "BEN1", if entries are still the same, they are sorted according to the 3rd criterion, etc. |
|bom.sort.order | Enumeration of the sorting direction (ascending/descending). \\ 1 := Ascending \\ -1 := Descending \\ The same number of numbers must be specified as properties for [bom.sort.properties]. |
|bom.sort.datatypes | Enumeration of data types for the value comparison of the document properties. \\ (string, boolean, integer, double, date, time, datetime) \\ The same number of data types must be specified as properties in [bom.sort.properties]. |
|bom.includehidden | Display invisible parts in the parts list. |
|bom.includesuppressed | Also display suppressed parts in the parts list. |
|bom.import.position.doctype | Document type for position documents if no document type is defined in the import table. |
|bom.import.position.document.autocreate | Automatically creates a document for a position if no document exists for the defined document number. |
|bom.bompos.new.editproperties | Defines whether the properties dialogue is edited directly when manually adding positions. Default value:= 1 |
|bom.bompos.prop_manual | Describes the property fields and any default values for manual parts list items. \\ e.g.: \\ "BEN1=;BEN2=;MATERIAL=;EV_TEIL=E;LAENGE=;" |
|bom.bompos.prop_standard | Describes the property fields and any default values for standard/library parts. |
|bom.bompos.prop_weldment | Describes the property fields and any default values for weldments. |
|bom.bomtable.autorefresh | The parts list display is automatically refreshed after the properties of a parts list item have been changed, for example.|
|bom.bomtable.coldesclang | Language of the column description for parts lists|
|bom.bomtable.coldescname | Column description for parts lists|
|bom.bomtable.coldesctype | Column description type for parts lists|
|bom.bomtable.grouping | Group parts list items by colour.\\ The grouping column is defined in the column description.|
|bom.bomtable.savepath | Default save path for parts list export |
|bom.bomtable.show | Show parts list tab. |
|bom.bomtable.type | Defines the type of parts list that is displayed when the parts list window is opened. The parameter should be deactivated for [view] and [global]. |
|bom.childcomp.coldesclang|Language of the column description for child component lists|
|bom.childcomp.coldescname|Column description for child component lists|
|bom.childcomp.coldesctype|Column description type for child component lists|
|bom.childcomp.grouping|Grouping child component lists|
|bom.childcomp.includehidden|Include invisible parts in child component list; if not defined, bom.includehidden is used|
|bom.childcomp.includesuppressed|Insert suppressed parts in child component list; if not defined bom.includesuppressed is used|
|bom.collected.coldesclang|Column description language for summary BOMs|
|bom.collected.coldescname|Column description for summary BOMs|
|bom.collected.coldesctype|Column description type for summarised BOMs|
|bom.collected.grouping|Grouping BOM items in summarised BOMs|
|bom.collected.includehidden|Include invisible parts in summarised BOMs; if not defined, bom.includehidden is used|
|bom.collected.includesuppressed|Insert suppressed parts in summarised BOM; if not defined bom.includesuppressed is used|
|bom.collected.show|Defines whether the tab should be displayed. \\Default value := 1  |
|bom.collected.properties|A list of properties that are also compared when totalling summary BOMs. Normally, only the document numbers are used when totalling items in order to add up the same items. Further properties can be named in the list, which are also compared and must be identical for items to be totalled. This prevents identical profiles with different lengths being totalled in cutting lists, for example.|
|bom.color.changed| Cell colour for manually changed parts list items. \\ Default value:={255,192,192} (light pink) |
|bom.color.invalid| Line colour for invalid parts list items. \\ Default value:={255,64,64} (red) |
|bom.color.readonly| Line colour for read-only parts list items. \\ Default value:={241,241,241} (light grey) |
|bom.color.released| Line colour for released parts list items. \\ Default value:={211,211,211} (grey) |
|bom.color.rowgroup| Row colour for grouping the parts list items. \\ Default value:={210,255,210} (light green) |
|bom.color.manual| Row colour for manually created parts list items. \\ Default value:={220,220,255} (light blue) |
|bom.color.standard| Line colour for standard/standard parts. \\ Default value:={220,255,255} (light cyan) |
|bom.color.weldment| Line colour for weldment components. \\ Default value:={255,255,220} (light yellow) |
|bom.color.darkratio | Scaling value to make line colours darker if the visual style is dark. \\ Default value:=0.5 |
|bom.dblclick.coldescname|Double-clicking on a parts list item starts the property editing of the item. Depending on the property, either the property of the item or the referenced article is edited. \\ The parameter is used to define whether the name of the column or the properties of the column from the column description should be used for the check. \\ Default value:= 1 |
|bom.edit.ondocumentdosingle| Displays only the parts list of the selected assembly (without the hierarchy of the other assemblies)|
|bom.filterviews | Enumeration of configuration parameters for the definition of filtered parts lists. \\ e.g.: bom.purchase;bom.laserpart; \\ Two further filtered parts list views are displayed in the parts list dialogue. The properties of the views are each defined under the configuration parameters "bom.purchase.*" and "bom.laserpart.*". Further sub-parameters are used to describe a filtered parts list view. See also [[speedy:30_modules:bom#gefilterte_stueckliste|]]\\ The other sub-parameters are created automatically when the settings are saved if they have been specified in the list. |
|bom.head.update.breakonzero| As soon as a position in the column is 0, the total is 0. |
|bom.head.update.properties| Summation of a column when updating the parts list header. |
|bom.maintenance.childcomp.coldesclang| Language of the column description for the child component list in the maintenance plan|
|bom.maintenance.childcomp.coldesctype| Column description type for the child component list in the maintenance plan|
|bom.maintenance.childcomp.grouping| Grouping parts list items of the child component list in the maintenance plan|
|bom.maintenance.childcomp.includehidden| Include invisible parts in the maintenance plan in the child component list; if not defined, bom.includehidden is used|
|bom.maintenance.childcomp.includesuppressed| Include suppressed parts in the maintenance plan in the child component list; if not defined bom.includesuppressed is used|
|bom.maintenance.coldesclang| Language of the column description for maintenance plan|
|bom.maintenance.coldesctype| Column description type for maintenance plan|
|bom.maintenance.coldescname| Column description for the maintenance plan. If not defined, bom.collected.coldescname is used. |
|bom.maintenance.collected.coldesclang| Language of the column description for the bill of materials in the maintenance plan|
|bom.maintenance.collected.coldescname| Column description for the quantity BOM in the maintenance plan|
|bom.maintenance.collected.coldesctype| Column description type for the quantity BOM in the maintenance plan|
|bom.maintenance.collected.grouping| Grouping BOM items in the quantity BOM in the maintenance plan|
|bom.maintenance.collected.includehidden| Include invisible parts in the maintenance plan in the quantity BOM; if not defined, bom.includehidden is used|
|bom.maintenance.collected.includesuppressed| Include suppressed parts in the maintenance plan in the quantity BOM; if not defined bom.includesuppressed is used|
|bom.maintenance.filter| Defines the properties that must be fulfilled by the document for it to appear in the maintenance plan.\\ Filter settings:\\ Property name = Property value\\ Multiple filter properties are separated by a semicolon (;)|
|bom.maintenance.grouping| Group parts list items in the maintenance plan|
|bom.maintenance.includehidden| Include invisible parts in the maintenance plan; if not defined, bom.includehidden is used|
|bom.maintenance.includesuppressed| Insert suppressed parts in the maintenance plan; if not defined bom.includesuppressed is used|
|bom.maintenance.type| Defines the type of parts list that is displayed when the parts list window is opened. The parameter should be deactivated for [view] and [global].|
|bom.maintenance.show| Display maintenance plan tab|
|bom.manual.sortorder|Defines the sort order for sorting the parts list for manual items. The smaller the number, the further forward the documents are sorted.|
|bom.synchronize.syncproperties | Properties that control automatic synchronisation. |
|bom.synchronize.properties | Properties that are synchronised. |
|bom.synchronize.onrelease | Properties that are synchronised on release. |
|bom.print.draft| Watermark text that is printed on non-released parts lists.|
|bom.purchase.filter| Defines the properties that must be fulfilled by the parts list item or document for it to appear in the parts list. \\For more details see [[speedy:30_modules:bom#gefilterte_stueckliste|]] |
|bom.purchase.label| Name of the tab. |
|bom.purchase.show| Defines whether the tab should be displayed. \\Default value:= 1  |
|bom.purchase.type| Defines the type of parts list that is displayed when the parts list window is opened. The parameter should be deactivated for [view] and [global]. |
|bom.save.namepattern| File name pattern for saving the parts list. The pattern contains placeholders that are replaced by document properties\\ (e.g.: %dm_title% - use the title of the assembly document as the file name)|
|bom.save.filterindex| System remembers the file type with which the last files were saved. |
|bom.save.header| Save parts list header as well when saving. |
|bom.save.xml.revision.properties| Remembers the properties that were assigned when an XML file was last saved. |
|bom.showrelease| Parts list only shows released parts. |
|bom.sparepart.autorefresh| Automatically refreshes the parts. |
|bom.sparepart.childcomp.coldesclang| Language of the column description for the child component list in the spare and wear parts list|
|bom.sparepart.childcomp.coldescname| Column description for the child component list in the spare and wear parts list|
|bom.sparepart.childcomp.coldesctype| Column description type for the child component list in the spare and wear parts list|
|bom.sparepart.childcomp.grouping| Grouping parts list items of the child component list in the spare and wear parts list|
|bom.sparepart.childcomp.includehidden| Insert invisible parts of the spare and wear parts list into the child component list; if not defined, bom.includehidden is used|
|bom.sparepart.childcomp.includesuppressed| Insert suppressed parts of the spare and wear parts list into the child component list; if not defined bom.includesuppressed is used|
|bom.sparepart.coldesclang| Language of the column description for spare and wear parts list|
|bom.sparepart.coldescname| Column description for spare and wear parts list|
|bom.sparepart.coldesctype| Column description type for spare and wear parts list|
|bom.sparepart.collected.coldesclang| Language of the column description for the quantity parts list in the spare and wear parts list|
|bom.sparepart.collected.coldescname| Column description for the quantity parts list in the spare and wear parts list|
|bom.sparepart.collected.coldesctype| Column description type for the quantity parts list in the spare and wear parts list|
|bom.sparepart.collected.grouping| Grouping parts list items of the quantity parts list in the spare and wear parts list|
|bom.sparepart.collected.includehidden| Include invisible parts in the spare and wear parts list in the quantity parts list; if not defined, bom.includehidden is used|
|bom.sparepart.collected.includesuppressed| Include suppressed parts in the spare and wear parts list in the quantity parts list; if not defined bom.includesuppressed is used|
|bom.sparepart.filter| Defines the properties that must be fulfilled by the document for it to appear in the maintenance plan.\\ Filter settings:\\ Property name = Property value\\ Multiple filter properties are separated by a semicolon (;)|
|bom.sparepart.grouping| Group parts list items in spare parts list|
|bom.sparepart.includehidden| Include invisible parts in the spare and wear parts list; if not defined, bom.includehidden is used|
|bom.sparepart.includesuppressed| Insert suppressed parts in the spare and wear parts list; if not defined, bom.includesuppressed is used|
|bom.sparepart.show| Show spare parts list tab |
|bom.sparepart.type| Defines the type of parts list that is displayed when the parts list window is opened. The parameter should be deactivated for [view] and [global]. |
|bom.structure.indent|**--**|
|bom.structure.show| Defines whether the tab in the structure parts list should be displayed. Default value := 1 |
|bom.standard.sortorder|Defines the sort order for the parts list sorting for toolbox/content centre items. The smaller the number, the further forward the documents are sorted.|
|bom.type| Defines the type of parts list that is displayed when the parts list window is opened. The parameter should be deactivated for [view] and [global]. |
|bom.warning.hidden| You can set whether a warning should be displayed if there are still invisible parts in the parts list.|
|bom.warning.suppressed| You can set whether a warning should be displayed if there are still suppressed parts in the parts list.|
|bom.weldment.sortorder| Defines the sort order for the parts list sorting for weldment items. The smaller the number, the further forward the documents are sorted.|
|document.propertyview.bomtable | Defines whether the parts list tab is displayed. |

=== Create neutral formats ===
When the status of a document changes, neutral formats of the parts lists can also be created automatically. \\
Parts lists can be created automatically with the following status changes:
  * checkin
  * pendingapproval
  * approve
  * release

^Key^Description^
|document.xxx.bom | A list of settings for neutral format creation. \\ Each line contains information about: \\ Parts list type, column description, file type, parts list extension, filter name, description, language (optional) \\ When using this parameter, the following parameters (xxx.bomfiletype, xxx.bomtype, xxx.bomcoldesc ) have no effect. \\ e.g.: <code>
0;BomTable;.pdf;.bom;;Stückliste;
1;BomTableCollected;.pdf;.bomsum;;Summenstückliste;enu
</code> Selecting the [...] button opens a dialogue for simple input of the parameters. |
|document.xxx.bomfiletype | If the parts list is to be automatically saved as an additional file with the article when the status changes, this parameter is used to define the file type(s). \\ Multiple file types are separated by semicolons. \\ The parts list type(s) is/are saved for each specified file type. \\ e.g. [document.xxx.bomfiletype] = ".pdf"  |
|document.xxx.bomtype | The parameter can be used to control which parts list type is created: \\ 0 := Standard parts list (assembly parts list) \\ 1 := Summed assembly parts list (e.g. interesting for welded parts) \\ 2 := Summed parts lists \\ 3 := Child component parts list \\ 4 := Structural parts list |
|document.xxx.bomcoldesc | Name of the column description to be used for the parts list to be saved. \\ If several types are specified in the [document.xxx.bomtype] parameter, separated by a semicolon, several column descriptions can also be defined. The same number of column descriptions should be defined as BOM types. |
|document.xxx.createlanguagefiles | Create neutral formats in all defined project languages. \\ A project or customer language can be stored in the project folder. By activating this parameter, a corresponding file is created for each stored project language when creating a neutral format.  |

<note important>
If you are working with project languages, you should not use the language setting from the [document.xxx.bom] parameter.
</note>

=== Filtered parts list ===
^Key^Description^
|bom.<filtername>.filter | Defines the properties that must be fulfilled by the parts list item or document for it to appear in the parts list.\\ Filter settings:\\ <code>Eigenschaftsname = Eigenschaftswert</code>  Multiple filter properties are separated by a semicolon (;). \\ \\ Alternatively, a special SQL statement can also be used: \\ SQL{//SQL statement//} \\ The SQL statement itself can contain any placeholders for individual item or document properties: \\ <code>SQL{SELECT ('<BEST1>'<>'' AND '<LAGERORT>'='')} </code> => The item is displayed if the order description 1 has content and the storage location is empty. |
|bom.<filtername>.label | Name of the tab in the parts list window. |
|bom.<filtername>.show | Defines whether the tab is to be displayed in the parts list window. \\ Default value:= 1 |
|bom.<filtername>.type | Defines the type of parts list that is displayed when the parts list window is opened. The parameter should be deactivated for [view] and [global]. \\ For normal filtered parts lists, the administrative default should be 0. \\ However, if the filtered parts list is to be a structured parts list, the value = must be 4, [view] and [global] must be activated. |
|bom.<filtername>.bomtable.coldescname | Column description for the parts list. \\ If not defined, bom.bomtable.coldescname is used. |
|bom.<filtername>.bomtable.coldesctype | Column description type for the parts list. \\ If not defined, bom.bomtable.coldesctype is used. |
|bom.<filtername>.bomtable.coldesclang | Language of the column description for the parts list. \\ If not defined, bom.bomtable.coldesclang is used. |
|bom.<filtername>.bomtable.grouping | Group parts list items by colour.\\ The grouping column is defined in the column description. \\ If not defined, bom.bomtable.grouping is used. |
|bom.<filtername>.bomtable.includesuppressed | Also display suppressed parts in the parts list. \\ If not defined, bom.includesuppressed is used. |
|bom.<filtername>.bomtable.includehidden | Show hidden parts in parts list. \\ If not defined, bom.includehidden is used. |
|bom.<filtername>.collected.coldescname | Column description for the summarised parts list. \\ If not defined, bom.collected.coldescname is used. |
|bom.<filtername>.collected.coldesctype | Column description type for the summarised BOM. \\ If not defined, bom.collected.coldesctype is used. |
|bom.<filtername>.collected.coldesclang | Language of the column description for the summarised BOM. \\ If not defined, bom.collected.coldesclang is used. |
|bom.<filtername>.collected.grouping | Group parts list items by colour.\\ The grouping column is defined in the column description. \\ If not defined, bom.bomtable.grouping is used. |
|bom.<filtername>.collected.includesuppressed | Also display suppressed parts in the summarised parts list. \\ If not defined, bom.includesuppressed is used. |
|bom.<filtername>.collected.includehidden | Display hidden parts in the summarised BOM. \\ If not defined, bom.includehidden is used. |
|bom.<filtername>.childcomp.coldescname | Column description for the child component list. \\ If not defined, bom.childcomp.coldescname is used. |
|bom.<filtername>.childcomp.coldesctype | Column description type for the child component list. \\ If not defined, bom.childcomp.coldesctype is used. |
|bom.<filtername>.childcomp.coldesclang | Language of the column description for the child component list. \\ If not defined, bom.childcomp.coldesclang is used. |
|bom.<filtername>.childcomp.grouping | Group parts list items by colour.\\ The grouping column is defined in the column description. \\ If not defined, bom.bomtable.grouping is used. |
|bom.<filtername>.childcomp.includesuppressed | Also display suppressed parts in the child component list. \\ If not defined, bom.includesuppressed is used. |
|bom.<filtername>.childcomp.includehidden | Show hidden parts in child component list. \\ If not defined, bom.includehidden is used. |