From 2a0a966ff770467c613228d93c8939cb24a87aa7 Mon Sep 17 00:00:00 2001 From: Max Whale Date: Fri, 10 Oct 2025 13:28:27 +0200 Subject: [PATCH] [ADD] point_of_sale/payment_methods: add Glory cash machine doc Support for Glory cash machines has been added to the POS in v19.0. This commit adds documentation on how to configure both the machine itself and the Odoo payment method. This commit also adds a 'Cash machines' parent page, as we are planning on supporting other models in the future. task-5158950 --- .../sales/point_of_sale/payment_methods.rst | 4 +- .../payment_methods/cash_machines.rst | 39 ++++++++ .../payment_methods/cash_machines/glory.rst | 88 +++++++++++++++++++ 3 files changed, 130 insertions(+), 1 deletion(-) create mode 100644 content/applications/sales/point_of_sale/payment_methods/cash_machines.rst create mode 100644 content/applications/sales/point_of_sale/payment_methods/cash_machines/glory.rst diff --git a/content/applications/sales/point_of_sale/payment_methods.rst b/content/applications/sales/point_of_sale/payment_methods.rst index 20dc83db57..ace93a0e3a 100644 --- a/content/applications/sales/point_of_sale/payment_methods.rst +++ b/content/applications/sales/point_of_sale/payment_methods.rst @@ -20,7 +20,8 @@ payments, or :guilabel:`Bank` to use it for card payments. `. .. seealso:: - :doc:`payment_methods/terminals`. + - :doc:`payment_methods/cash_machines`. + - :doc:`payment_methods/terminals`. Once the payment method is created, you can select it in your POS settings. To do so, go to the :ref:`POS' settings `, click :guilabel:`Edit`, and add the payment method @@ -29,5 +30,6 @@ under the :guilabel:`Payments` section. .. toctree:: :titlesonly: + payment_methods/cash_machines payment_methods/qr_code_payment payment_methods/terminals diff --git a/content/applications/sales/point_of_sale/payment_methods/cash_machines.rst b/content/applications/sales/point_of_sale/payment_methods/cash_machines.rst new file mode 100644 index 0000000000..d8a65dbaee --- /dev/null +++ b/content/applications/sales/point_of_sale/payment_methods/cash_machines.rst @@ -0,0 +1,39 @@ +:show-content: + +============= +Cash machines +============= + +Connecting and integrating a cash machine with a :ref:`POS system ` enables +automation of cash transactions, cash counting, and change return. + +.. _pos/cash_machines/configuration: + +Configuration +============= + +Configure the cash machine itself before setting it up in Odoo. Currently, Odoo supports :doc:`Glory +` cash machines. Once the cash machine is fully set up: + +#. Create the associated :doc:`payment method <../payment_methods>`. +#. Select the POS in the :guilabel:`Point of Sale` field. + +.. _pos/terminals/cash-machine-use: + +Cash machine use +================ + +To process a :ref:`payment ` with a :ref:`configured cash machine +`, select the machine's :doc:`payment method <../payment_methods>` +on the **payment screen**, then follow the instructions on the machine. + +Once the transaction is successful, the payment is automatically validated in Point of Sale. + +.. note:: + - Connection issues between Odoo and the cash machine result in transaction cancellation. + - To cancel the payment request, click :guilabel:`Cancel`. + +.. toctree:: + :titlesonly: + + cash_machines/glory diff --git a/content/applications/sales/point_of_sale/payment_methods/cash_machines/glory.rst b/content/applications/sales/point_of_sale/payment_methods/cash_machines/glory.rst new file mode 100644 index 0000000000..9940f5601a --- /dev/null +++ b/content/applications/sales/point_of_sale/payment_methods/cash_machines/glory.rst @@ -0,0 +1,88 @@ +===== +Glory +===== + +**Glory** :doc:`cash machines <../cash_machines>` enable the automation of cash transactions. + +.. note:: + The integration with the Glory cash machine currently only supports basic operations, such as + making payments and checking the current cash counts. + + Operations such as filling and emptying the machine must be performed directly using the cash + machine interface. + +.. _pos/glory/configuration: + +Configuration +============= + +Cash machine settings +--------------------- + +.. important:: + This section requires knowledge of the Glory hardware - your Glory integration partner should be + able to configure these settings for you. + +#. Power on the cash machine, which briefly displays its IP address at the bottom of the screen. The + IP address should be structured as follow: `###.###.#.##` (e.g., `192.168.0.25`). Note it down to + use later. +#. Navigate to the cash machine homepage by typing its IP address as URL in `HTTPS` (e.g., + `https://192.168.0.25`), and log in with your credentials. +#. As long as the certificate is not imported, a warning page is displayed when trying to reach the + machine homepage. Force the connection by clicking :guilabel:`Advanced` and :guilabel:`Proceed to + [IP address] (unsafe)`. +#. Go to :guilabel:`Host Configuration` and ensure the :guilabel:`Network` setting is set to + :guilabel:`MANUAL`, meaning the IP address is static. +#. Go to :guilabel:`SSL Configuration` and scroll down to the :guilabel:`HTTPS Server Setting` + section. + + #. In parallel, open the terminal and ensure OpenSSL is installed. Type `openssl` and press + enter. When installed, this command generates a `Help` menu suggesting all available OpenSSL + commands. Install it if nothing happens. + #. Then, paste the following command and press `Enter` to generate and download the certificate + and private key; ensure to replace the demo IP address with your cash machine's. + + .. code-block:: bash + + openssl req -x509 -newkey rsa:4096 -keyout key.pem -out cert.pem -sha256 -days 3650 -nodes -subj "/CN=192.168.0.25" -addext "subjectAltName = IP:192.168.0.25" + + .. note:: + The self-signed SSL certificate and key pair must use the same static IP address as the + cash machine. + +#. Once the files are generated, upload `cert.pem` as the :guilabel:`Certificate` and `key.pem` as + the :guilabel:`Private Key`. +#. Go to :guilabel:`WebApp Configuration` a ensure the :guilabel:`Interface` setting is set to + :guilabel:`Enable`. Then, adjust some settings depending on the POS setup: + + - If multiple POS are connected to the same cash machine, set the following: + + - Go to :guilabel:`App Configuration`, scroll down to the :guilabel:`SOAP IF Setting` and + ensure :guilabel:`Session mode` and :guilabel:`Occupy mode` are both set to + :guilabel:`Enable` + - If a dedicated user has been setup on the cash machine for Odoo, also set the following: + + - Go to :guilabel:`App Configuration`, scroll down to the :guilabel:`SOAP IF Setting` and + :guilabel:`Enable` the :guilabel:`User check` setting. +#. Restart the cash machine to apply the new settings. + +Payment method +-------------- + +#. Install the :ref:`POS Glory Cash Machines module `. +#. :doc:`Associate a cash payment method <../../payment_methods>`: + + - Go to :menuselection:`Point of Sale --> Configuration --> Payment Methods`. Create a new + :guilabel:`Cash` payment method, or modify an existing one for the desired POS. + - Select :guilabel:`Cash Machine (Glory)` in the :guilabel:`Integration` field. + - Fill in the :guilabel:`Cash Machine IP` field with the the cash machine IP address. + - If the cash machine was configured to use :guilabel:`User check` in the previous section, + fill in the :guilabel:`Cash Machine Username` and :guilabel:`Cash Machine Password`. + +Certificate settings +-------------------- + +At this point the cash machine payment method is configured, but for it to work properly the HTTPS +certificate that was generated earlier must be added to the configuration of the machine that will +be using the Point of Sale. You can refer to the **Export** and **Import** sections of the +:ref:`ePOS documentation ` for specific instructions.