mirror of
https://github.com/bringout/oca-technical.git
synced 2026-04-18 09:32:07 +02:00
Initial commit: OCA Technical packages (595 packages)
This commit is contained in:
Ernad Husremovic
commit
2cc02aac6e
24950 changed files with 2318079 additions and 0 deletions
|
|
@ -0,0 +1,168 @@
|
|||
==========================
|
||||
Overview Dashboard (Tiles)
|
||||
==========================
|
||||
|
||||
..
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! This file is generated by oca-gen-addon-readme !!
|
||||
!! changes will be overwritten. !!
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
!! source digest: sha256:016842e127bc74b3f446e2ae087f66e14b91670c6e567c09e69b3fc1175667da
|
||||
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
||||
|
||||
.. |badge1| image:: https://img.shields.io/badge/maturity-Beta-yellow.png
|
||||
:target: https://odoo-community.org/page/development-status
|
||||
:alt: Beta
|
||||
.. |badge2| image:: https://img.shields.io/badge/licence-AGPL--3-blue.png
|
||||
:target: http://www.gnu.org/licenses/agpl-3.0-standalone.html
|
||||
:alt: License: AGPL-3
|
||||
.. |badge3| image:: https://img.shields.io/badge/github-OCA%2Fweb-lightgray.png?logo=github
|
||||
:target: https://github.com/OCA/web/tree/16.0/web_dashboard_tile
|
||||
:alt: OCA/web
|
||||
.. |badge4| image:: https://img.shields.io/badge/weblate-Translate%20me-F47D42.png
|
||||
:target: https://translation.odoo-community.org/projects/web-16-0/web-16-0-web_dashboard_tile
|
||||
:alt: Translate me on Weblate
|
||||
.. |badge5| image:: https://img.shields.io/badge/runboat-Try%20me-875A7B.png
|
||||
:target: https://runboat.odoo-community.org/builds?repo=OCA/web&target_branch=16.0
|
||||
:alt: Try me on Runboat
|
||||
|
||||
|badge1| |badge2| |badge3| |badge4| |badge5|
|
||||
|
||||
This module extends the web module to add new dashboard overview system.
|
||||
|
||||
By default, the tile displays items count of a given model restricted to a given domain.
|
||||
|
||||
Optionally, the tile can display the result of a function on a field.
|
||||
|
||||
- Function is one of ``sum``, ``avg``, ``min``, ``max`` or ``median``.
|
||||
- Field must be integer or float.
|
||||
|
||||
Tile can be:
|
||||
|
||||
- Displayed only for a user.
|
||||
- Global for all users.
|
||||
- Restricted to some groups.
|
||||
|
||||
*Note: The tile will be hidden if the current user doesn't have access to the given model.*
|
||||
|
||||
**Table of contents**
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
First, you have to create tile categories.
|
||||
|
||||
* Go to "Dashboards > Configuration > Overview Settings > Dashboard Categories"
|
||||
|
||||
* Create categories
|
||||
|
||||
Odoo menu and action are automatically created in the "Dashboard > Overview" menu
|
||||
You should refresh your browser to see new menu items.
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_category_form.png
|
||||
|
||||
Then you can create tiles.
|
||||
|
||||
* Go to "Dashboards > Configuration > Overview Settings > Dashboard Items"
|
||||
|
||||
* create a new tile, set a name, a category and a model.
|
||||
|
||||
* You can optionally define colors, domain and a specific action to use.
|
||||
|
||||
* Setting a user, or a group in "Security" tab will restrict the display of the tile.
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_form.png
|
||||
|
||||
You can optionally define a secondary value, for that purpose :
|
||||
|
||||
* Select a field, a function to apply.
|
||||
|
||||
* You can define a specific format. (``.format()`` python syntax)
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_form_secondary_value.png
|
||||
|
||||
Usage
|
||||
=====
|
||||
|
||||
* Go to "Dashboard > Overview" and select a category
|
||||
|
||||
* The tile configured is displayed with the up to date count and average values of the selected domain.
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_kanban.png
|
||||
|
||||
* By clicking on the item, you'll navigate to the tree view of the according model.
|
||||
|
||||
.. image:: https://raw.githubusercontent.com/OCA/web/16.0/web_dashboard_tile/static/description/tile_tile_2_tree_view.png
|
||||
|
||||
Known issues / Roadmap
|
||||
======================
|
||||
|
||||
**Known issues**
|
||||
|
||||
* Can not edit color from dashboard
|
||||
* Original context is ignored.
|
||||
* Original domain and filter are not restored.
|
||||
* To preserve a relative date domain, you have to manually edit the tile's domain from "Configuration > User Interface > Dashboard Tile". You can use the same variables available in filters (``uid``, ``context_today()``, ``current_date``, ``relativedelta``).
|
||||
|
||||
**Roadmap**
|
||||
|
||||
* Add icons.
|
||||
* Support client side action (like inbox).
|
||||
* Restore original Domain + Filter when an action is set.
|
||||
* Posibility to hide the tile based on a field expression.
|
||||
* Posibility to set the background color based on a field expression.
|
||||
|
||||
Bug Tracker
|
||||
===========
|
||||
|
||||
Bugs are tracked on `GitHub Issues <https://github.com/OCA/web/issues>`_.
|
||||
In case of trouble, please check there if your issue has already been reported.
|
||||
If you spotted it first, help us to smash it by providing a detailed and welcomed
|
||||
`feedback <https://github.com/OCA/web/issues/new?body=module:%20web_dashboard_tile%0Aversion:%2016.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**>`_.
|
||||
|
||||
Do not contact contributors directly about support or help with technical issues.
|
||||
|
||||
Credits
|
||||
=======
|
||||
|
||||
Authors
|
||||
~~~~~~~
|
||||
|
||||
* initOS GmbH & Co. KG
|
||||
* GRAP
|
||||
* Iván Todorovich <ivan.todorovich@gmail.com>
|
||||
|
||||
Contributors
|
||||
~~~~~~~~~~~~
|
||||
|
||||
* Markus Schneider <markus.schneider at initos.com>
|
||||
* Sylvain Le Gal (https://twitter.com/legalsylvain)
|
||||
* Iván Todorovich <ivan.todorovich@gmail.com>
|
||||
|
||||
Maintainers
|
||||
~~~~~~~~~~~
|
||||
|
||||
This module is maintained by the OCA.
|
||||
|
||||
.. image:: https://odoo-community.org/logo.png
|
||||
:alt: Odoo Community Association
|
||||
:target: https://odoo-community.org
|
||||
|
||||
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.
|
||||
|
||||
.. |maintainer-legalsylvain| image:: https://github.com/legalsylvain.png?size=40px
|
||||
:target: https://github.com/legalsylvain
|
||||
:alt: legalsylvain
|
||||
|
||||
Current `maintainer <https://odoo-community.org/page/maintainer-role>`__:
|
||||
|
||||
|maintainer-legalsylvain|
|
||||
|
||||
This module is part of the `OCA/web <https://github.com/OCA/web/tree/16.0/web_dashboard_tile>`_ project on GitHub.
|
||||
|
||||
You are welcome to contribute. To learn how please visit https://odoo-community.org/page/Contribute.
|
||||
Loading…
Add table
Add a link
Reference in a new issue