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.

159 lines
5.9 KiB

  1. ================
  2. MuK Search Panel
  3. ================
  4. With Odoo version 13 a new feature is added which allows kanban views to be
  5. extended by a search panel. This can be defined via XML and is then automatically
  6. added to the view. With this module the function is ported back to version 12.
  7. Installation
  8. ============
  9. To install this module, you need to:
  10. Download the module and add it to your Odoo addons folder. Afterward, log on to
  11. your Odoo server and go to the Apps menu. Trigger the debug mode and update the
  12. list by clicking on the "Update Apps List" link. Now install the module by
  13. clicking on the install button.
  14. Another way to install this module is via the package management for Python
  15. (`PyPI <https://pypi.org/project/pip/>`_).
  16. To install our modules using the package manager make sure
  17. `odoo-autodiscover <https://pypi.org/project/odoo-autodiscover/>`_ is installed
  18. correctly. Then open a console and install the module by entering the following
  19. command:
  20. ``pip install --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  21. The module name consists of the Odoo version and the module name, where
  22. underscores are replaced by a dash.
  23. **Module:**
  24. ``odoo<version>-addon-<module_name>``
  25. **Example:**
  26. ``sudo -H pip3 install --extra-index-url https://nexus.mukit.at/repository/odoo/simple odoo11-addon-muk-utils``
  27. Once the installation has been successfully completed, the app is already in the
  28. correct folder. Log on to your Odoo server and go to the Apps menu. Trigger the
  29. debug mode and update the list by clicking on the "Update Apps List" link. Now
  30. install the module by clicking on the install button.
  31. The biggest advantage of this variant is that you can now also update the app
  32. using the "pip" command. To do this, enter the following command in your console:
  33. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  34. When the process is finished, restart your server and update the application in
  35. Odoo. The steps are the same as for the installation only the button has changed
  36. from "Install" to "Upgrade".
  37. You can also view available Apps directly in our `repository <https://nexus.mukit.at/#browse/browse:odoo>`_
  38. and find a more detailed installation guide on our `website <https://mukit.at/page/open-source>`_.
  39. For modules licensed under OPL-1, you will receive access data when you purchase
  40. the module. If the modules were not purchased directly from
  41. `MuK IT <https://www.mukit.at/>`_ please contact our support (support@mukit.at)
  42. with a confirmation of purchase to receive the corresponding access data.
  43. Upgrade
  44. ============
  45. To upgrade this module, you need to:
  46. Download the module and add it to your Odoo addons folder. Restart the server
  47. and log on to your Odoo server. Select the Apps menu and upgrade the module by
  48. clicking on the upgrade button.
  49. If you installed the module using the "pip" command, you can also update the
  50. module in the same way. Just type the following command into the console:
  51. ``pip install --upgrade --extra-index-url https://nexus.mukit.at/repository/odoo/simple <module>``
  52. When the process is finished, restart your server and update the application in
  53. Odoo, just like you would normally.
  54. Configuration
  55. =============
  56. No additional configuration is needed to use this module.
  57. Usage
  58. =============
  59. This tool allows to quickly filter data on the basis of given fields. The fields
  60. are specified as direct children of the ``searchpanel`` with tag name ``field``,
  61. and the following attributes:
  62. * ``name`` (mandatory) the name of the field to filter on
  63. * ``select`` determines the behavior and display.
  64. * ``groups``: restricts to specific users
  65. * ``string``: determines the label to display
  66. * ``icon``: specifies which icon is used
  67. * ``color``: determines the icon color
  68. Possible values for the ``select`` attribute are
  69. * ``one`` (default) at most one value can be selected. Supported field types are many2one and selection.
  70. * ``multi`` several values can be selected (checkboxes). Supported field types are many2one, many2many and selection.
  71. Additional optional attributes are available in the ``multi`` case:
  72. * ``domain``: determines conditions that the comodel records have to satisfy.
  73. A domain might be used to express a dependency on another field (with select="one")
  74. of the search panel. Consider
  75. .. code-block:: xml
  76. <searchpanel>
  77. <field name="department_id"/>
  78. <field name="manager_id" select="multi" domain="[('department_id', '=', department_id)]"/>
  79. <searchpanel/>
  80. In the above example, the range of values for manager_id (manager names) available at screen
  81. will depend on the value currently selected for the field ``department_id``.
  82. * ``groupby``: field name of the comodel (only available for many2one and many2many fields). Values will be grouped by that field.
  83. * ``disable_counters``: default is false. If set to true the counters won't be computed.
  84. This feature has been implemented in case performances would be too bad.
  85. Another way to solve performance issues is to properly override the ``search_panel_select_multi_range`` method.
  86. Credits
  87. =======
  88. Contributors
  89. ------------
  90. * Mathias Markl <mathias.markl@mukit.at>
  91. Images
  92. ------------
  93. Some pictures are based on or inspired by the icon set of Font Awesome:
  94. * `Font Awesome <https://fontawesome.com>`_
  95. Projects
  96. ------------
  97. Parts of the module are based on or inspired by:
  98. * `Odoo <https://github.com/odoo/odoo>`_
  99. Author & Maintainer
  100. -------------------
  101. This module is maintained by the `MuK IT GmbH <https://www.mukit.at/>`_.
  102. MuK IT is an Austrian company specialized in customizing and extending Odoo.
  103. We develop custom solutions for your individual needs to help you focus on
  104. your strength and expertise to grow your business.
  105. If you want to get in touch please contact us via mail
  106. (sale@mukit.at) or visit our website (https://mukit.at).