From 293d9434b434a415c3e9d981783318282e2edc91 Mon Sep 17 00:00:00 2001 From: Oliver Walters Date: Wed, 11 Nov 2020 14:11:07 +1100 Subject: [PATCH] Slight tweaks to part detail info --- docs/part/part.md | 39 ++++++++++++++++++++++++++++++++++++++- docs/part/trackable.md | 18 ++++++++++++++++++ docs/part/views.md | 20 -------------------- mkdocs.yml | 1 + 4 files changed, 57 insertions(+), 21 deletions(-) create mode 100644 docs/part/trackable.md diff --git a/docs/part/part.md b/docs/part/part.md index ffab5e6..f5d9c46 100644 --- a/docs/part/part.md +++ b/docs/part/part.md @@ -2,7 +2,7 @@ title: Parts --- -# Part +## Part The *Part* is the core element of the InvenTree ecosystem. A Part object is the archetype of any stock item in your inventory. Parts are arranged in heirarchical categories which are used to organise and filter parts by function. @@ -27,3 +27,40 @@ The list of parts underneath a given category can be filtered by multiple user-c Clicking on the part name links to the [*Part Detail*](../views) view. +## Part Options + +Each *Part* defined in the database provides a number of different options which determine how that part can be used. Configuring these options for a given part will impact the available functions that can be perform on (or using) that part). + +### Virtual + +A *Virtual* part is one which does not physically exist but should still be tracked in the system. This could be a process step, machine time, software license, etc. + +### Template + +A *Template* part is one which can have *variants* which exist underneath it. [Read further information about template parts here](../template). + +### Assembly + +If a part is designated as an *Assembly* it can be created (or built) from other component parts. As an example, a circuit board assembly is made using multiple electronic components, which are tracked in the system. An *Assembly* Part has a Bill of Materials (BOM) which lists all the required sub-components. [Read further information about BOM management here](../../build/bom). + +### Component + +If a part is designated as a *Component* it can be used as a sub-component of an *Assembly*. [Read further information about BOM management here](../../build/bom) + +### Trackable + +Trackable parts can be assigned batch numbers or serial numbers which uniquely identify a particular stock item. Trackable parts also provide other features (and restrictions) in the InvenTree ecosystem. + +[Read further information about trackable parts here](/../trackable). + +### Purchaseable + +If a part is designated as *Purchaseable* it can be purchased from external suppliers. Setting this flag allows parts to be added to [purchase orders](../../buy/po). + +### Salable + +If a part is designated as *Salable* it can be sold to external customers. Setting this flag allows parts to be added to sales orders. + +### Active + +By default, all parts are *Active*. Marking a part as inactive means it is not available for many actions, but the part remains in the database. If a part becomes obsolete, it is recommended that it is marked as inactive, rather than deleting it from the database. \ No newline at end of file diff --git a/docs/part/trackable.md b/docs/part/trackable.md new file mode 100644 index 0000000..0baf171 --- /dev/null +++ b/docs/part/trackable.md @@ -0,0 +1,18 @@ +--- +title: Trackable Parts +--- + +Denoting a part as *Trackble* changes the way that [stock items](../../stock/stock) associated with the particular part are handled in the database. A trackable part also has more restrictions imposed by the database scheme. + +## Stock Tracking + +For many parts in an InvenTree database, simply tracking current stock levels (and locations) is sufficient. However, some parts require more extensive tracking than simple stock level knowledge. + +Any stock item associated with a trackable part *must* have either a batch number or a serial number. This includes stock created manually or via an internal process (such as a [Purchase Order](../../buy/po) or a [Build Order](/../../build/build)). + + + + +## Build Orders + +Build orders have some extra requirements when either building a trackable part, or using parts in the Bill of Materials which are themselves trackable. \ No newline at end of file diff --git a/docs/part/views.md b/docs/part/views.md index 4601ec8..ad4f6ba 100644 --- a/docs/part/views.md +++ b/docs/part/views.md @@ -30,26 +30,6 @@ A Part is defined in the system by the following parameters: **Units** - Units of measure (UoM) for this Part. The default is 'pcs' -### Part Options - -A Part can provide different functionality based on the following options. - -**Virtual** - A *Virtual* part is one which does not physically exist but should still be tracked in the system. This could be a process step, machine time, software license, etc. - -**Template** - A *Template* part is one which can have *variants* which exist underneath it. [Read further information about template parts here](../template). - -**Assembly** - If a part is designated as an *Assembly* it can be created (or built) from other component parts. As an example, a circuit board assembly is made using multiple electronic components, which are tracked in the system. An *Assembly* Part has a Bill of Materials (BOM) which lists all the required sub-components. [Read further information about BOM management here](../../build/bom). - -**Component** - If a part is designated as a *Component* it can be used as a sub-component of an *Assembly*. [Read further information about BOM management here](../../build/bom) - -**Trackable** - If a part is designed as *trackable*, it can be tracked using unique serial numbers. - -**Purchaseable** - If a part is designated as *Purchaseable* it can be purchased from external suppliers. Setting this flag allows parts to be added to [purchase orders](../../buy/po). - -**Salable** - If a part is designated as *Salable* it can be sold to external customers. Setting this flag allows parts to be added to sales orders. - -**Active** - By default, all parts are *Active*. Marking a part as inactive means it is not available for many actions, but the part remains in the database. If a part becomes obsolete, it is recommended that it is marked as inactive, rather than deleting it from the database. - ## Parameters Parts can have multiple defined [parameters](../parameter). diff --git a/mkdocs.yml b/mkdocs.yml index d08af7a..a1295a4 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -41,6 +41,7 @@ nav: - Parts: - Parts: part/part.md - Part Views: part/views.md + - Tracking: part/trackable.md - Parameters: part/parameter.md - Templates: part/template.md - Tests: part/test.md