<a class="reference external image-reference" 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.svg"> </a> <a name="stock-scanner-workflow-engine-for-scanner-hardware"></a> <h2>Stock Scanner : WorkFlow engine for scanner hardware</h2> <p>This module allows managing barcode readers with simple scenarios:</p> <ul class="simple"> <li>You can define a workflow for each object (stock picking, inventory, sale, etc)</li> <li>Works with all scanner hardware model (just SSH client required)</li> </ul> <p>Some demo/tutorial scenarios are available in the &quot;demo&quot; directory of the module. These scenarios, are automatically imported when installing a new database with demo data.</p> <a name="installation"></a> <h3>Installation</h3> <p>The <cite>odoo-sentinel</cite> specific client can be installed from pip:</p> <blockquote> $ pip install odoo-sentinel</blockquote> <p>This application is a separate client, and can be run on any device.</p> <p>For mobile devices, like Windows Mobile or Android smart barcode scanners, we usually install it on a server, accessed through SSH.</p> <p>To test the module, some modules provide scenario.</p> <a name="configuration"></a> <h3>Configuration</h3> <a name="in-odoo"></a> <h4>In Odoo</h4> <a name="declare-hardware"></a> <h5>Declare hardware</h5> <p>You have to declare some hardware scanners in Odoo.</p> <p>Go to &quot;Inventory &gt; Configuration &gt; Scanner Configuration &gt; Scanner Hardware&quot; and create a new record.</p> <p>The &quot;step type code&quot; sent by the &quot;odoo-sentinel&quot; client at start-up is the IP address of the hardware, if connected through SSH.</p> <a name="if-needed-enable-login-logout"></a> <h5>If needed enable Login/Logout</h5> <p>The module comes with 2 predefined scenarii for Login and Logout. The functionality is disabled by default and the user to use in Odoo must be specified in the <cite>.odoorpcrc</cite> file used by odoo-sentinel and can be overriden on the Scanner Hardware definition in Odoo.</p> <p>If the Login/logout functionality is enabled, when a user starts a session with odoo-sentinel, only the Login scenario is displayed on the screen. The scenario will prompt the user for its login and pwd. If the authentication succeeds, each interaction with Odoo will be done using the uid of the connected user. Once connected, a Logout scenario is displayed in the list of available scenarii and the Login scenario no longer appears.</p> <p>The Login/logout functionality enables you to specify on the scenario a list of users and/or a list of groups with access to the scenario.</p> <dl class="docutils"> <dt>To enable the Login/logout functionality:</dt> <dd><ul class="first last simple"> <li>Go to &quot;Settings &gt; Warehouse&quot; and check the checkbox Login/logout scenarii enabled.</li> <li>Create a <em>Technical User</em> 'sentinel' <strong>without roles in Human Resources</strong> and with 'Sentinel: technical users' checked.</li> <li>Use this user to launch your odoo-sentinel session.</li> </ul> </dd> </dl> <p>Be careful, the role <em>Sentinel: technical users</em> is a technical role and should only be used by sentinel.</p> <p>The timeout of sessions is managed by a dedicated cron that resets the inactive sessions. The timeout can be configured on settings. &quot;Settings &gt; Warehouse&quot;</p> <a name="for-the-odoo-sentinel-client"></a> <h4>For the odoo-sentinel client</h4> <p>The odoo-sentinel client uses an OdooRPC profile to connect to Odoo. The default configuration file is <cite>~/.odoorpcrc</cite>, but this can be customized, using the <cite>-c</cite>/<cite>--config</cite> argument. See the <cite>hardware/odoorpcrc.sample</cite> file for an example.</p> <p>If the <cite>-p</cite>/<cite>--profile</cite> argument is not given on the command line, a profile named <cite>sentinel</cite> will be used.</p> <p>The file used to log errors can be defined by using the <cite>-l</cite>/<cite>--log-file</cite> argument, which defaults to <cite>~/sentinel.log</cite>.</p> <p><strong>Note</strong> : If you want to copy the application outside this git repository, you will need to copy the i18n folder too.</p> <a name="autoconfiguration-feature"></a> <h5>Autoconfiguration feature</h5> <p>The <cite>odoo-sentinel</cite> client has an autoconfiguration feature, used to automatically recognize the hardware being connected. During initialization, the <cite>odoo-sentinel</cite> client tries to detect an SSH connection, and sends the terminal's IP address as terminal code. If the IP address is found on the <cite>code</cite> field on a configured hardware in the database, this hardware configuration will automatically be used. If the IP address is not found, the client will ask the user to type (or scan) a code.</p> <p>This can be used only if the Odoo server and the connected hardware are on the same network.</p> <a name="writing-scenario"></a> <h4>Writing scenario</h4> <a name="creation"></a> <h5>Creation</h5> <p>The preferred way to start the creation of a scenario is to create steps and transitions in diagram view.</p> <p>Once your steps are created, you can write python code directly from Odoo, or you can export the scenario to write the python code with your preferred code editor.</p> <dl class="docutils"> <dt>In the python code of each step, some variables are available :</dt> <dd><ul class="first last simple"> <li>cr : Cursor to the database</li> <li>uid : ID of the user executing the step (user used to log in with the sentinel, or user configured on the hardware, if any)</li> <li>pool : Pooler to the database</li> <li>env : Environment used to execute the scenario (new API)</li> <li>model : Pooler on the model configured on the scenario</li> <li>term : Recordset on the current scenario</li> <li>context : Context used on the step</li> <li>m or message : Last message sent by the hardware</li> <li>t or terminal : Browse record on the hardware executing the step</li> <li>tracer : Value of the tracer of the used transition to access this step</li> <li>wkf or workflow : Workflow service</li> <li>scenario : Recordset on the current scenario for the hardware</li> <li>_ : The translation function provided by Odoo (useable like in any other python file)</li> </ul> </dd> </dl> <p>Some of these variables are also available on transition conditions execution.</p> <p>As stated previously, the step must always return:</p> <ul class="simple"> <li>A step type code, in the <cite>act</cite> variable</li> <li>A message to display on the hardware screen, in the <cite>res</cite> variable</li> <li>Optionally, a default value, in the <cite>val</cite> variable</li> </ul> <a name="step-types"></a> <h5>Step types</h5> <p>The step types are mostly managed by the client.</p> <p>The standard step types are :</p> <ul class="simple"> <li>M : Simple message</li> <li>F : Final step, like M, but ends the scenario</li> <li>T : Text input</li> <li>N : Number input (integer)</li> <li>Q : Quantity input (float)</li> <li>L : List</li> <li>E : Error message, like M, but displayed with different colors</li> <li>C : Confirm input</li> <li>A : Automatic step. This type is used to automatically execute the next step</li> </ul> <div class="admonition note"> <p class="first admonition-title">Note</p> <p class="last">The automatic step often needs to define a value in <cite>val</cite>, corresponding to the value the user must send. This step type is generally used as replacement of another type, at the end of the step code, by redefining the <cite>act</cite> variable in some cases, for example when a single value is available for a list step.</p> </div> <a name="import"></a> <h5>Import</h5> <p>Scenarios are automatically imported on a module update, like any other data. You just have to add the path to your <cite>Scenario_Name.scenario</cite> files in the <cite>data</cite> or <cite>demo</cite> sections in the <cite>__manifest__.py</cite> file.</p> <a name="export"></a> <h5>Export</h5> <p>The export script is in the <cite>script</cite> directory of the module</p> <dl class="docutils"> <dt>A scenario is exported as a set of files, containing :</dt> <dd><ul class="first last simple"> <li>Scenario_Name.scenario : Global description of the scenario (name, warehouses, steps, transitions, etc.)</li> <li>A .py file per step : The name of the file is the XML ID of the step</li> </ul> </dd> </dl> <a name="using-a-test-file"></a> <h5>Using a test file</h5> <p>When developing scenarios, you will often have the same steps to run. The odoo-sentinel client allows you to supply a file, which contains the keys pressed during the scenario.</p> <p>You can define the file to use in the <cite>-t</cite>/<cite>--test-file</cite> argument. This file will be read instead of calling the curses methods when the scenario is waiting for a user input (including line feed characters). When the file has been fully read, the client exits.</p> <p>A sample test file can be found in the &quot;Step Types&quot; demo scenario.</p> <p><em>Special keys</em> : For special keys (arrows, delete, etc.), you must write a line containing ':', followed by the curses key code.</p> <dl class="docutils"> <dt>Valid key codes are :</dt> <dd><ul class="first last simple"> <li>KEY_DOWN : Down arrow</li> <li>KEY_UP : Up arrow</li> <li>KEY_LEFT : Left arrow</li> <li>KEY_RIGHT : Right arrow</li> <li>KEY_BACKSPACE : Backspace</li> <li>KEY_DC : Delete</li> </ul> </dd> </dl> <a name="usage"></a> <h3>Usage</h3> <p>On start-up, the client lists available scenarii. When the user selects a scenario, the current scenario and step are stored on the hardware configuration's entry in Odoo.</p> <p>When the client sends a message to the server, the next step is selected depending on the current step and the message sent. Then, the server returns the result of the step, which contains its type code and the text to display on the hardware screen. Unlike the standard Odoo Workflow, each step needs to find a valid transition, because a step needs to be displayed on the hardware screen at all times.</p> <a class="reference external image-reference" href="https://runbot.odoo-community.org/runbot/154/12.0"><img alt="Try me on Runbot" src="https://odoo-community.org/website/image/ir.attachment/5784_f2813bd/datas" /></a> <p>A client for the Datalogic PowerScan scanners was developped for a very early version or this module. The files have been removed, but are still available in the <a class="reference external" href="https://github.com/OCA/stock-logistics-workflow/tree/527f033e9d31fe822562d4716104f37f6ce1f88c/stock_scanner/hardware/datalogic/PowerScan">git repository history</a>.</p> <a name="bug-tracker"></a> <h3>Bug Tracker</h3> <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/stock-logistics-workflow/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/stock-logistics-workflow/issues/new?body=module:%20stock_scanner%0Aversion:%208.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p> <a name="credits"></a> <h3>Credits</h3> <a name="images"></a> <h4>Images</h4> <ul class="simple"> <li>Odoo Community Association: <a class="reference external" href="https://github.com/OCA/maintainer-tools/blob/master/template/module/static/description/icon.svg">Icon</a>.</li> </ul> <a name="contributors"></a> <h4>Contributors</h4> <ul class="simple"> <li>Alexandre Fayolle &lt;<a class="reference external" href="mailto:afayolle.ml&#64;free.fr">afayolle.ml&#64;free.fr</a>&gt;</li> <li>Christophe CHAUVET &lt;<a class="reference external" href="mailto:christophe.chauvet&#64;syleam.fr">christophe.chauvet&#64;syleam.fr</a>&gt;</li> <li>Damien Crier &lt;<a class="reference external" href="mailto:damien&#64;crier.me">damien&#64;crier.me</a>&gt;</li> <li>Laetitia Gangloff &lt;<a class="reference external" href="mailto:laetitia.gangloff&#64;acsone.eu">laetitia.gangloff&#64;acsone.eu</a>&gt;</li> <li>Laurent Mignon &lt;<a class="reference external" href="mailto:laurent.mignon&#64;acsone.eu">laurent.mignon&#64;acsone.eu</a>&gt;</li> <li>Olivier Dony &lt;<a class="reference external" href="mailto:odo&#64;openerp.com">odo&#64;openerp.com</a>&gt;</li> <li>Sebastien LANGE &lt;<a class="reference external" href="mailto:sebastien.lange&#64;syleam.fr">sebastien.lange&#64;syleam.fr</a>&gt;</li> <li>Sylvain Garancher &lt;<a class="reference external" href="mailto:sylvain.garancher&#64;syleam.fr">sylvain.garancher&#64;syleam.fr</a>&gt;</li> </ul> <a name="maintainer"></a> <h4>Maintainer</h4> <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>This module is maintained by the OCA.</p> <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>To contribute to this module, please visit <a class="reference external" href="https://odoo-community.org">https://odoo-community.org</a>.</p>