Author: |
Camptocamp, BCIM, Akretion, Odoo Community Association (OCA) |
License: |
AGPL-3 |
Branch: |
13.0-ocabot-merge-pr-155-by-guewen-bump-patch |
Repository: |
OCA/wms |
Dependencies: |
auth_api_key,
base,
base_jsonify,
base_rest,
base_sparse_field,
component,
delivery,
product_expiry,
product_manufacturer,
product_packaging_type,
stock,
stock_picking_batch,
stock_picking_completion_info,
stock_quant_package_dimension,
stock_quant_package_product_packaging,
and
stock_storage_type |
Languages: |
HTML (440, 2.0%),
PO File (718, 3.2%),
Python (20358, 91.1%),
XML (681, 3.0%),
and
reStructuredText (159, 0.7%) |
Other branches: |
10.0,
13.0,
13.0-ocabot-merge-pr-157-by-guewen-bump-minor,
13.0-ocabot-merge-pr-63-by-simahawk-bump-patch,
13.0-ocabot-merge-pr-73-by-simahawk-bump-minor,
13.0-ocabot-merge-pr-77-by-simahawk-bump-patch,
14.0,
14.0-ocabot-merge-pr-177-by-simahawk-bump-nobump,
14.0-ocabot-update-dotfiles,
dependabot/npm_and_yarn/shopfloor_ui_tests/json5-1.0.2,
dependabot/npm_and_yarn/shopfloor_ui_tests/json5-and-vue/cli-service-2.2.3,
dependabot/npm_and_yarn/shopfloor_ui_tests/loader-utils-1.4.2,
dependabot/npm_and_yarn/shopfloor_ui_tests/minimist-1.2.6,
dependabot/npm_and_yarn/shopfloor_ui_tests/sideway/formula-3.0.1,
dependabot/npm_and_yarn/shopfloor_ui_tests/terser-5.14.2,
and
dependabot/npm_and_yarn/shopfloor_ui_tests/vuetify-2.6.10 |
Other repositories: |
Change2improve/wms,
Gabinete-Digital/wms,
NeatNerdPrime/wms,
SeuMarco/wms,
acsone/sale-workflow,
camptocamp/wms,
guewen/wms,
gurneyalex/wms,
kmee/wms,
and
sebalix/wms |
<h1 class="title">Shopfloor</h1>
<p><a class="reference external" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/wms/tree/13.0/shopfloor"><img alt="OCA/wms" src="https://img.shields.io/badge/github-OCA%2Fwms-lightgray.png?logo=github" /></a> <a class="reference external" href="https://translation.odoo-community.org/projects/wms-13-0/wms-13-0-shopfloor"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external" href="https://runbot.odoo-community.org/runbot/285/13.0"><img alt="Try me on Runbot" src="https://img.shields.io/badge/runbot-Try%20me-875A7B.png" /></a></p>
<p>Shopfloor is a barcode scanner application for internal warehouse operations.</p>
<p>The application supports scenarios, to relate to Operation Types:</p>
<ul class="simple">
<li>Cluster Picking</li>
<li>Zone Picking</li>
<li>Checkout/Packing</li>
<li>Delivery</li>
<li>Location Content Transfer</li>
<li>Single Pack Transfer</li>
</ul>
<p>This module provides REST APIs to support the scenarios. It needs a frontend
to consume the backend APIs and provide screens for users on barcode devices.
A default front-end application is provided by <code>shopfloor_mobile</code>.</p>
<div class="admonition important">
<p class="first admonition-title">Important</p>
<p class="last">This is an alpha version, the data model and design can change at any time without warning.
Only for development or testing purpose, do not use in production.
<a class="reference external" href="https://odoo-community.org/page/development-status">More details on development status</a></p>
</div>
<p><strong>Table of contents</strong></p>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><a class="reference internal" href="#configuration" id="id2">Configuration</a><ul>
<li><a class="reference internal" href="#profiles" id="id3">Profiles</a></li>
<li><a class="reference internal" href="#menus" id="id4">Menus</a></li>
<li><a class="reference internal" href="#logs-retention" id="id5">Logs retention</a></li>
</ul>
</li>
<li><a class="reference internal" href="#usage" id="id6">Usage</a></li>
<li><a class="reference internal" href="#known-issues-roadmap" id="id7">Known issues / Roadmap</a></li>
<li><a class="reference internal" href="#changelog" id="id8">Changelog</a></li>
<li><a class="reference internal" href="#bug-tracker" id="id9">Bug Tracker</a></li>
<li><a class="reference internal" href="#credits" id="id10">Credits</a><ul>
<li><a class="reference internal" href="#authors" id="id11">Authors</a></li>
<li><a class="reference internal" href="#contributors" id="id12">Contributors</a></li>
<li><a class="reference internal" href="#design" id="id13">Design</a></li>
<li><a class="reference internal" href="#other-credits" id="id14">Other credits</a></li>
<li><a class="reference internal" href="#maintainers" id="id15">Maintainers</a></li>
</ul>
</li>
</ul>
</div>
<a name="configuration"></a>
<h2><a class="toc-backref" href="#id2">Configuration</a></h2>
<a name="profiles"></a>
<h3><a class="toc-backref" href="#id3">Profiles</a></h3>
<p>In Inventory / Configuration / Shopfloor / Profiles.</p>
<p>The profiles are used to restrict which menus are shown on the frontend
application. When a user logs in the scanner application, they have to
select their profile, so the correct menus are shown.</p>
<a name="menus"></a>
<h3><a class="toc-backref" href="#id4">Menus</a></h3>
<p>In Inventory / Configuration / Shopfloor / Menus.</p>
<p>The menus are displayed on the frontend application and store the configuration
of the scenarios. Each menu must use a scenario and defines which Operation Types
they are allowed to process.</p>
<p>Their profile will restrict the visibility to the profile chosen on the device.
If a menu has no profile, it is shown in every profile.</p>
<p>Some scenarios may have additional options, which are explained in tooltips.</p>
<a name="logs-retention"></a>
<h3><a class="toc-backref" href="#id5">Logs retention</a></h3>
<p>Logs are kept in database for every REST requests made by a client application.
They can be used for debugging and monitoring of the activity.</p>
<p>The Logs menu is shown only with Developer tools (<code>?debug=1</code>) activated.</p>
<p>By default, Shopfloor logs are kept 30 days.
You can change the duration of the retention by changing the System Parameter
<code>shopfloor.log.retention.days</code>.</p>
<p>If the value is set to 0, the logs are not stored at all.</p>
<p>Logged data is: request URL and method, parameters, headers, result or error.</p>
<a name="usage"></a>
<h2><a class="toc-backref" href="#id6">Usage</a></h2>
<p>An API key is created in the Demo data (for development), using
the Demo user. The key to use in the HTTP header <code>API-KEY</code> is: 72B044F7AC780DAC</p>
<p>Curl example:</p>
<pre>
<code>curl -X POST "http://localhost:8069/shopfloor/user/menu" -H "accept: */*" -H "Content-Type: application/json" -H "API-KEY: 72B044F7AC780DAC"</code>
</pre>
<a name="known-issues-roadmap"></a>
<h2><a class="toc-backref" href="#id7">Known issues / Roadmap</a></h2>
<ul class="simple">
<li>improve documentation</li>
<li>split out scenario components to their own modules</li>
</ul>
<a name="changelog"></a>
<h2 class="with-subtitle"><a class="toc-backref" href="#id8">Changelog</a></h2>
<h2 class="section-subtitle" id="id1"><span class="section-subtitle">13.0.1.0.0</span></h2>
<p>First official version.</p>
<a name="bug-tracker"></a>
<h2><a class="toc-backref" href="#id9">Bug Tracker</a></h2>
<p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/wms/issues">GitHub Issues</a>.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us smashing it by providing a detailed and welcomed
<a class="reference external" href="https://github.com/OCA/wms/issues/new?body=module:%20shopfloor%0Aversion:%2013.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
<p>Do not contact contributors directly about support or help with technical issues.</p>
<a name="credits"></a>
<h2><a class="toc-backref" href="#id10">Credits</a></h2>
<a name="authors"></a>
<h3><a class="toc-backref" href="#id11">Authors</a></h3>
<ul class="simple">
<li>Camptocamp</li>
<li>BCIM</li>
<li>Akretion</li>
</ul>
<a name="contributors"></a>
<h3><a class="toc-backref" href="#id12">Contributors</a></h3>
<ul class="simple">
<li>Guewen Baconnier <<a class="reference external" href="mailto:guewen.baconnier@camptocamp.com">guewen.baconnier@camptocamp.com</a>></li>
<li>Simone Orsi <<a class="reference external" href="mailto:simahawk@gmail.com">simahawk@gmail.com</a>></li>
<li>Sébastien Alix <<a class="reference external" href="mailto:sebastien.alix@camptocamp.com">sebastien.alix@camptocamp.com</a>></li>
<li>Alexandre Fayolle <<a class="reference external" href="mailto:alexandre.fayolle@camptocamp.com">alexandre.fayolle@camptocamp.com</a>></li>
<li>Benoit Guillot <<a class="reference external" href="mailto:benoit.guillot@akretion.com">benoit.guillot@akretion.com</a>></li>
<li>Thierry Ducrest <<a class="reference external" href="mailto:thierry.ducrest@camptocamp.com">thierry.ducrest@camptocamp.com</a>></li>
</ul>
<a name="design"></a>
<h3><a class="toc-backref" href="#id13">Design</a></h3>
<ul class="simple">
<li>Joël Grand-Guillaume <<a class="reference external" href="mailto:joel.grandguillaume@camptocamp.com">joel.grandguillaume@camptocamp.com</a>></li>
<li>Jacques-Etienne Baudoux <<a class="reference external" href="mailto:je@bcim.be">je@bcim.be</a>></li>
</ul>
<a name="other-credits"></a>
<h3><a class="toc-backref" href="#id14">Other credits</a></h3>
<p><strong>Financial support</strong></p>
<ul class="simple">
<li>Cosanum</li>
<li>Camptocamp R&D</li>
<li>Akretion R&D</li>
</ul>
<a name="maintainers"></a>
<h3><a class="toc-backref" href="#id15">Maintainers</a></h3>
<p>This module is maintained by the OCA.</p>
<a class="reference external image-reference" href="https://odoo-community.org"><img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" /></a>
<p>OCA, or the Odoo Community Association, is a nonprofit organization whose
mission is to support the collaborative development of Odoo features and
promote its widespread use.</p>
<p>Current <a class="reference external" href="https://odoo-community.org/page/maintainer-role">maintainers</a>:</p>
<p><a class="reference external" href="https://github.com/guewen"><img alt="guewen" src="https://github.com/guewen.png?size=40px" /></a> <a class="reference external" href="https://github.com/simahawk"><img alt="simahawk" src="https://github.com/simahawk.png?size=40px" /></a> <a class="reference external" href="https://github.com/sebalix"><img alt="sebalix" src="https://github.com/sebalix.png?size=40px" /></a></p>
<p>This module is part of the <a class="reference external" href="https://github.com/OCA/wms/tree/13.0/shopfloor">OCA/wms</a> project on GitHub.</p>
<p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
Dependency Graph