==============
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/OCA/wms",
"name": "odoo14-addon-shopfloor-base",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Camptocamp, BCIM, Akretion, Odoo Community Association (OCA)",
"author_email": "support@odoo-community.org",
"download_url": "",
"platform": null,
"description": "==============\nShopfloor Base\n==============\n\n.. \n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! This file is generated by oca-gen-addon-readme !!\n !! changes will be overwritten. !!\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n !! source digest: sha256:d6d8a7546de7681fd9ea7cb9e0c80e24840b709118ef653c3685c98ff6ea137b\n !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!\n\n.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png\n :target: https://odoo-community.org/page/development-status\n :alt: Beta\n.. |badge2| image:: https://img.shields.io/badge/licence-LGPL--3-blue.png\n :target: http://www.gnu.org/licenses/lgpl-3.0-standalone.html\n :alt: License: LGPL-3\n.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fwms-lightgray.png?logo=github\n :target: https://github.com/OCA/wms/tree/14.0/shopfloor_base\n :alt: OCA/wms\n.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png\n :target: https://translation.odoo-community.org/projects/wms-14-0/wms-14-0-shopfloor_base\n :alt: Translate me on Weblate\n.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png\n :target: https://runboat.odoo-community.org/builds?repo=OCA/wms&target_branch=14.0\n :alt: Try me on Runboat\n\n|badge1| |badge2| |badge3| |badge4| |badge5|\n\nShopfloor is a barcode scanner application.\n\nThis module provides REST APIs to support scenario. It needs a frontend\nto consume the backend APIs and provide screens for users on barcode devices.\nA default front-end application is provided by ``shopfloor_mobile_base``.\n\n**Table of contents**\n\n.. contents::\n :local:\n\nConfiguration\n=============\n\nShopfloor config menu\n~~~~~~~~~~~~~~~~~~~~~\n\nIn the main menu (or home screen) click on \"Shopfloor\".\n\n\nProfiles\n~~~~~~~~\n\nIn Shopfloor / Profiles.\n\nThe profiles are used to restrict which menus are shown on the frontend\napplication. When a user logs in the scanner application, they have to\nselect their profile, so the correct menus are shown.\n\nMenus\n~~~~~\n\nIn Shopfloor / Menus.\n\nThe menus are displayed on the frontend application.\nThe configuration may come from the menu itself\nand/or from the scenario linked to it.\n\nTheir profile will restrict the visibility to the profile chosen on the device.\nIf a menu has no profile, it is shown in every profile.\n\nSome scenario may have additional options.\n\n\nScenario\n~~~~~~~~\n\nIn Shopfloor / Scenario.\n\nA Scenario represents a flow (or more basically \"something to do\" with the app.\nEach scenario must have a name and a unique key.\nThe key must match a registered shopfloor service component.\n\nUsage\n=====\n\nAn API key is created in the Demo data (for development), using\nthe Demo user. The key to use in the HTTP header ``API-KEY`` is: 72B044F7AC780DAC\n\nCurl example::\n\n curl -X POST \"http://localhost:8069/shopfloor/user/menu\" -H \"accept: */*\" -H \"Content-Type: application/json\" -H \"API-KEY: 72B044F7AC780DAC\"\n\nKnown issues / Roadmap\n======================\n\n* improve documentation\n* change shopfloor.scenario.key to selection? See comment in model\n\nChangelog\n=========\n\n13.0.1.0.0\n~~~~~~~~~~\n\nFirst official version.\n\nBug Tracker\n===========\n\nBugs are tracked on `GitHub Issues <https://github.com/OCA/wms/issues>`_.\nIn case of trouble, please check there if your issue has already been reported.\nIf you spotted it first, help us to smash it by providing a detailed and welcomed\n`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**>`_.\n\nDo not contact contributors directly about support or help with technical issues.\n\nCredits\n=======\n\nAuthors\n~~~~~~~\n\n* Camptocamp\n* BCIM\n* Akretion\n\nContributors\n~~~~~~~~~~~~\n\n* Guewen Baconnier <guewen.baconnier@camptocamp.com>\n* Simone Orsi <simahawk@gmail.com>\n* S\u00e9bastien Alix <sebastien.alix@camptocamp.com>\n* Alexandre Fayolle <alexandre.fayolle@camptocamp.com>\n* Benoit Guillot <benoit.guillot@akretion.com>\n* Thierry Ducrest <thierry.ducrest@camptocamp.com>\n* Michael Tietz (MT Software) <mtietz@mt-software.de>\n\nDesign\n~~~~~~\n\n* Jo\u00ebl Grand-Guillaume <joel.grandguillaume@camptocamp.com>\n* Jacques-Etienne Baudoux <je@bcim.be>\n\nOther credits\n~~~~~~~~~~~~~\n\n**Financial support**\n\n* Cosanum\n* Camptocamp R&D\n* Akretion R&D\n* ACSONE R&D\n\n**Icons**\n\n* Tablet app icon by Gregor Cresnar from the Noun Project\n\nMaintainers\n~~~~~~~~~~~\n\nThis module is maintained by the OCA.\n\n.. image:: https://odoo-community.org/logo.png\n :alt: Odoo Community Association\n :target: https://odoo-community.org\n\nOCA, or the Odoo Community Association, is a nonprofit organization whose\nmission is to support the collaborative development of Odoo features and\npromote its widespread use.\n\n.. |maintainer-guewen| image:: https://github.com/guewen.png?size=40px\n :target: https://github.com/guewen\n :alt: guewen\n.. |maintainer-simahawk| image:: https://github.com/simahawk.png?size=40px\n :target: https://github.com/simahawk\n :alt: simahawk\n.. |maintainer-sebalix| image:: https://github.com/sebalix.png?size=40px\n :target: https://github.com/sebalix\n :alt: sebalix\n\nCurrent `maintainers <https://odoo-community.org/page/maintainer-role>`__:\n\n|maintainer-guewen| |maintainer-simahawk| |maintainer-sebalix| \n\nThis module is part of the `OCA/wms <https://github.com/OCA/wms/tree/14.0/shopfloor_base>`_ project on GitHub.\n\nYou are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.\n\n\n",
"bugtrack_url": null,
"license": "LGPL-3",
"summary": "Core module for creating mobile apps",
"version": "14.0.2.11.1",
"project_urls": {
"Homepage": "https://github.com/OCA/wms"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "add31d43864ffb0e2fecf17b620abe42b2d802f5a7c76b4ed821f081ba662487",
"md5": "bf5e07e19d764080bc2c29f4d02a96d5",
"sha256": "c35905b9657302b94ce24ad56813e63305222a67bc895ea6b703d4cc950174a8"
},
"downloads": -1,
"filename": "odoo14_addon_shopfloor_base-14.0.2.11.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf5e07e19d764080bc2c29f4d02a96d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 90212,
"upload_time": "2024-01-27T09:50:28",
"upload_time_iso_8601": "2024-01-27T09:50:28.265265Z",
"url": "https://files.pythonhosted.org/packages/ad/d3/1d43864ffb0e2fecf17b620abe42b2d802f5a7c76b4ed821f081ba662487/odoo14_addon_shopfloor_base-14.0.2.11.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-27 09:50:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "OCA",
"github_project": "wms",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "odoo14-addon-shopfloor-base"
}
JSON
