Update documentation of stock supply

This commit is contained in:
Alex Alias Montserrat
2026-03-29 17:14:46 +02:00
parent 7e1bd14392
commit 626c61b3c1
4 changed files with 149 additions and 42 deletions
+28
View File
@@ -39,44 +39,55 @@ Version 6.6.0 - 2022-10-31
* Bug fixes (see mercurial logs for details)
Version 6.4.0 - 2022-05-02
--------------------------
* Bug fixes (see mercurial logs for details)
* Add warehouses selection to supply stock wizard
* Add support for Python 3.10
* Remove support for Python 3.6
Version 6.2.0 - 2021-11-01
--------------------------
* Bug fixes (see mercurial logs for details)
Version 6.0.0 - 2021-05-03
--------------------------
* Bug fixes (see mercurial logs for details)
Version 5.8.0 - 2020-11-02
--------------------------
* Bug fixes (see mercurial logs for details)
* Remove support for Python 3.5
Version 5.6.0 - 2020-05-04
--------------------------
* Bug fixes (see mercurial logs for details)
* Add cron job to supply stock
Version 5.4.0 - 2019-11-04
--------------------------
* Bug fixes (see mercurial logs for details)
* Make order point's minimal quantity required
Version 5.2.0 - 2019-05-06
--------------------------
* Bug fixes (see mercurial logs for details)
Version 5.0.0 - 2018-10-01
--------------------------
* Bug fixes (see mercurial logs for details)
* Remove support for Python 2.7
Version 4.8.0 - 2018-04-23
--------------------------
* Bug fixes (see mercurial logs for details)
* Ceil purchase request quantity
Version 4.6.0 - 2017-10-30
--------------------------
* Bug fixes (see mercurial logs for details)
Version 4.4.0 - 2017-05-01
--------------------------
* Bug fixes (see mercurial logs for details)
* Add warning for late customer moves
* Change supply period into TimeDelta
@@ -87,10 +98,12 @@ Version 4.4.0 - 2017-05-01
* Do not create purchase request if other order point exists
Version 4.2.0 - 2016-11-28
--------------------------
* Bug fixes (see mercurial logs for details)
* Add configuration for the supply period
Version 4.0.0 - 2016-05-02
--------------------------
* Bug fixes (see mercurial logs for details)
* Move purchase request to purchase_request module
* Add Python3 support
@@ -98,61 +111,76 @@ Version 4.0.0 - 2016-05-02
* Adding exception state on the purchase requests
Version 3.8.0 - 2015-11-02
--------------------------
* Bug fixes (see mercurial logs for details)
* Generate purchase requests even if rounding set the quantity to 0
* Add searcher on purchase_request's state
* Add default internal provisioning per location
Version 3.6.0 - 2015-04-20
--------------------------
* Bug fixes (see mercurial logs for details)
* Add support for PyPy
* Add relate from product to order points
Version 3.4.0 - 2014-10-20
--------------------------
* Bug fixes (see mercurial logs for details)
* Allow to calculate purchase requests filtered by warehouse
Version 3.2.0 - 2014-04-21
--------------------------
* Bug fixes (see mercurial logs for details)
Version 3.0.0 - 2013-10-21
--------------------------
* Bug fixes (see mercurial logs for details)
* Add wizard to create internal shipments
* Add warning for late supplier moves when creating purchase request
Version 2.8.0 - 2013-04-22
--------------------------
* Bug fixes (see mercurial logs for details)
* find_best_supplier doesn't optimize anymore on the delivery delay
Version 2.6.0 - 2012-10-22
--------------------------
* Bug fixes (see mercurial logs for details)
* Generate also purchase requests for assets
Version 2.4.0 - 2012-04-24
--------------------------
* Bug fixes (see mercurial logs for details)
* Warehouse is not always required
* get_shortage works on a list of products
* Group purchases using a key
Version 2.2.0 - 2011-10-25
--------------------------
* Bug fixes (see mercurial logs for details)
* Add wizard to create purchase requests
Version 2.0.0 - 2011-04-27
--------------------------
* Bug fixes (see mercurial logs for details)
Version 1.8.0 - 2010-11-01
--------------------------
* Bug fixes (see mercurial logs for details)
Version 1.6.0 - 2010-05-13
--------------------------
* Bug fixes (see mercurial logs for details)
Version 1.4.0 - 2009-10-19
--------------------------
* Bug fixes (see mercurial logs for details)
Version 1.2.0 - 2009-04-20
--------------------------
* Bug fixes (see mercurial logs for details)
* Allow egg installation
Version 1.0.0 - 2008-11-17
--------------------------
* Initial release
+107
View File
@@ -0,0 +1,107 @@
******
Design
******
The *Stock Supply Module* introduces or extends the following concepts:
.. _model-stock.location:
Location
========
When the *Stock Supply Module* is activated, the storage location gains new
properties that define the default provisioning and overflowing locations for
that particular location.
.. seealso::
The `Stock Location <stock:model-stock.location>` concept is introduced by
the :doc:`Stock Module <stock:index>`.
.. _model-stock.order_point:
Order Point
===========
The *Order Point* defines the replenishment policy for a product on a specific
location.
It established the quantity threshold that determines when stock should be
replenished or reduced in order to maintain desired inventory level.
The desired inventory level is defined as follows:
* :guilabel:`Minimal Quantity`: the level below which stock must be
replenished.
* :guilabel:`Target Quantity`: the level to which stock should be restored
after replenishment.
* :guilabel:`Maximal Quantity`: the level above which excess stock should be
moved.
There are two types of order point depending on how the replenishment is
handled:
Internal
--------
An *Internal* order point is defined for a storage location, using `internal
shipments <model-stock.shipment.internal>` as the replenishment method.
When stock falls below the minimum quantity, the system transfers stock from
the :guilabel:`Provisioning Location`.
When the stock rises above the maximum quantity, the system transfers the
excess stock to :guilabel:`Overflowing Location`.
Purchase
--------
A *Purchase* order point is defined on a `warehouse location
<stock:concept-stock.location.warehouse>`.
When the stock level falls below the minimum quantity, a `purchase request
<purchase_request:model-purchase.request>` is generated to replenish the
product from the supplier.
.. seealso::
The list of *Order Points* can be found by opening the main menu item:
|Inventory & Stock --> Order Points|__
.. |Inventory & Stock --> Order Points| replace:: :menuselection:`Inventory & Stock --> Order Points`
__ https://demo.tryton.org/model/stock.order_point
.. _model-purchase.configuration:
Purchase Configuration
======================
When the *Stock Supply Module* is activated, the purchase configuration gains a
new property that defines the replenishment period for stock levels for
`purchases <purchase:model-purchase.purchase>`.
.. seealso::
The `Purchase Configuration <purchase:model-purchase.configuration>` concept
is introduced by the :doc:`Purchase Module <purchase:index>`.
.. _wizard-stock.supply:
Supply
======
The *Supply* wizard automates product replenishment across `warehouses
<stock:concept-stock.location.warehouse>` according to `Order Points
<model-stock.order_point>`.
It calculates the stock level for each `product
<product:model-product.product>` in every warehouses every day over the
`supplier period <model-purchase.configuration>` for purchase and over the
`lead time <stock:model-stock.location.lead_time>` for internal shipment.
.. seealso::
The *Supply* wizard can be launched from the main menu:
|Inventory & Stock --> Supply Stock|__
.. |Inventory & Stock --> Supply Stock| replace:: :menuselection:`Inventory & Stock --> Supply Stock`
__ https://demo.tryton.org/wizard/stock.supply
+7 -42
View File
@@ -1,47 +1,12 @@
###################
Stock Supply Module
###################
The Stock Supply module add automatic supply mechanisms and introduce
the concepts of order point.
The *Stock Supply Module* adds automatic supply mechanisms and introduces the
concept of order points.
Order Point
***********
.. toctree::
:maxdepth: 2
An order point define minimum, maximum and target quantities for a product on a
location.
* The minimum quantity is the threshold quantity below which the provisioning
process will be triggered.
* The maximum quantity is the threshold quantity above which the overflowing
process will be triggered.
* The target quantity is the quantity that will be found in the location after
the provisioning / overflowing process has been completed.
An order point also define a type which can be:
* Internal
An Internal order point is defined on a Storage location, it also defines a
provisioning and/or an overflowing location. If the minimum quantity is
reached it will result in the creation of an internal shipment between the
provisioning location and the Storage location. If the maximum quantity is
reached it will result in the creation of an internal shipment between the
storage location and the overflowing location.
* Purchase
A Purchase order point is defined on a warehouse location. If the
minimal quantity is reached on the warehouse it will result in a
purchase request.
The internal shipments and purchase requests are created by the supply wizard
with respect to stock levels and existing shipments and requests. The
stock levels are computed between the next two supply dates computed over the
Supply Period from the configuration (default: 1 day). If the stock level of a
product without order point on the given warehouse is below zero, a purchase
request is also created. The same happens if the stock level of a storage
location with a provisioning location is below zero. Likewise, if the stock
level of a storage is above zero and an overflow location is defined on the
location then an internal shipment will be created.
design
releases
+7
View File
@@ -0,0 +1,7 @@
.. _releases-index:
=============
Release notes
=============
.. include:: ../CHANGELOG