[IMP] barcode: add nomenclature example

closes odoo/documentation#10323

Signed-off-by: Felicia Kuan (feku) <feku@odoo.com>
Co-authored-by: ksc-odoo <73958186+ksc-odoo@users.noreply.github.com>
Co-authored-by: Sam Lieber (sali) <36018073+samueljlieber@users.noreply.github.com>

content/applications/inventory_and_mrp/barcode/operations/barcode_nomenclature.rst

@@ -1,84 +1,240 @@
-========
+============================
-Overview
+Default barcode nomenclature
-========
+============================
 
-There are different situations in which barcode nomenclatures can be
+.. |UPC| replace:: :abbr:`UPC (Universal Product Code)`
-useful. A well-known use case is the one of a point of sale which sells
+.. |EAN| replace:: :abbr:`EAN (European Article Number)`
-products in bulk, in which the customers will scale their products
+.. |GTIN| replace:: :abbr:`GTIN (Global Trade Item Number)`
-themselves and get the printed barcode to stick on the product. This
+.. |GTINs| replace:: :abbr:`GTINs (Global Trade Item Numbers)`
-barcode will contain the weight of the product and help compute the
-price accordingly.
 
-Create a Barcode Nomenclature
+Define *barcode nomenclatures* to ensure Odoo correctly recognizes and categorizes barcodes. When
-=============================
+scanned, a barcode matches the **first** rule with a matching pattern, based on regular expressions.
+A barcode is successfully read if its prefix and/or length matches the defined rule.
 
-Odoo supports Barcode Nomenclatures, which determine the mapping and
+For instance, at a :doc:`Point of Sale <../../../sales/point_of_sale>` station, product weight
-interpretation of the encoded information. You can configure your barcode nomenclature being in
+barcodes in the European Article Number (EAN) format, which begin with `21` and have five digits
-:ref:`developer mode <developer-mode>`.
+specifying the weight, are used to weigh products and generate a barcode depicting the weight and
-To do so, go to :menuselection:`Inventory --> Configuration --> Barcode Nomenclature`.
+price. The `21` and five-digit weight is the barcode pattern used to identify the barcode and can be
-
+customized to ensure Odoo correctly interprets all barcodes for the business.
-You can create a barcode nomenclature from there, and then add a line to
-create your first rule.
-
-.. image:: barcode_nomenclature/barcode_nomenclature_01.png
-    :align: center
-
-The first step is to specify the **rule name**, for example Weight
-Barcode with 3 Decimals. You then have to specify the type for barcode
-nomenclature, in our case it will be Weighted Product.
-
-.. image:: barcode_nomenclature/barcode_nomenclature_02.png
-    :align: center
-
-The Barcode Pattern is a regular expression that defines the structure
-of the barcode. In this example 21 defines the products on which the
-rule will be applied, those are the numbers by which the product barcode
-should start. The 5 “dots” are the following numbers of the product
-barcode and are there simply to identify the product in question. The
-“N” define a number and the “D” define the decimals.
-
-The encoding allows to specify the barcode encoding on which the rule
-should be applied.
 
 .. note::
-        You can define different rules and order their priority thanks to the
+   Barcodes are also commonly used with Odoo's **Inventory** and **Barcode** apps.
-        sequence. The first rule which matches the scanned barcode will be
-        applied.
 
-Configure your Product
+Odoo **Barcode** supports |EAN|, Universal Product Code (UPC), and :doc:`GS1 <gs1_nomenclature>`
-----------------------
+formats. This document exclusively focuses on :ref:`default rules and patterns in Odoo
+<barcode/operations/default-nomenclature-list>`, which use |UPC| and |EAN| encoding.
 
-1. The barcode of the product should start by “21”;
+.. important::
-2. The 5 “dots” are the other numbers of your product barcode, allowing to identify the product;
-3. The barcode should contain 0’s where you did defined D’s or N’s. In our case we need to set 5 zeros because we configured “21…..{NNDDD}”;
-4. In EAN-13, the last number is a check number, use an EAN13 generator to know which digit it should be in your case.
 
-.. image:: barcode_nomenclature/barcode_nomenclature_03.png
+   To use |UPC| and |EAN| barcodes for uniquely identifying products across the entire supply chain,
+   they **must** be `purchased from GS1 <https://www.gs1.org/standards/get-barcodes>`_.
+
+   In Odoo, custom barcode patterns can be defined to recognize barcodes specific to the company.
+   Barcodes do not need to be purchased if used only within the company, such as in the
+   :ref:`example <barcode/operations/product-weight>` where the barcode is written in the |EAN|
+   format.
+
+Configuration
+=============
+
+To use default nomenclature, navigate to :menuselection:`Inventory app --> Configuration -->
+Settings`. Under the :guilabel:`Barcode` section, tick the :guilabel:`Barcode Scanner` checkbox.
+Doing so installs the **Barcode** app in the database.
+
+Next, in the :guilabel:`Barcode Nomenclature` field, ensure :guilabel:`Default Nomenclature` is
+selected. Then, click :guilabel:`Save`.
+
+.. image:: barcode_nomenclature/enable-nomenclature.png
    :align: center
+   :alt: Enabled barcode setting with Default Nomenclature selected.
 
-In case you weight 1,5 Kg of pasta, the balance will print you the
+With the **Barcode** module installed, and the :guilabel:`Default Nomenclature` selected, the
-following barcode 2112345015002. If you scan this barcode in your POS or
+barcode actions using |UPC| and |EAN|, detailed in the :ref:`default nomenclature list
-when receiving products in your barcode application, Odoo will
+<barcode/operations/default-nomenclature-list>`, are available for use. And, by default, Odoo
-automatically create a new line for the Pasta product for a quantity of
+automatically handles |UPC|/|EAN| conversion.
-1.5 Kg. For the point of sale, a price depending on the quantity will
-also be computed.
 
-.. image:: barcode_nomenclature/barcode_nomenclature_04.png
+.. _barcode/operations/product-weight:
+
+Example: product weight barcode
+===============================
+
+To better understand how barcode nomenclature is used to identify products in Odoo, this example
+where product weight barcodes in |EAN| format are used to allow a :doc:`Point of Sale
+<../../../sales/point_of_sale>` business to automatically print barcodes, and calculate the price
+using the weight of the item.
+
+To set up barcodes for weighted products, the following rule is used:
+
+.. list-table::
+   :header-rows: 1
+
+   * - Rule Name
+     - Barcode Pattern
+     - Field in Odoo
+   * - Weighted Barcodes 3 Decimals
+     - (21)....{NNDDD}
+     - :guilabel:`Barcode` field on product form
+
+.. example::
+   To better understand the barcode pattern for weighted products, consider the barcode,
+   `2112345000008`:
+
+   - `21`: code that identifies this a barcode for weighted products.
+   - `12345`: five digits (denoted by `.....` in the table above) that identify the product.
+   - `00000`: five digits (denoted by `{NNDDD}` in the table) representing the weight of the
+     product. On the product form, the five weight values **must** be `00000`. The first two digits
+     are whole number values, and the last three digits are decimal values. For example, "13.5
+     grams" in the `{NNDDD}` format is `13500`.
+   - `8`: `check digit <https://www.gs1.org/services/check-digit-calculator>`_ for `211234500000`.
+
+   Together, these components make up a 13-character |EAN| - 13 barcode.
+
+To configure the product barcode for `Pasta Bolognese`, the |EAN| barcode for weighted products,
+`2112345000008`, is entered in the :guilabel:`Barcode` field on the product form (accessible by
+going to :menuselection:`Inventory app --> Products --> Products`, and selecting the desired
+product). In addition, the :guilabel:`Unit of Measure` is set to :guilabel:`kg`.
+
+.. image:: barcode_nomenclature/barcode.png
    :align: center
+   :alt: Barcode field on the product form.
 
-Rule Types
+Next, a customer's bowl of pasta is weighed to be `1.5` kilograms. This generates a new barcode for
-----------
+the pasta, according to the weight: `211234501500`, which has a check digit of `2`. The new barcode
+is `2112345015002`.
 
-- **Priced Product**: allows you to identify the product and specify its price, used in POS.
+.. image:: barcode_nomenclature/weighted-barcode.png
-- **Discounted Product**: allows you to create one barcode per applied discount. You can then scan your product in the POS and then scan the discount barcode, discount will be applied on the normal price of the product.
+   :align: center
-- **Weighted Product**: allows you to identify the product and specify its weight, used in both POS (in which the price is computed based on the weight) and in inventory.
+   :alt: Generated barcode that includes a weight of 1.5 kg.
-- **Client**: allows you to identify the customer, for example used with loyalty program.
+
-- **Cashier**: allows you to identify the cashier when entering the POS.
+Ensure the products scan properly, by navigating to the :menuselection:`Barcode app --> Operations`.
-- **Location**: allows you to identify the location on a transfer when multi-location is activated.
+Next, click any operation type, such as :guilabel:`Receipts`. Then, click the :guilabel:`New` button
-- **Package**: allows you to identify packages on a transfer when packages are activated.
+to create a draft stock move. Scan the product weight barcode, such as `2112345015002`, and if the
-- **Credit Card**: doesn’t need manual modification, exists for data from the Mercury module.
+intended product appears, the barcode setup is correct.
-- **Unit Product**: allows you to identify a product for both POS and transfers.
+
+.. image:: barcode_nomenclature/barcode-scan.png
+   :align: center
+   :alt: Show successfully scanned barcode.
+
+Create rules
+============
+
+.. important::
+   Adding new rules is necessary for |UPC| and |EAN| formats that are **not** in Odoo's default
+   list, since barcodes cannot be read successfully if there are unknown fields.
+
+    While new rules can be created, Odoo fields do **not** auto-populate with information from these
+    rules. `Custom development <https://www.odoo.com/appointment/132>`_ is required for this
+    functionality.
+
+To create a rule, first enable :ref:`developer mode <developer-mode>`. Then, navigate to
+:menuselection:`Inventory app --> Configuration --> Barcode Nomenclatures`, and select
+:guilabel:`Default Nomenclature`.
+
+On this page, configure the following optional fields:
+
+- :guilabel:`UPC/EAN Conversion`: determines if a |UPC|/|EAN| barcode should be automatically
+  converted when matching a rule with another encoding. Options include :guilabel:`Always` (the
+  default option), :guilabel:`Never`, :guilabel:`EAN-13 to UPC-A`, and :guilabel:`UPC-A to EAN-13`.
+- :guilabel:`Is GS1 Nomenclature`: ensure this checkbox is **not** ticked, as the
+  :guilabel:`Default Nomenclature` uses |UPC| and |EAN| encoding, *not* GS1 encoding.
+
+.. image:: barcode_nomenclature/rule-config.png
+   :align: center
+   :alt: Default Nomenclature page setting fields.
+
+On the :guilabel:`Default Nomenclature` page, click :guilabel:`Add a line` at the bottom of the
+table, which opens a :guilabel:`Create Rules` pop-up window to create a new rule.
+
+The :guilabel:`Rule Name` field is used internally to identify what the barcode represents.
+
+The :guilabel:`Sequence` field represents the priority of the rule; meaning the smaller the value,
+the higher the rule appears on the table.
+
+The barcode :guilabel:`Type` field represents different classifications of information that can be
+understood by the system (e.g., :guilabel:`Package`, :guilabel:`Lot`, :guilabel:`Location`,
+:guilabel:`Coupon`, etc.).
+
+The :guilabel:`Encoding` field specifies which encoding the barcode uses. This rule **only** applies
+if the barcode uses this specific encoding. The available :guilabel:`Encoding` options are:
+:guilabel:`EAN-13`, :guilabel:`EAN-8`, :guilabel:`UPC-A`, and :guilabel:`GS1-28`.
+
+The :guilabel:`Barcode Pattern` field represents how the sequence of letters or numbers is
+recognized by the system to contain information about the product. Sometimes, when a certain amount
+of digits are required, the number of `.` is shown. `N` represents whole number digits, and `D`
+represent decimal digits.
+
+.. example::
+   `1...` represents any 4-digit number that starts with 1. `NNDD` represents a two digit number
+   with two decimal points. For example, `14.25` is 1425.
+
+After filling in the information, click the :guilabel:`Save & New` button to save the rule, and
+instantly start creating another rule. Or, click :guilabel:`Save & Close` to save the rule, and
+return to the table of rules.
+
+.. _barcode/operations/default-nomenclature-list:
+
+Default nomenclature list
+=========================
+
+The table below contains Odoo's list of :guilabel:`Default Nomenclature` rules. Barcode patterns are
+written in regular expressions.
+
+.. list-table::
+   :header-rows: 1
+   :stub-columns: 1
+
+   * - Rule Name
+     - Type
+     - Encoding
+     - Barcode Pattern
+   * - Price Barcodes 2 Decimals
+     - Priced Product
+     - EAN-13
+     - 23.....{NNNDD}
+   * - Discount Barcodes
+     - Discounted Product
+     - Any
+     - 22{NN}
+   * - Weight Barcodes 3 Decimals
+     - Weighted Product
+     - EAN-13
+     - 21.....{NNDDD}
+   * - Customer Barcodes
+     - Client
+     - Any
+     - 042
+   * - Coupon & Gift Card Barcodes
+     - Coupon
+     - Any
+     - 043|044
+   * - Cashier Barcodes
+     - Cashier
+     - Any
+     - 041
+   * - Location barcodes
+     - Location
+     - Any
+     - 414
+   * - Package barcodes
+     - Package
+     - Any
+     - PACK
+   * - Lot barcodes
+     - Lot
+     - Any
+     - 10
+   * - Magnetic Credit Card
+     - Credit Card
+     - Any
+     - %.*
+   * - Product Barcodes
+     - Unit Product
+     - Any
+     - .*
 
 .. note::
-        When the barcode pattern contains .*, it means that it can contain any
+   When the :guilabel:`Barcode Pattern` contains `.*`, it means it can contain any number or type of
-        number of characters, those characters being any number.
+   characters.
+
+.. seealso::
+   :doc:`gs1_nomenclature`