Files
InvenTree/docs/docs/part/views.md
T
OliverandMatthias Mair 02da01dfec [Refactor] Notes (#11971)
* Display note info

* Support user locale

* Add unit testing for HTML content

* Observe color mode

* Add link between Note and NotesImage

* Ensure image file is deleted when NotesImage is deleted

* Add support for image upload in editor

* Skeleton for data migration

* Updates

* Update data migration

- Find any NoteImage items which do not link to a model
- Try to associate them with an existing note

* Remove validator

* Updated API endpoints for NotesImage model

* Update server side sanitizing

* Specify max field length

* Remove old fields from NotesImage model

* Refactor clean_string

* Remove obsolete task

* Remove legacy "notes" field from older models

* Adjust search params when switching notes

* Remove NotesFieldMixin

* Change editor

* Resizable image support

* Support tables

* Add table style

* Adjust header actions

* Add data migration for SalesOrderShipment notes

* Adjust back-end sanitizing

* Adjust

* Use subtle editor variant

* Move undo/redo

* Enhance editing logic

* Add report tags for notes

* Add unit test for note image cleanup

* Render note to HTML

- Automatically replace images

* Fix migration order

* Adjust migration text

* Fix "dirty" trigger on notes

* Prevent navigate from dirty notes

* Add documentation

* Prevent image clicking if not in editing mode

* Update API

* Update migration files

* Fix migrations

* remove notes from test fixtures

* remove notes field that does not exsist anymore

* add missing ruleset

* fix assertation

* fix assertation

* Update docs/docs/concepts/notes.md

Co-authored-by: Matthias Mair <code@mjmair.com>

* Remove blocknote deps

* Move old helper functions

- Only used for this migration
- Will potentially be removed at some point in the future?

* Revert change

* Fix note image URL

* Fix migration conflicts

* Fix migrations

* Fix delete call

* Fix content mixin

* Fix note duplication

* Make save method atomic

* Fix double-save

* Add "template" field to Note model

* Adjust migrations

* Frontend updates

* Fix for NotesEditor

* Render Note instance in forms

* Fix button-within-button

* Fix migrations

* Fix missing import

* add docs

* docs for rendering notes in reports

* Restrict queryset based on user view permissions

* APi unit tests for note permissions

* Duplicate embedded images when copying notes

* Add unit test for note duplication

* Add CHANGELOG

* Add 'copy_note' option to duplicate serializer

* Add unit tests for data migrations

* implement note duplication serializers

* frontend UI elements

* Fix migration conflicts

* Use branch for playwrigh testing

* Implement duplicate action for stock item

* Fix import

* Updated playwright tests

* Bug fix for receiving stock items

* Add screenshot

* Fix api_version

* Update unit tests

* Fix docs

* Remove defunct tests

* Fix migration order

* Adjust import/export workflow

* Manual cleaning update

* Fix migrations

* Fix migration files

* Fix for note save

* Adjust save ordering

* Skip constraint checking in NoteSerializer

* Custom validate_constraints on Note model

* Revert "Skip constraint checking in NoteSerializer"

This reverts commit b42bc955c1.

* Fix for note search

* Fix for receive_line_items

* Shim model renderer for NoteTemplate

* Fix playwright tests

* Adjust frontend CI

* Fix import/export CI job

* Fix for data migration test

* Fix migration test

* Adjust unit test

* Fix conflicting migration

* Fix unit test

* Run migration tests in parallel

* Robustify migration test

* Disable parallel options

* Fix conflicting migration

* Remove extraneous unit test

* Fix conflicting migrations

* Additional regression tests

* Check permissions before deleting Note instance

* Updated docs

* Validate note model type

* Prevent discard of unsaved changes in note editor

* Clean up dead code

* Fix migration conflict

* Improved data migration

* Prefetch role groups

* UI refactoring

* Refactor permission checking code

* Further code refactoring

* use DuplicateField helper

* Refactoring

* Add prefetch

* Throw exception rather than assert

* Logic fix for notes editor

* reimplement old background task

* Adjust data migration

* Fix notes field when receiving items

* Fix existing report templates

* Fix save action for notes editor

* Refactoring: Add "instance-info" API endpoint for common model properties

* Fix indicator dots

* Tweak nav alert msg

* Adjust layout of buttons

* Sanitize notes during migration

* Fix for NotesImage delete cascade

* Fix caching

* Fix race condition in notes editor

* Fix distinct issue when searching notse

* Fix race condition when saving new note instance

* Fix improper error

* Refactor StockItem duplication

* Refactoring

* Increase query time

* Fix api_version.py

* Additional migration tests

* Fix CI workflow

---------

Co-authored-by: Matthias Mair <code@mjmair.com>
2026-08-31 16:46:33 +10:00

6.5 KiB

title
title
Part Views

Part Views

The Part detail view page provides a detailed view of a single part in the system. The page is divided into several sections, which are described in this document.

Category Breadcrumb List

The categories of each part is displayed on the top navigation bar. Click here for more information about categories.

Part Details

Details provides information about the particular part. Parts details can be displayed in the header panel clicking on "Show Part Details" toggle button.

{{ image("part/part_overview.png", "Part Overview") }}

A Part is defined in the system by the following parameters:

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.

Name - The Part name is a simple (unique) text label

Description - Longer form text field describing the Part

Revision - An optional revision code denoting the particular version for the part. Used when there are multiple revisions of the same master part object. Read more about part revisions here.

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'

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.

Variants

If a part is a Template Part then the Variants tab will be visible.

Read about Part templates and variants

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.

{{ image("part/part_stock.png", "Part Stock") }}

Functions

The following functions are available from the Part Stock view.

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

Launches a dialog to create a new Stock Item for the selected Part.

Stock Actions

If stock items are selected in the table, stock actions are enabled via the drop-down menu.

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).

Bill of Materials

The BOM tab displays the Bill of Materials - 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

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

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.

Part Pricing

The Part Pricing tab displays all available pricing information for the part, aggregated from multiple sources (internal pricing, supplier pricing, purchase history, BOM pricing, sale pricing, etc). Refer to the part pricing documentation for further information.

Suppliers

The Suppliers tab displays all the Part Suppliers and Part Manufacturers for the selected Part.

This tab is only visible if the Part is designated as Purchaseable.

{{ image("part/part_manufacturers_suppliers.png", "Part Suppliers and Manufacturers") }}

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

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.

Return Orders

The Return Orders tab shows a list of the return orders which reference this part. This tab is only visible if the Part is marked as Salable, and the return order feature is enabled.

Transfer Orders

The Transfer Orders tab shows a list of the transfer orders which reference this part. This tab is hidden if the Part is marked as Virtual, or the transfer order feature is not enabled.

Stock History

The Stock History tab provide historical stock level information. Refer to the stock history documentation for further information.

Test Templates

If a part is marked as testable, the user can define tests which must be performed on any stock items which are instances of this part. Read more about testing.

Test Results

The Test Results tab displays test result data uploaded against any stock item of this part, aggregated into a single table. This differs from the Test Templates tab, which configures the tests themselves rather than displaying recorded results. This tab is only visible if the part is marked as testable.

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:

{{ image("part/part_related.png", "Related Parts Example View") }}

This feature can be enabled or disabled in the global part settings.

Parameters

Parts can have multiple defined parameters.

Read about parameters.

Attachments

The Part Attachments tab displays file attachments associated with the selected Part. Multiple file attachments (such as datasheets) can be uploaded for each Part.

Read about attachments.

Notes

A part may have one or more rich-text notes attached.

Read about notes.