<h1 class="title">Shopfloor Base</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/lgpl-3.0-standalone.html"><img alt="License: LGPL-3" src="https://img.shields.io/badge/licence-LGPL--3-blue.png" /></a> <a class="reference external" href="https://github.com/OCA/wms/tree/14.0/shopfloor_base"><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-14-0/wms-14-0-shopfloor_base"><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/14.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.</p> <p>This module provides REST APIs to support scenario. 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_base</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="#shopfloor-config-menu" id="id3">Shopfloor config menu</a></li> <li><a class="reference internal" href="#profiles" id="id4">Profiles</a></li> <li><a class="reference internal" href="#menus" id="id5">Menus</a></li> <li><a class="reference internal" href="#scenario" id="id6">Scenario</a></li> </ul> </li> <li><a class="reference internal" href="#usage" id="id7">Usage</a></li> <li><a class="reference internal" href="#known-issues-roadmap" id="id8">Known issues / Roadmap</a></li> <li><a class="reference internal" href="#changelog" id="id9">Changelog</a></li> <li><a class="reference internal" href="#bug-tracker" id="id10">Bug Tracker</a></li> <li><a class="reference internal" href="#credits" id="id11">Credits</a><ul> <li><a class="reference internal" href="#authors" id="id12">Authors</a></li> <li><a class="reference internal" href="#contributors" id="id13">Contributors</a></li> <li><a class="reference internal" href="#design" id="id14">Design</a></li> <li><a class="reference internal" href="#other-credits" id="id15">Other credits</a></li> <li><a class="reference internal" href="#maintainers" id="id16">Maintainers</a></li> </ul> </li> </ul> </div> <a name="configuration"></a> <h2><a class="toc-backref" href="#id2">Configuration</a></h2> <a name="shopfloor-config-menu"></a> <h3><a class="toc-backref" href="#id3">Shopfloor config menu</a></h3> <p>In the main menu (or home screen) click on &quot;Shopfloor&quot;.</p> <a name="profiles"></a> <h3><a class="toc-backref" href="#id4">Profiles</a></h3> <p>In 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="#id5">Menus</a></h3> <p>In Shopfloor / Menus.</p> <p>The menus are displayed on the frontend application. The configuration may come from the menu itself and/or from the scenario linked to it.</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 scenario may have additional options.</p> <a name="scenario"></a> <h3><a class="toc-backref" href="#id6">Scenario</a></h3> <p>In Shopfloor / Scenario.</p> <p>A Scenario represents a flow (or more basically &quot;something to do&quot; with the app. Each scenario must have a name and a unique key. The key must match a registered shopfloor service component.</p> <a name="usage"></a> <h2><a class="toc-backref" href="#id7">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 &quot;http://localhost:8069/shopfloor/user/menu&quot; -H &quot;accept: */*&quot; -H &quot;Content-Type: application/json&quot; -H &quot;API-KEY: 72B044F7AC780DAC&quot;</code> </pre> <a name="known-issues-roadmap"></a> <h2><a class="toc-backref" href="#id8">Known issues / Roadmap</a></h2> <ul class="simple"> <li>improve documentation</li> <li>change shopfloor.scenario.key to selection? See comment in model</li> </ul> <a name="changelog"></a> <h2 class="with-subtitle"><a class="toc-backref" href="#id9">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="#id10">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_base%0Aversion:%2014.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="#id11">Credits</a></h2> <a name="authors"></a> <h3><a class="toc-backref" href="#id12">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="#id13">Contributors</a></h3> <ul class="simple"> <li>Guewen Baconnier &lt;<a class="reference external" href="mailto:guewen.baconnier&#64;camptocamp.com">guewen.baconnier&#64;camptocamp.com</a>&gt;</li> <li>Simone Orsi &lt;<a class="reference external" href="mailto:simahawk&#64;gmail.com">simahawk&#64;gmail.com</a>&gt;</li> <li>Sébastien Alix &lt;<a class="reference external" href="mailto:sebastien.alix&#64;camptocamp.com">sebastien.alix&#64;camptocamp.com</a>&gt;</li> <li>Alexandre Fayolle &lt;<a class="reference external" href="mailto:alexandre.fayolle&#64;camptocamp.com">alexandre.fayolle&#64;camptocamp.com</a>&gt;</li> <li>Benoit Guillot &lt;<a class="reference external" href="mailto:benoit.guillot&#64;akretion.com">benoit.guillot&#64;akretion.com</a>&gt;</li> <li>Thierry Ducrest &lt;<a class="reference external" href="mailto:thierry.ducrest&#64;camptocamp.com">thierry.ducrest&#64;camptocamp.com</a>&gt;</li> </ul> <a name="design"></a> <h3><a class="toc-backref" href="#id14">Design</a></h3> <ul class="simple"> <li>Joël Grand-Guillaume &lt;<a class="reference external" href="mailto:joel.grandguillaume&#64;camptocamp.com">joel.grandguillaume&#64;camptocamp.com</a>&gt;</li> <li>Jacques-Etienne Baudoux &lt;<a class="reference external" href="mailto:je&#64;bcim.be">je&#64;bcim.be</a>&gt;</li> </ul> <a name="other-credits"></a> <h3><a class="toc-backref" href="#id15">Other credits</a></h3> <p><strong>Financial support</strong></p> <ul class="simple"> <li>Cosanum</li> <li>Camptocamp R&amp;D</li> <li>Akretion R&amp;D</li> <li>ACSONE R&amp;D</li> </ul> <a name="maintainers"></a> <h3><a class="toc-backref" href="#id16">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/14.0/shopfloor_base">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>