diff --git a/docs/assets/images/part/part_overview.png b/docs/assets/images/part/part_overview.png index 5e10d07..90ef62a 100644 Binary files a/docs/assets/images/part/part_overview.png and b/docs/assets/images/part/part_overview.png differ diff --git a/docs/assets/images/part/part_tabs.png b/docs/assets/images/part/part_tabs.png new file mode 100644 index 0000000..d25e605 Binary files /dev/null and b/docs/assets/images/part/part_tabs.png differ diff --git a/docs/assets/images/part/part_view_intro.png b/docs/assets/images/part/part_view_intro.png new file mode 100644 index 0000000..f28e1a9 Binary files /dev/null and b/docs/assets/images/part/part_view_intro.png differ diff --git a/docs/part/part.md b/docs/part/part.md index b7a2976..996cdaa 100644 --- a/docs/part/part.md +++ b/docs/part/part.md @@ -68,19 +68,3 @@ By default, all parts are *Active*. Marking a part as inactive means it is not a ## Part Import *Parts* can be imported by staff-members on the part-list-view (this feature must be enabled in the part-settings), in the part-settings or on the [admin-page for parts](../admin/import.md) (only accessible if you are also an admin). The first two options provide a multi-stage wizard that enables mapping fields from various spreadsheet or table-data formats while the latter requires a well-formatted file but is much more performant. - -## Related Parts - -Related Part denotes a relationship between two parts, when users want to show their usage is "related" to another part or simply emphasize a link between two parts. - -Related parts can be added and are shown under a table of the same name in the "Part" view: - -{% with id="related_parts", url="part/part_related.png", description="Related Parts Example View" %} -{% include 'img.html' %} -{% endwith %} - -This feature can be enabled or disabled in the global part settings: - -{% with id="related_parts_setting", url="part/part_related_setting.png", description="Related Parts Example View" %} -{% include 'img.html' %} -{% endwith %} diff --git a/docs/part/views.md b/docs/part/views.md index 1121106..8380745 100644 --- a/docs/part/views.md +++ b/docs/part/views.md @@ -2,45 +2,65 @@ title: Part Views --- -The Part information page organizes part data into sections, displayed as tabs. +The main part view is divided into 4 different panels: + +1. Categories +2. Details +3. Tabs +4. Content of each tab + +{% with id="part_view_intro", url="part/part_view_intro.png", description="Part View Introduction" %} +{% include 'img.html' %} +{% endwith %} +

+ +## Categories + +The categories of each part is displayed on the top navigation bar as show in the above screenshot. +[Click here](../part/#part-category) for more information about categories. ## Part Details -The *Details* tab shows a detail view which provides information about the particular part. +Details provides information about the particular part. Parts details can be displayed in the header panel clicking on "Show Part Details" toggle button. {% with id="part_overview", url="part/part_overview.png", description="Part details" %} {% include 'img.html' %} {% endwith %} +

A Part is defined in the system by the following parameters: -### Part Definition Fields +**Internal Part Number (IPN)** - A special code which can be used to link a part to a numbering system. The IPN field is not required, but may be useful where a part numbering system has been defined. -**Part Name** - The Part name is a simple (unique) text label +**Name** - The Part name is a simple (unique) text label **Description** - Longer form text field describing the Part -**Internal Part Number (IPN)** - A special code which can be used to link a part to a numbering system. The IPN field is not required, but may be useful where a part numbering system has been defined. - **Revision** - An optional revision code denoting the particular version for the part. Used when there are multiple revisions of the same master part object. -**Category** - The Part category is used to group or arrange parts, as per the particular requirements of the user. Categories are arranged in a 'tree' where each category may have multiple child categories. +**Keywords** - Optional few words to describe the part and make the part search more efficient. **External Link** - An external URL field is provided to link to an external page. This could be useful the part has extra documentation located on an external server. +**Creation Date** - Indicates when the part was created and by which user (label on right-hand side) + **Units** - Units of measure (UoM) for this Part. The default is 'pcs' -## Parameters +## Part Tabs + +The Part view page organizes part data into sections, displayed as tabs. Each tab has its own function, which is described in this section. + +### Parameters Parts can have multiple defined [parameters](./parameter.md). -## Variants +### Variants If a part is a *Template Part* then the *Variants* tab will be visible. [Read about Part templates](./template.md) -## Stock +### Stock The *Stock* tab shows all the stock items for the selected *Part*. The user can quickly determine how many parts are in stock, where they are located, and the status of each *Stock Item*. @@ -48,39 +68,39 @@ The *Stock* tab shows all the stock items for the selected *Part*. The user can {% include 'img.html' %} {% endwith %} -### Functions +#### Functions The following functions are available from the *Part Stock* view. -#### Export +##### Export Exports the stocktake data for the selected Part. Launches a dialog to select export options, and then downloads a file containing data for all stock items for this Part. -#### New Stock Item +##### New Stock Item Launches a dialog to create a new *Stock Item* for the selected *Part*. -#### Stock Actions +##### Stock Actions If stock items are selected in the table, stock actions are enabled via the drop-down menu. -## Allocations +### Allocations The *Allocated* tab displays how many units of this part have been allocated to pending build orders and/or sales orders. This tab is only visible if the Part is a *component* (meaning it can be used to make assemblies), or it is *salable* (meaning it can be sold to customers). -## BOM +### Bill of Materials The *BOM* tab displays the [Bill of Materials](../build/bom.md) - a list of sub-components used to build an assembly. Each row in the BOM specifies a quantity of another Part which is required to build the assembly. This tab is only visible if the Part is an *assembly* (meaning it can be build from other parts). -## Build Orders +### Build Orders 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 +### Used In The *Used In* tab displays a list of other parts that this part is used to make. This tab is only visible if the Part is a *component*. -## Suppliers +### Suppliers The *Suppliers* tab displays all the *Supplier Parts* for the selected *Part*. @@ -90,24 +110,40 @@ This tab is only visible if the *Part* is designated as *Purchaseable*. {% include 'img.html' %} {% endwith %} -## Purchase Orders +### Purchase Orders The *Part Purchase Orders* tab lists all the Purchase Orders against the selected part. This tab is only displayed if the part is marked as *Purchaseable*. -## Sales Orders +### Sales Orders 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 +### Tests If a part is marked as *trackable*, the user can define tests which must be performed on any stock items which are instances of this part. [Read more about testing](./test.md). -## Attachments +### Related Parts + +Related Part denotes a relationship between two parts, when users want to show their usage is "related" to another part or simply emphasize a link between two parts. + +Related parts can be added and are shown under a table of the same name in the "Part" view: + +{% with id="related_parts", url="part/part_related.png", description="Related Parts Example View" %} +{% include 'img.html' %} +{% endwith %} + +This feature can be enabled or disabled in the global part settings: + +{% with id="related_parts_setting", url="part/part_related_setting.png", description="Related Parts Example View" %} +{% include 'img.html' %} +{% endwith %} + +### Attachments The *Part Attachments* tab displays file attachments associated with the selected *Part*. Multiple file attachements (such as datasheets) can be uploaded for each *Part*. -## Notes +### Notes A part may have notes attached, which support markdown formatting. \ No newline at end of file