# Shopfloor

Shopfloor is a barcode scanner application for internal warehouse operations.

The application supports scenarios, to relate to Operation Types:

- Cluster Picking
- Zone Picking
- Checkout/Packing
- Delivery
- Location Content Transfer
- Single Pack Transfer

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 `shopfloor_mobile`.

Important

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. More details on development status

Table of contents

- Configuration
  - Profiles
  - Menus
  - Logs retention
- Usage
- Known issues / Roadmap
- Changelog
  - 13.0.1.0.0
- Bug Tracker
- Credits
  - Authors
  - Contributors
  - Design
  - Other credits
  - Maintainers

# Configuration

## Profiles

In Inventory / Configuration / 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 Inventory / Configuration / Shopfloor / Menus.

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.

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 scenarios may have additional options, which are explained in tooltips.

## Logs retention

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.

The Logs menu is shown only with Developer tools (`?debug=1`) activated.

By default, Shopfloor logs are kept 30 days. You can change the duration of the retention by changing the System Parameter `shopfloor.log.retention.days`.

If the value is set to 0, the logs are not stored at all.

Logged data is: request URL and method, parameters, headers, result or error.

# 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
- split out scenario components to their own modules

# Changelog

## 13.0.1.0.0

First official version.

# Bug Tracker

Bugs are tracked on GitHub Issues. 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 feedback.

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>

## 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

## Maintainers

This module is maintained by the OCA.

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.

Current maintainers:

This module is part of the OCA/wms project on GitHub.

You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.