forked from Techsystech/web
162 lines
5.5 KiB
ReStructuredText
162 lines
5.5 KiB
ReStructuredText
==========================
|
|
Overview Dashboard (Tiles)
|
|
==========================
|
|
|
|
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
!! This file is generated by oca-gen-addon-readme !!
|
|
!! changes will be overwritten. !!
|
|
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
|
|
|
|
.. |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-legalsylvain%2Fweb-lightgray.png?logo=github
|
|
:target: https://github.com/legalsylvain/web/tree/12.0-mig-web_dashboard_tile/web_dashboard_tile
|
|
:alt: legalsylvain/web
|
|
|
|
|badge1| |badge2| |badge3|
|
|
|
|
Adds a dashboard where you can configure tiles from any view and add them as short cut.
|
|
|
|
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 > Settings > Dashboard Categories"
|
|
|
|
* Click on Create
|
|
|
|
* Set a name, and save.
|
|
|
|
Odoo menu and action are automatically created.
|
|
You should refresh your browser to see new menu items.
|
|
|
|
.. image:: https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_category_form.png
|
|
|
|
Then you can create tiles.
|
|
|
|
* go to "Dashboards > Settings > Dashboard Tiles"
|
|
|
|
* create a new tile, set a name, a category and a model.
|
|
|
|
* You can optionally define colors, domain 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/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_form.png
|
|
|
|
You can optionanaly 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/legalsylvain/web/12.0-mig-web_dashboard_tile/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/legalsylvain/web/12.0-mig-web_dashboard_tile/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/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/tile_tile_2_tree_view.png
|
|
|
|
**Note**
|
|
|
|
When you are in a tree view, with a domain, you can save it in the favorite menu, but the configuration is limited.
|
|
|
|
.. image:: https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/favorite_menu_create_tile.png
|
|
|
|
|
|
.. image:: https://raw.githubusercontent.com/legalsylvain/web/12.0-mig-web_dashboard_tile/web_dashboard_tile/static/description/favorite_menu_create_tile_result.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``, ``time``, ``datetime``, `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/legalsylvain/web/issues>`_.
|
|
In case of trouble, please check there if your issue has already been reported.
|
|
If you spotted it first, help us smashing it by providing a detailed and welcomed
|
|
`feedback <https://github.com/legalsylvain/web/issues/new?body=module:%20web_dashboard_tile%0Aversion:%2012.0-mig-web_dashboard_tile%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
|
|
|
|
Contributors
|
|
~~~~~~~~~~~~
|
|
|
|
* Markus Schneider <markus.schneider at initos.com>
|
|
* Sylvain Le Gal (https://twitter.com/legalsylvain)
|
|
* Iván Todorovich <ivan.todorovich@gmail.com>
|
|
|
|
Maintainers
|
|
~~~~~~~~~~~
|
|
|
|
.. |maintainer-legalsylvain| image:: https://github.com/legalsylvain.png?size=40px
|
|
:target: https://github.com/legalsylvain
|
|
:alt: legalsylvain
|
|
|
|
Current maintainer:
|
|
|
|
|maintainer-legalsylvain|
|
|
|
|
This module is part of the `legalsylvain/web <https://github.com/legalsylvain/web/tree/12.0-mig-web_dashboard_tile/web_dashboard_tile>`_ project on GitHub.
|
|
|
|
You are welcome to contribute.
|