You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

120 lines
4.4 KiB

  1. ======================
  2. MuK Web Client Refresh
  3. ======================
  4. Adds a channel called "refresh" to the web client, which can be used to trigger
  5. a view reload without refreshing the browser itself. Furthermore, it allows the
  6. user the creation of action rules. These rules can be applied to any model and
  7. trigger a refresh either on create, update or unlink.
  8. Installation
  9. ============
  10. To install this module, you need to:
  11. Download the module and add it to your Odoo addons folder. Afterward, log on to
  12. your Odoo server and go to the Apps menu. Trigger the debug mode and update the
  13. list by clicking on the "Update Apps List" link. Now install the module by
  14. clicking on the install button.
  15. Another way to install this module is via the package management for Python
  16. (`PyPI <https://pypi.org/project/pip/>`_).
  17. To install our modules using the package manager make sure
  18. `odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed
  19. correctly. Then open a console and install the module by entering the following
  20. command:
  21. ``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  22. The module name consists of the Odoo version and the module name, where
  23. underscores are replaced by a dash.
  24. **Module:**
  25. ``odoo<version>-addon-<module_name>``
  26. **Example:**
  27. ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils``
  28. Once the installation has been successfully completed, the app is already in the
  29. correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
  30. debug mode and update the list by clicking on the "Update Apps List" link. Now
  31. install the module by clicking on the install button.
  32. The biggest advantage of this variant is that you can now also update the app
  33. using the "pip" command. To do this, enter the following command in your console:
  34. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  35. When the process is finished, restart your server and update the application in
  36. Odoo. The steps are the same as for the installation only the button has changed
  37. from "Install" to "Upgrade".
  38. You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_
  39. and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
  40. For modules licensed under OPL-1, you will receive access data when you purchase
  41. the module. If the modules were not purchased directly from
  42. `MuK IT <https://www.mukit.at/>`_ please contact our support (support@mukit.at)
  43. with a confirmation of purchase to receive the corresponding access data.
  44. Upgrade
  45. ============
  46. To upgrade this module, you need to:
  47. Download the module and add it to your Odoo addons folder. Restart the server
  48. and log on to your Odoo server. Select the Apps menu and upgrade the module by
  49. clicking on the upgrade button.
  50. If you installed the module using the "pip" command, you can also update the
  51. module in the same way. Just type the following command into the console:
  52. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  53. When the process is finished, restart your server and update the application in
  54. Odoo, just like you would normally.
  55. Configuration
  56. =============
  57. To configure this module, you need to:
  58. #. Go to *Settings* while being in debug mode.
  59. #. Afterwards go to *Technical -> Automation -> Automated Refresh*.
  60. #. And create a new refresh action.
  61. Usage
  62. =============
  63. Besides creating a action rule, a view refresh can be triggered manually via python.
  64. This can be useful if there is a need for a view reload on other operations.
  65. Credits
  66. =======
  67. Contributors
  68. ------------
  69. * Mathias Markl <mathias.markl@mukit.at>
  70. Images
  71. ------------
  72. Some pictures are based on or inspired by the icon set of Font Awesome:
  73. * `Font Awesome <https://fontawesome.com>`_
  74. Author & Maintainer
  75. -------------------
  76. This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
  77. MuK IT is an Austrian company specialized in customizing and extending Odoo.
  78. We develop custom solutions for your individual needs to help you focus on
  79. your strength and expertise to grow your business.
  80. If you want to get in touch please contact us via mail
  81. (sale@mukit.at) or visit our website (https://mukit.at).