==============
Shopfloor Base
..
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! This file is generated by oca-gen-addon-readme !!
!! changes will be overwritten. !!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
!! source digest: sha256:d6d8a7546de7681fd9ea7cb9e0c80e24840b709118ef653c3685c98ff6ea137b
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
:target: https://odoo-community.org/page/development-status
:alt: Beta
.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png
:target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html
:alt: License: LGPL-3
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fwms-lightgray.png?logo=github
:target: https://github.com/OCA/wms/tree/14.0/shopfloor_base
:alt: OCA/wms
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
:target: https://translation.odoo-community.org/projects/wms-14-0/wms-14-0-shopfloor_base
:alt: Translate me on Weblate
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
:target: https://runboat.odoo-community.org/builds?repo=OCA/wms&target_branch=14.0
:alt: Try me on Runboat
|badge1| |badge2| |badge3| |badge4| |badge5|
Shopfloor is a barcode scanner application.
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 shopfloor_mobile_base
.
Table of contents
.. contents::
:local:
Configuration
Shopfloor config menu
In the main menu (or home screen) click on "Shopfloor".
Profiles
~~~~~~~~
In Shopfloor / Profiles.
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.
Menus
~~~~~
In Shopfloor / Menus.
The menus are displayed on the frontend application.
The configuration may come from the menu itself
and/or from the scenario linked to it.
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.
Some scenario may have additional options.
Scenario
~~~~~~~~
In Shopfloor / Scenario.
A Scenario represents a flow (or more basically "something to do" with the app.
Each scenario must have a name and a unique key.
The key must match a registered shopfloor service component.
Usage
=====
An API key is created in the Demo data (for development), using
the Demo user. The key to use in the HTTP header ``API-KEY`` is: 72B044F7AC780DAC
Curl example::
curl -X POST "http://localhost:8069/shopfloor/user/menu" -H "accept: */*" -H "Content-Type: application/json" -H "API-KEY: 72B044F7AC780DAC"
Known issues / Roadmap
======================
* improve documentation
* change shopfloor.scenario.key to selection? See comment in model
Changelog
=========
13.0.1.0.0
~~~~~~~~~~
First official version.
Bug Tracker
===========
Bugs are tracked on `GitHub Issues <https://github.com/OCA/wms/issues>`_.
In case of trouble, please check there if your issue has already been reported.
If you spotted it first, help us to smash it by providing a detailed and welcomed
`feedback <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**>`_.
Do not contact contributors directly about support or help with technical issues.
Credits
=======
Authors
~~~~~~~
* Camptocamp
* BCIM
* Akretion
Contributors
~~~~~~~~~~~~
* Guewen Baconnier <guewen.baconnier@camptocamp.com>
* Simone Orsi <simahawk@gmail.com>
* Sébastien Alix <sebastien.alix@camptocamp.com>
* Alexandre Fayolle <alexandre.fayolle@camptocamp.com>
* Benoit Guillot <benoit.guillot@akretion.com>
* Thierry Ducrest <thierry.ducrest@camptocamp.com>
* Michael Tietz (MT Software) <mtietz@mt-software.de>
Design
~~~~~~
* Joël Grand-Guillaume <joel.grandguillaume@camptocamp.com>
* Jacques-Etienne Baudoux <je@bcim.be>
Other credits
~~~~~~~~~~~~~
**Financial support**
* Cosanum
* Camptocamp R&D
* Akretion R&D
* ACSONE R&D
**Icons**
* Tablet app icon by Gregor Cresnar from the Noun Project
Maintainers
~~~~~~~~~~~
This module is maintained by the OCA.
.. image:: https://odoo-community.org/logo.png
:alt: Odoo Community Association
:target: https://odoo-community.org
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.
.. |maintainer-guewen| image:: https://github.com/guewen.png?size=40px
:target: https://github.com/guewen
:alt: guewen
.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px
:target: https://github.com/simahawk
:alt: simahawk
.. |maintainer-sebalix| image:: https://github.com/sebalix.png?size=40px
:target: https://github.com/sebalix
:alt: sebalix
Current `maintainers <https://odoo-community.org/page/maintainer-role>`__:
|maintainer-guewen| |maintainer-simahawk| |maintainer-sebalix|
This module is part of the `OCA/wms <https://github.com/OCA/wms/tree/14.0/shopfloor_base>`_ project on GitHub.
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.