inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-06-17 04:35:36 +00:00
Code Activity

Reference docs (#308)

Browse Source 
* Add information on build order reference

* Add reference field description for purchase order

* Add reference information for SalesOrder

* Updated images for build orders

* Update settings information

* Add note regarding python string formatting

* Add some more screenshots

* Improved BOM documentation

* Improve BOM documentation further

* Split  "BOM Export" onto separate page

* Rearrange docs pages

* Add image to fill TODO entry

* Split out part scheduling page
This commit is contained in:
Oliver
2022-07-09 22:28:12 +10:00
committed by GitHub
parent e143c2ab12
commit f2a9404c8a
25 changed files with 241 additions and 85 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
docs/build/bom.md vendored
View File

@ -98,55 +98,10 @@ The `Edit BOM Item Substitutes` form will be displayed:
Select a part in the list and click on "Add Substitute" button to confirm.
### Upload BOM
Uploading a BOM to InvenTree is a three steps process:
1. upload BOM file
0. select matching InvenTree fields
0. select matching InvenTree parts.
To upload a BOM file, navigate to the part/assembly detail page then click on the "BOM" tab. On top of the tab view, click on the <span class='fas fa-edit'></span> icon then, after the page reloads, click on the <span class='fas fa-file-upload'></span> icon.
The following view will load:
{% with id="bom_upload_file", url="build/bom_upload_file.png", description="BOM Upload View" %}
{% include 'img.html' %}
{% endwith %}
#### Upload BOM File
Click on the "Choose File" button, select your BOM file when prompted then click on the "Upload File" button.
!!! info "BOM Formats"
The following BOM file formats are supported: CSV, TSV, XLS, XLSX, JSON and YAML
#### Select Fields
Once the BOM file is uploaded, the following view will load:
{% with id="bom_select_fields", url="build/bom_select_fields.png", description="Select Fields View" %}
{% include 'img.html' %}
{% endwith %}
InvenTree will attempt to automatically match the BOM file columns with InvenTree part fields. `Part_Name` is a **required** field for the upload process and moving on to the next step. Specifying the `Part_IPN` field matching is very powerful as it allows to create direct pointers to InvenTree parts.
Once you have selected the corresponding InvenTree fields, click on the "Submit Selections" button to move on to the next step.
#### Select Parts
Once the BOM file columns and InvenTree fields are correctly matched, the following view will load:
{% with id="bom_select_parts", url="build/bom_select_parts.png", description="Select Parts View" %}
{% include 'img.html' %}
{% endwith %}
InvenTree automatically tries to match parts from the BOM file with parts in its database. For parts that are found in InvenTree's database, the `Select Part` field selection will automatically point to the matching database part.
In this view, you can also edit the parts `Reference` and `Quantity` fields.
Once you have selected the corresponding InvenTree parts, click on the "Submit BOM" button to complete the BOM upload process.
### Validate BOM
After [adding BOM items manually](#add-bom-item) or [uploading a BOM file](#upload-bom), you should see the following view:
After [adding BOM items manually](#add-bom-item) or [uploading a BOM file](./bom_import.md), you should see the following view:
{% with id="bom_invalid", url="build/bom_invalid.png", description="Invalid BOM View" %}
{% include 'img.html' %}
{% endwith %}
@ -155,8 +110,20 @@ The first message in the red box `The BOM for PCBA TEST has changed, and must be
To process with BOM validation, click on the <span class='fas fa-clipboard-check'></span> icon and the `Validate BOM` form will be displayed. Click one the "Validate" switch then click on <span class="badge inventree confirm">Submit</span>
Voilà, this Bill of Materials is validated <span class='far fa-smile'></span>
{% with id="bom_valid", url="build/bom_valid.png", description="Valid BOM View" %}
{% include 'img.html' %}
{% endwith %}
## Multi Level BOMs
Multi-level (hierarchical) BOMs are natively supported by InvenTree. A Bill of Materials (BOM) can contain sub-assemblies which themselves have a defined BOM. This can continue for an unlimted number of levels.
When viewing a BOM table, sub-assemblies are not loaded by default, but can be loaded "on demand" by pressing the <span class='fas fa-sync-alt'></span> icon associated with the particular subassembly:
{% with id="bom_flat", url="build/bom_flat.png", description="Flat BOM Table" %}
{% include 'img.html' %}
{% endwith %}
{% with id="bom_expanded", url="build/bom_expanded.png", description="Expanded BOM Table" %}
{% include 'img.html' %}
{% endwith %}