mirror of
https://github.com/inventree/inventree-docs.git
synced 2025-06-12 18:25:27 +00:00
Initial commit
- Copied from inventree.github.io
This commit is contained in:
40
docs/stock/adjust.md
Normal file
40
docs/stock/adjust.md
Normal file
@ -0,0 +1,40 @@
|
||||
---
|
||||
title: Stock Adjustments
|
||||
layout: page
|
||||
---
|
||||
|
||||
## Stock Adjustments
|
||||
|
||||
InvenTree provides simple yet powerful management of stock levels. Multiple stock adjustment options are available, and each type of adjustment is automatically tracked to maintain a complete stock history.
|
||||
|
||||
### Move Stock
|
||||
|
||||
Multiple stock items can be moved to a new location in a single operation. Each item is moved to the selected location, and a stock tracking entry is added to the stock item history.
|
||||
|
||||
{% with id="stock_move", url="stock/stock_move.png", description="Stock movement" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
### Add Stock
|
||||
|
||||
Add parts to a stock item record - for example putting parts back into stock. The in-stock quantity for each selected item is increased by the given amount.
|
||||
|
||||
{% with id="stock_add", url="stock/stock_add.png", description="Stock addition" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
### Remove Stock
|
||||
|
||||
Remove parts from a stock item record - for example taking parts from stock for use. The in-stock quantity for each selected item is decreased by the given amount.
|
||||
|
||||
{% with id="stock_remove", url="stock/stock_remove.png", description="Stock removal" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
### Count Stock
|
||||
|
||||
Count stock items (stocktake) to record the number of items in stock at a given point of time. The quantity for each part is pre-filled with the current quantity based on stock item history.
|
||||
|
||||
{% with id="stock_count", url="stock/stock_count.png", description="Stock count" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
39
docs/stock/stock.md
Normal file
39
docs/stock/stock.md
Normal file
@ -0,0 +1,39 @@
|
||||
---
|
||||
title: Stock
|
||||
layout: page
|
||||
---
|
||||
|
||||
## Stock Location
|
||||
|
||||
A stock location represents a physical real-world location where *Stock Items* are stored. Locations are arranged in a cascading manner and each location may contain multiple sub-locations, or stock, or both.
|
||||
|
||||
## Stock Item
|
||||
|
||||
A *Stock Item* is an actual instance of a [*Part*](/part/part) item. It represents a physical quantity of the *Part* in a specific location.
|
||||
|
||||
### Stock Item Details
|
||||
|
||||
The *Stock Item* detail view shows information regarding the particular stock item:
|
||||
|
||||
**Part** - Which *Part* this stock item is an instance of
|
||||
|
||||
**Location** - Where is this stock item located?
|
||||
|
||||
**Quantity** - How many items are in stock?
|
||||
|
||||
**Supplier** - If this part was purcahsed from a *Supplier*, which *Supplier* did it come from?
|
||||
|
||||
**Supplier Part** - Link to the particular *Supplier Part*, if appropriate.
|
||||
|
||||
**Last Updated** - Date that the stock quantity was last updated
|
||||
|
||||
**Last Stocktake** - Date of most recent stocktake (count) of this item
|
||||
|
||||
**Status** - Status of this stock item
|
||||
|
||||
### Stock Tracking
|
||||
|
||||
Every time a *Stock Item* is adjusted, a *Stock Tracking* entry is automatically created. This ensures a complete history of the *Stock Item* is maintained as long as the item is in the system.
|
||||
|
||||
Each stock tracking historical item records the user who performed the action.
|
||||
|
9
docs/stock/stocktake.md
Normal file
9
docs/stock/stocktake.md
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: Stocktake
|
||||
layout: page
|
||||
---
|
||||
|
||||
## Stocktake
|
||||
|
||||
!!! missing "TODO"
|
||||
This section requires further work
|
51
docs/stock/test.md
Normal file
51
docs/stock/test.md
Normal file
@ -0,0 +1,51 @@
|
||||
---
|
||||
title: Stock Test Result
|
||||
layout: page
|
||||
---
|
||||
|
||||
## Stock Test Result
|
||||
|
||||
Stock items which are associated with a *trackable* part can have associated test data - this is particularly useful for tracking unit testing / commissioning / acceptance data against a serialized stock item.
|
||||
|
||||
The master "Part" record for the stock item can define multiple [test templates](/part/test/), against which test data can be uploaded. Additionally, arbitrary test information can be assigned to the stock item.
|
||||
|
||||
!!! missing "TODO"
|
||||
Include pictures of the Test Results tab
|
||||
|
||||
### Test Result Fields
|
||||
|
||||
#### Test Name
|
||||
|
||||
The name of the test data is used to associate the test with a test template object.
|
||||
|
||||
#### Result
|
||||
|
||||
Boolean pass/fail status of the test.
|
||||
|
||||
#### Value
|
||||
|
||||
Optional value uploaded as part of the test data. For example if the test is to record the firmware version of a programmed device, the version number can be added here.
|
||||
|
||||
#### Notes
|
||||
|
||||
Optional field available for extra notes.
|
||||
|
||||
#### Attachment
|
||||
|
||||
A given test result may require an attached file which contains extra test information.
|
||||
|
||||
### Multiple Test Results
|
||||
|
||||
Multiple results can be uploaded against the same test name. In cases where multiple test results are uploaded, the most recent value is used to determine the pass/fail status of the test. It is useful to keep all test records as a given test might be required to run multiple times, if (for example) it fails the first time and then something must be fixed before running the test again.
|
||||
|
||||
### Reporting
|
||||
|
||||
!!! missing "TODO"
|
||||
Include information on the reporting plugin architecture
|
||||
|
||||
### Automated Test Intgration
|
||||
|
||||
The stock item testing framework is especially useful when integrating with an automated acceptance testing framework. Test results can be uploaded using the [InvenTree API](/extend/api/) or the [InvenTree Python Interface](/extend/python/).
|
||||
|
||||
!!! info "Example"
|
||||
You design and sell a temperature sensor which needs to be calibrated before it can be sold. An automated calibration tool sets the offset in the device, and uploads a test result to the InvenTree database.
|
Reference in New Issue
Block a user