2
0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-28 05:36:46 +00:00

Merge remote-tracking branch 'inventree/master'

This commit is contained in:
Oliver Walters 2020-09-25 08:53:38 +10:00
commit a941c50abd
52 changed files with 312 additions and 67 deletions

View File

@ -1,8 +0,0 @@
<form action="https://www.paypal.com/cgi-bin/webscr" method="post" target="_top">
<input type="hidden" name="cmd" value="_donations" />
<input type="hidden" name="business" value="T4M976M5URSUE" />
<input type="hidden" name="currency_code" value="AUD" />
<input type="image" src="https://www.paypalobjects.com/en_AU/i/btn/btn_donateCC_LG.gif" border="0" name="submit" title="PayPal - The safer, easier way to pay online!" alt="Donate with PayPal button" />
<img alt="" border="0" src="https://www.paypal.com/en_AU/i/scr/pixel.gif" width="1" height="1" />
</form>

View File

@ -1,6 +1,5 @@
---
title: InvenTree Admin Interface
layout: page
---
## Admin Interface

View File

@ -1,6 +1,5 @@
---
title: Exporting Data
layout: page
---
## Exporting Data

View File

@ -1,6 +1,5 @@
---
title: Importing Data
layout: page
---
## Importing Data

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 154 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 924 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 152 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 88 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.9 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

View File

@ -0,0 +1,3 @@
<svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 24 24">
<path fill="rgb(123,136,204)" d="M14,3V5H17.59L7.76,14.83L9.17,16.24L19,6.41V10H21V3M19,19H5V5H12V3H5C3.89,3 3,3.9 3,5V19A2,2 0 0,0 5,21H19A2,2 0 0,0 21,19V12H19V19Z" />
</svg>

After

Width:  |  Height:  |  Size: 260 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

81
docs/build/bom.md vendored
View File

@ -1,11 +1,84 @@
---
title: Bill of Materials
layout: page
---
## Bill of Materials
A Bill of Materials (BOM) defines the list of component parts required to make an assembly.
A Bill of Materials (BOM) defines the list of component parts required to make an assembly, [create builds](/build/build) and allocate inventory.
!!! missing "TODO"
This section requires further work
### Add BOM Item
To manually add a BOM item, navigate to the part/assembly detail page then click on the "BOM" tab. On top of the tab view, click on the :fontawesome-solid-edit: icon then, after the page reloads, click on the :fontawesome-solid-plus-circle: icon.
The `Create BOM Item` form will be displayed:
{% with id="bom_add_item", url="build/bom_add_item.png", description="Create BOM Item Form" %}
{% include 'img.html' %}
{% endwith %}
Fill-out the `Quantity` (required), `Reference`, `Overage` and `Note` (optional) fields then click on the "Submit" button to add the BOM item to this part's BOM.
### 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 :fontawesome-solid-edit: icon then, after the page reloads, click on the :fontawesome-solid-file-upload: 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. Sprcifying 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.
!!! info "Create New Part"
The :fontawesome-solid-plus: icon in the `Select Part` column let's you load the `Create New Part` form which allows you to create an InvenTree part during the BOM upload process.
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:
{% with id="bom_invalid", url="build/bom_invalid.png", description="Invalid BOM View" %}
{% include 'img.html' %}
{% endwith %}
The first message in the red box `The BOM for PCBA TEST has changed, and must be validated.` points out that InvenTree BOM needs to be "validated". BOM validation is a way to ensure a BOM does not have duplicate items/parts.
To process with BOM validation, click on the :fontawesome-solid-clipboard-check: icon and the `Validate BOM` form will be displayed. Click one the "Validate" switch then click on the "Submit" button.
Voilà, this Bill or Materials is validated :material-emoticon-cool:
{% with id="bom_valid", url="build/bom_valid.png", description="Valid BOM View" %}
{% include 'img.html' %}
{% endwith %}

100
docs/build/build.md vendored
View File

@ -1,9 +1,101 @@
---
title: Build
layout: page
title: Build Parts
---
## Building Parts
!!! missing "TODO"
This section requires further work
Build management can be accessed via the *Build* navigation tab.
A "basic" build flow is as follow:
1. create a part with the [*Assembly option*](/part/views/#part-options) turned-on
0. add a Bill of Material (BOM)
0. create a "Build Order" for this part
0. allocate stocks from your inventory
0. update build status and notes
0. complete the build.
##### Future Features
| Feature | Status |
| ----------- | ----------- |
| Allow edit of completed builds | :material-progress-clock: [Work In Progress](https://github.com/inventree/InvenTree/pull/993) |
| Track subparts used in build | :material-progress-clock: [Work In Progress](https://github.com/inventree/InvenTree/pull/991) |
| Partial build completion | :material-close: Not yet supported |
### Build Status
| Status | Description |
| ----------- | ----------- |
| `Pending` | "Build Order" has been created and build is ready for subpart allocation |
| `Allocated` | All subparts stocks in the part BOM have been allocated |
| `Cancelled` | Build has been cancelled |
| `Completed` | Build has been completed |
### Part BOM
A Part BOM is required to allocate inventory to a build.
Read through the [Bill of Materials documentation](/build/bom).
### Build Order
Builds orders are used to create parts builds.
To create a build order for your part, you have two options:
1. navigate to the Part detail page, click on "Build Orders" tab then click on "Start New Build" button
0. navigate to the Build page, click on "New Build Order".
{% with id="build_start_new", url="build/build_start_new.png", description="Start New Build Form" %}
{% include 'img.html' %}
{% endwith %}
Fill-out the form then click the "Submit" button to create the build.
### Stock Allocation
To allocate stock for a build, you have two options:
1. **automatic** allocation: if each subpart has only **one** storage location, InvenTree can allocate stock from this location automatically
0. **manual** allocation: user can define allocation for each subpart in the build.
During allocation, InvenTree relies on [Stock items](/stock/stock/#stock-item) to reference parts that will be used for the build. Make sure to read through the [stock documentation](/stock/stock) before proceeding with stock allocation.
#### Automatic Allocation
Click on the "Allocated Parts" tab then click on the "Auto Allocate" button to automatically allocate stock for this build.
The `Allocate Stock` form will be displayed. Verify each subpart automatic allocation, click on the confirmation switch, then click on the "Submit" button to process the stock allocation.
#### Manual Allocation
Click on the "Allocated Parts" tab then click on the :fontawesome-solid-plus: icon next to each subpart in the build to manually allocate stock.
The `Allocate new Part` form will be displayed. Select a `Stock Item` and fill-out the `Quantity` field then click on the "Submit" button to allocate stock for this subpart.
#### Unallocate
Click on the "Allocated Parts" tab then click on the "Unallocate" button to unallocate stock items allocated for this build.
### Cancel Build
To cancel a build, click on :fontawesome-regular-times-circle: icon on the build detail page.
The `Cancel Build` form will be displayed, click on the confirmation switch then click on the "Cancel Build" button to process the build cancellation.
!!! warning "Cancelled Build"
**A cancelled build cannot be re-opened**. Make sure to use the cancel option only if you are certain that the build won't be processed.
### Complete Build
To complete a build, click on :fontawesome-solid-tools: icon on the build detail page, the `Complete Build` form will be displayed.
!!! info "Incomplete Allocation"
If the warning message `Warning: Build order allocation is not complete` is shown, make sure to allocate stock for the build before proceeding with build completion.
Select a `Location` to store the resulting parts from the build then click on the confirmation switch.
Finally, click on the "Complete Build" button to process the build completion.
!!! warning "Completed Build"
**A completed build cannot be re-opened**. Make sure to use the confirm only if you are certain that the build is complete.

View File

@ -1,6 +1,5 @@
---
title: Purchase Order
layout: page
---
## Purchase Orders

View File

@ -1,6 +1,5 @@
---
title: Suppliers
layout: page
---
## Suppliers

View File

@ -1,6 +1,5 @@
---
title: Contributing to InvenTree
layout: page
---
## Contribute to InvenTree
@ -28,10 +27,12 @@ InvenTree provides a translation layer for the web interface, this requires effo
### Documentation
Documenting a large software project is a challenging and ongoing effort. If you are able to provide assistance in improving this documentation set, please consider doing so! Documentation contributions can be made on [GitHub](https://github.com/inventree/inventree.github.io).
Documenting a large software project is a challenging and ongoing effort. If you are able to provide assistance in improving this documentation set, please consider doing so! Documentation contributions can be made on [GitHub](https://github.com/inventree/inventree-docs).
### Donate
If you are unable to provide contributions as listed above, or you find InvenTree to be useful, please consider donating to support its ongoing development.
{% include 'donate.html' %}
[ Donate :material-emoticon-cool: ](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=T4M976M5URSUE&currency_code=AUD){: .md-button .md-button--primary }
<img src="/assets/paypal-logo-small-min-300x136.png" border="0" alt="PayPal Logo" style="width: 102px; length:225px; vertical-align:middle;">

View File

@ -1,6 +1,5 @@
---
title: InvenTree API
layout: page
---
## InvenTree API

View File

@ -1,6 +1,5 @@
---
title: Third Party Integrations
layout: page
---
## Third Party Integrations

View File

@ -1,6 +1,5 @@
---
title: Plugins
layout: page
---
## InvenTree Plugin Architecture

View File

@ -1,6 +1,5 @@
---
title: Python Interface
layout: page
---
## Python Module

View File

@ -1,7 +1,5 @@
---
title: InvenTree
layout: page
permalink: "/"
---
## InvenTree - Intuitive Inventory Management
@ -14,19 +12,19 @@ InvenTree is designed to be lightweight and easy to use for SME or hobbyist appl
InvenTree is a [Python](https://www.python.org/) and [Django](https://www.djangoproject.com/) application which stores data in a relational database, and serves this data to the user(s) via a web browser, and (optionally) can be integrated into custom applications via an API.
InvenTree is designed to allow for a flexible installation. You could run the InvenTree server on Raspberry Pi SBC and have a simple single-user setup with a lightweight sqlite database. Or it can be run on the "cloud" using MySQL or PostgreSQL and support multiple simultaneous users.
InvenTree is designed to allow for a flexible installation. You could run the InvenTree server on Raspberry Pi SBC and have a simple single-user setup with a lightweight SQLite database. Or it can be run on the "cloud" using MySQL or PostgreSQL and support multiple simultaneous users.
## Features
### Organize Parts
Parts are the fundemental element of any inventory. InvenTree groups parts into structured categories which allow you to arrange parts to meet your particular needs.
Parts are the fundamental element of any inventory. InvenTree groups parts into structured categories which allow you to arrange parts to meet your particular needs.
[Read more...](part/part)
### Manage Suppliers
Link parts to multiple suppliers,
InvenTree allows you to easily create, modify or delete suppliers and supplier items linked to any part in your inventory.
[Read more...](buy/supplier)
@ -39,12 +37,14 @@ Instantly view current stock for a certain part, in a particular location, or re
### BOM Management
Intelligent BOM (Bill of Material) management provides a clear understanding of the sub-parts required to make a new part.
InvenTree allows you to upload simple BOM files in multiple formats, and download a detailed BOM with all the information stored in its database.
[Read more...](build/bom)
### Build Parts
Consume stock items to make new parts
Inventree features a build management system to help you track the progress of your builds.
Builds consume stock items to make new parts, you can decide to automatically or manually allocate parts from your current inventory.
[Read more...](build/build)

View File

@ -0,0 +1,7 @@
/* Add target="_blank" to external links */
/* Source: https://html.com/attributes/a-target/#:~:text=browser */
function externalLinks() {
for(var c = document.getElementsByTagName("a"), a = 0;a < c.length;a++) {
var b = c[a]; b.getAttribute("href") && b.hostname !== location.hostname && (b.target = "_blank")
}
} ; externalLinks();

View File

@ -1,9 +1,46 @@
---
title: Part Parameters
layout: page
---
## Part Parameters
!!! missing "TODO"
Parameter documentation to be written
Part parameters are located in the "Parameters" tab, on each part detail page.
There is no limit for the number of part parameters and they are fully customizable through the use of parameters templates.
Here is an example of parameters for a Ceramic capacitor:
{% with id="part_parameters_example", url="part/part_parameters_example.png", description="Part Parameters Example List" %}
{% include 'img.html' %}
{% endwith %}
### Create Template
A *Parameter Template* is required for each part parameter.
To create a template, you have two options:
1. navigate to the "Settings" page, click on the "Part" tab and then click on the "New Parameter" button
0. navigate to a specific part detail page, click on the "Parameters" tab, click on the "New Parameters" button then click on the "New Template" button in the newly displayed form.
The `Create Part Parameter Template` form will be displayed:
{% with id="create_parameter_template", url="part/create_parameter_template.png", description="Create Part Parameter Template Form" %}
{% include 'img.html' %}
{% endwith %}
Fill-out the template `Name` (required) and `Units` (optional) fields then click the "Submit" button.
### Create Parameter
After [creating a template](#create-template) or using the existing templates, you can add parameters to any part.
To add a parameter, navigate to a specific part detail page, click on the "Parameters" tab then click on the "New Parameters" button, the `Create Part Parameter` form will be displayed:
{% with id="create_part_parameter", url="part/create_part_parameter.png", description="Create Part Parameter Form" %}
{% include 'img.html' %}
{% endwith %}
Select the parameter `Template` you would like to use for this parameter, fill-out the `Data` field (value of this specific parameter) and click the "Submit" button.
### Parametric Tables
!!! note "Future Feature Proposal"
Allow parts to be filtered using parameters. Narrow down the list of parameters to the parts found in each category.

View File

@ -1,6 +1,5 @@
---
title: Parts
layout: page
---
# Part

View File

@ -1,9 +1,44 @@
---
title: Part Templates
layout: page
---
## Part Templates
!!! missing "TODO"
Parameter documentation to be written
There are various purposes for using Part Templates, among them:
* Template parts can hold information that can be re-used across "Variants", a template part could be useful for creating a base variant of an assembly which can be derived from, with BoM changes for instance.
* Variants can be used as "manufacturing variants" where the variant dictates a particular configuration which a customer can order: a variant might determine the particular options that come with a part, like harnesses, enclosure, color, specs, etc.
"Variants" parts will reference the "Template" part therefore explicitly creating and showing direct relationship.
They also allow you to do special things like:
* **Serial Numbers**
Parts that are linked in a template / variant relationship must have unique serial numbers (e.g. if you have a template part Widget, and two variants Widget-01 and Widget-02 then any assigned serial numbers must be unique across all these variants).
* **Stock Reporting**
The "stock" for a template part includes stock for all variants under that part.
* **Logical Grouping**
The template / variant relationship is subtly different to the category / part relationship.
### Enable Template Part
Any part can be set as "Template" part. To do so:
1. navigate to a specific part detail page
0. click on the "Details" tab
0. locate the part options on the right-hand side
0. toggle the `Template` option so it shows green / slider to the right:
{% with id="enable_template_part", url="part/enable_template_part.png", description="Enable Template Part Option" %}
{% include 'img.html' %}
{% endwith %}
### Create Variant
When a part's [*Template option*](#enable-template-part) is turned-on, "Variants" of this part can be created.
To create a variant, navigate to a specific part detail page, click on the "Variants" tab then click on the "New Variant" button.
The `Create Variant` form will be displayed:
{% with id="create_part_variant", url="part/create_part_variant.png", description="Create Part Variant Form" %}
{% include 'img.html' %}
{% endwith %}
Fill-out the form then click on the "Submit" button to create the variant.

View File

@ -1,6 +1,5 @@
---
title: Part Test Templates
layout: page
---
## Part Test Templates

View File

@ -1,6 +1,5 @@
---
title: Part Views
layout: page
---
The Part information page organizes part data into sections, displayed as tabs.
@ -57,7 +56,9 @@ Parts can have multiple defined [parameters](/part/parameter).
## Variants
If a part is a *Template Part* then the *Variants* tab will be visible. [Part templates](/part/template)
If a part is a *Template Part* then the *Variants* tab will be visible.
[Read about Part templates](/part/template)
## Stock
@ -93,8 +94,7 @@ The *BOM* tab displays the [Bill of Materials](/build/bom) - a list of sub-compo
## Build Orders
!!! missing "TODO"
Documentation to be written
The *Build Orders* tab shows a list of the builds for this part. It provides a view for important build information like quantity, status, creation and completion dates.
## Used In
@ -118,8 +118,7 @@ This tab is only displayed if the part is marked as *Purchaseable*.
## Sales Orders
!!! missing "TODO"
Documentation to be written
The *Sales Orders* tab shows a list of the sales orders for this part. It provides a view for important sales order information like customer, status, creation and shipment dates.
## Tests

View File

@ -1,6 +1,5 @@
---
title: Custom Labels
layout: page
---
## Custom Labels

View File

@ -1,6 +1,5 @@
---
title: Order Report
layout: page
---
## Order Report

View File

@ -1,6 +1,5 @@
---
title: Packing List Report
layout: page
---
## Packing List

View File

@ -1,6 +1,5 @@
---
title: Report Generation
layout: page
---
## Custom Reporting

View File

@ -1,6 +1,5 @@
---
title: Test Report
layout: page
---
## Test Report

View File

@ -1,6 +1,5 @@
---
title: Database Configuration
layout: page
---
## Database Configuration

View File

@ -1,6 +1,5 @@
---
title: Deploy InvenTree
layout: page
---
## Deploying InvenTree

View File

@ -1,6 +1,5 @@
---
title: Install InvenTree
layout: page
---
## Introduction

View File

@ -1,6 +1,5 @@
---
title: Migrating Data
layout: page
---
## Migrating Data

View File

@ -1,6 +1,5 @@
---
title: Changing color theme
layout: page
---
## Color Themes

View File

@ -1,6 +1,5 @@
---
title: Update InvenTree
layout: page
---
## Update InvenTree

View File

@ -1,6 +1,5 @@
---
title: Stock Adjustments
layout: page
---
## Stock Adjustments

View File

@ -1,6 +1,5 @@
---
title: Stock
layout: page
---
## Stock Location

View File

@ -1,6 +1,5 @@
---
title: Stocktake
layout: page
---
## Stocktake

View File

@ -1,6 +1,5 @@
---
title: Stock Test Result
layout: page
---
## Stock Test Result

View File

@ -1,3 +1,4 @@
/* Image "popping" feature */
.overlay {
/* Display over the entire page */
position: fixed;
@ -44,4 +45,26 @@
.overlay:target img {
transform: scale(1);
}
/* Add icon after external links */
/* Ignore auto-generated material theme links */
a[target="_blank"]:not([class*="md-"]):after {
/* content: " " url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='12' height='12' viewBox='0 0 24 24'%3E%3Cpath fill='rgb(123,136,204)' d='M14,3V5H17.59L7.76,14.83L9.17,16.24L19,6.41V10H21V3M19,19H5V5H12V3H5C3.89,3 3,3.9 3,5V19A2,2 0 0,0 5,21H19A2,2 0 0,0 21,19V12H19V19Z' /%3E%3C/svg%3E%0A");*/
content: " " url('../assets/open-in-new-custom.svg');
}
/* Set text alignment to "justify" */
p {
text-align: justify;
}
/* Remove page title */
.md-content h1:first-child {
display: none;
}
/* Remove top margin for first h2 header */
.md-typeset h2:first-of-type {
margin-top: 0em;
}

View File

@ -19,10 +19,12 @@ theme:
icon:
repo: fontawesome/brands/github
features:
- instant
- tabs
edit_uri: "" # Disable "Edit" button
extra_css:
- stylesheets/extra.css
extra_javascript:
- javascripts/extra.js
# Navigation
nav:
@ -39,7 +41,7 @@ nav:
- Parts: part/part.md
- Part Views: part/views.md
- Parameters: part/parameter.md
- Template Parts: part/template.md
- Templates: part/template.md
- Tests: part/test.md
- Stock:
- Stock Items: stock/stock.md
@ -48,7 +50,7 @@ nav:
- Test Results: stock/test.md
- Build:
- Build Parts: build/build.md
- BOM: build/bom.md
- Bill of Materials (BOM): build/bom.md
- Buy:
- Suppliers: buy/supplier.md
- Purchase Orders: buy/po.md
@ -77,12 +79,19 @@ plugins:
# Extensions
markdown_extensions:
- admonition
- attr_list
- meta
- pymdownx.details
- markdown.extensions.codehilite
- pymdownx.highlight
- pymdownx.superfences
- pymdownx.emoji:
emoji_index: !!python/name:materialx.emoji.twemoji
emoji_generator: !!python/name:materialx.emoji.to_svg
- toc:
permalink:
# Global Variables
extra:
static_folder_source: ./InvenTree/InvenTree/static/
static_folder_local_default: ./inventree_static/
static_folder_local_default: ./inventree_static/