mirror of
https://github.com/odoo/documentation.git
synced 2025-12-12 07:29:27 +07:00
[ADD] dashboards: consult, build, customize, configure dashboards
task-4969391 closes odoo/documentation#14506 Signed-off-by: Xavier Platteau (xpl) <xpl@odoo.com>
This commit is contained in:
mcsi-odoo
@@ -28,6 +28,8 @@ should not have access to.
|
||||
Once complete, click :guilabel:`Save` to save the changes, and implement the user as an
|
||||
administrator.
|
||||
|
||||
.. _access-rights/users:
|
||||
|
||||
Users
|
||||
=====
|
||||
|
||||
|
||||
@@ -10,6 +10,7 @@ Productivity
|
||||
productivity/documents
|
||||
productivity/sign
|
||||
productivity/spreadsheet
|
||||
productivity/dashboards
|
||||
productivity/knowledge
|
||||
productivity/calendar
|
||||
productivity/appointments
|
||||
|
||||
281
content/applications/productivity/dashboards.rst
Normal file
281
content/applications/productivity/dashboards.rst
Normal file
@@ -0,0 +1,281 @@
|
||||
:show-content:
|
||||
|
||||
==========
|
||||
Dashboards
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
dashboards/build_and_customize_dashboards
|
||||
dashboards/my_dashboard
|
||||
|
||||
**Odoo Dashboards** allows you to consult, customize, and build interactive dashboards that display
|
||||
real-time data from your Odoo database in an easy-to-understand way. By centralizing data from
|
||||
various Odoo sources in a single location, dashboards provide an overview of key business metrics
|
||||
that can help you monitor business performance and make informed decisions.
|
||||
|
||||
:doc:`Odoo spreadsheets <../../applications/productivity/spreadsheet>` serve as the foundation for
|
||||
dashboards, with tables and charts used to structure and visualize dynamic Odoo data. :ref:`Data
|
||||
sources <spreadsheet/insert/data-sources>` connect a dashboard's underlying spreadsheet to your
|
||||
database, ensuring the most recent data is retrieved every time the dashboard is opened or
|
||||
refreshed.
|
||||
|
||||
With Odoo Dashboards, users can, depending on their :ref:`access rights
|
||||
<dashboards/access-and-sharing>`:
|
||||
|
||||
- :ref:`consult dashboards <dashboards/consult-dashboards>`, including :ref:`standard,
|
||||
pre-configured dashboards <dashboards/consult-dashboards/standard>`
|
||||
- :ref:`interact with dashboards <dashboards/use-dashboards/interact>` using filters and by
|
||||
accessing underlying data
|
||||
- :ref:`share a snapshot of a dashboard <dashboards/access-and-sharing>` with internal users who do
|
||||
not have the appropriate access rights or with external users
|
||||
- :doc:`build custom dashboards
|
||||
<../../applications/productivity/dashboards/build_and_customize_dashboards>` using Odoo
|
||||
Spreadsheet
|
||||
- :ref:`customize dashboards <build_and_customize_dashboards/customize>` to modify what data is
|
||||
shown, the layout, or the filters available
|
||||
- :ref:`manage access rights <dashboards/access-and-sharing>` to dashboards
|
||||
- centralize frequently consulted Odoo views on a personal
|
||||
:doc:`../../applications/productivity/dashboards/my_dashboard` page
|
||||
|
||||
.. tip::
|
||||
- Once a spreadsheet has been converted into a dashboard, it can only be accessed via the
|
||||
Dashboards app.
|
||||
- Unlike other Odoo dashboards, :guilabel:`My Dashboard` is not based on Odoo Spreadsheet, but
|
||||
rather on :doc:`Odoo views <../studio/views>`.
|
||||
|
||||
.. _dashboards/consult-dashboards:
|
||||
|
||||
Consult dashboards
|
||||
==================
|
||||
|
||||
On the main Dashboards page, the left panel lists all :ref:`dashboards a user has access to
|
||||
<dashboards/access-and-sharing>`, grouped by section. Clicking on a dashboard name opens that
|
||||
dashboard in the main part of the page.
|
||||
|
||||
.. tip::
|
||||
Clicking the :icon:`fa-angle-double-left` :guilabel:`(double chevron)` icon at the top of the
|
||||
left panel collapses the panel, maximizing the space available for dashboards.
|
||||
|
||||
.. _dashboards/consult-dashboards/standard:
|
||||
|
||||
Standard dashboards
|
||||
-------------------
|
||||
|
||||
Depending on which apps are installed, a series of standard dashboards is available by default.
|
||||
|
||||
These pre-configured dashboards have been designed to provide the most relevant insights
|
||||
for the topic in question. Data on specific aspects of the topic is presented in tables and charts,
|
||||
while dashboard-specific filters allow users to tailor the view to their needs.
|
||||
|
||||
.. example::
|
||||
Within the :guilabel:`Sales` section in the Dashboards app, the :guilabel:`Sales` dashboard gives
|
||||
an overview of the number of quotations and orders, the revenue, and the average order value, as
|
||||
well as a chart showing monthly sales. It also includes tables listing top quotations and sales
|
||||
orders, top-performing products and salespeople, and top countries served.
|
||||
|
||||
A series of pre-configured global filters at the top of the dashboard allows the entire dashboard
|
||||
to be filtered by, e.g., product or sales team. A default value of `Last 90 days` in the period
|
||||
filter means data from the previous 90 days is automatically retrieved every time the dashboard
|
||||
is opened or refreshed.
|
||||
|
||||
.. image:: dashboards/sales-dashboard.png
|
||||
:alt: Overview of Sales dashboard
|
||||
|
||||
Standard dashboards can be :ref:`customized <build_and_customize_dashboards/customize>` by a user
|
||||
with the appropriate :ref:`access rights <dashboards/access-and-sharing/customize-configure-build>`.
|
||||
For example, dashboard elements like tables and charts, or global filters can be added, edited, or
|
||||
removed.
|
||||
|
||||
.. important::
|
||||
When customizing a standard dashboard, it is highly recommended to :ref:`duplicate the dashboard
|
||||
<build_and_customize_dashboards/customize/duplicate-dashboard>` and make any changes on the
|
||||
duplicated version. Standard dashboards are reinstalled at each Odoo version upgrade, meaning any
|
||||
customizations on the original version are lost.
|
||||
|
||||
.. _dashboards/use-dashboards/interact:
|
||||
|
||||
Interact with dashboards
|
||||
------------------------
|
||||
|
||||
In addition to consulting a dashboard for a high-level overview of key business data, it is also
|
||||
possible to interact with the dashboard for a more detailed analysis:
|
||||
|
||||
- **Filter data**: Most standard dashboards have one or more :doc:`global filters
|
||||
<spreadsheet/global_filters>`, shown as dropdown menus, at the top of the dashboard. These filters
|
||||
allow all the data on the dashboard to be filtered at the same time, for example, to show data
|
||||
only for a specific period of time, or for one or more salespeople or customers.
|
||||
|
||||
- **Open underlying database records**: To access database records referenced by a dashboard, click
|
||||
on the relevant value in a table or on a data point on a chart. Doing so opens either the
|
||||
individual record, or, in the case of charts or tables displaying consolidated data, a list of the
|
||||
referenced records.
|
||||
|
||||
- **Open underlying database views**: To access the view from which the data for a specific chart
|
||||
or table is retrieved, click on the title of the chart or table. Doing so opens the corresponding
|
||||
list view, pivot view or graph view.
|
||||
|
||||
.. tip::
|
||||
To return to a dashboard after drilling down to underlying records or views, click the
|
||||
:guilabel:`Dashboards` breadcrumb at the upper left of the page.
|
||||
|
||||
.. _dashboards/configuration:
|
||||
|
||||
Configuration
|
||||
=============
|
||||
|
||||
.. note::
|
||||
Only a user with the appropriate :ref:`access rights <access-rights/groups>` can configure or
|
||||
modify settings for dashboards and dashboard sections.
|
||||
|
||||
To manage dashboards and dashboard sections, go to :menuselection:`Configuration --> Dashboards`.
|
||||
The following actions are possible at the level of dashboard sections:
|
||||
|
||||
- **Change the order of dashboard sections** by using the :icon:`oi-draggable` :guilabel:`(drag
|
||||
handle)` icon to move a section to a new position.
|
||||
|
||||
- **Duplicate a dashboard section** by selecting the relevant section name, clicking the
|
||||
:icon:`fa-cog` :guilabel:`Actions` button, and then :icon:`fa-clone` :guilabel:`Duplicate`. The
|
||||
dashboards within the section are not duplicated.
|
||||
|
||||
- **Delete a dashboard section** by selecting the relevant section name, clicking the :icon:`fa-cog`
|
||||
:guilabel:`Actions` button then :icon:`fa-trash-o` :guilabel:`Delete`.
|
||||
|
||||
.. tip::
|
||||
Standard, pre-installed dashboard sections cannot be deleted; custom dashboard sections, on
|
||||
the other hand, can be deleted.
|
||||
|
||||
- **Create a new dashboard section** by clicking :guilabel:`New`, then entering the section name.
|
||||
When creating a new section, it is possible to add a dashboard to the new section
|
||||
directly by clicking :guilabel:`Add a spreadsheet`.
|
||||
|
||||
Clicking on an individual dashboard section lists all dashboards within that section. The following
|
||||
actions are possible:
|
||||
|
||||
- **Change the order of a dashboard within its section** by using the :icon:`oi-draggable`
|
||||
:guilabel:`(drag handle)` icon to move the dashboard to a new position.
|
||||
|
||||
- **Edit the name of a dashboard section or dashboard** by clicking the name and modifying it.
|
||||
|
||||
- **Add or remove user groups** to :ref:`control access to the dashboard
|
||||
<dashboards/access-and-sharing>`.
|
||||
|
||||
- **Select a company** if, in a :doc:`multi-company
|
||||
<../../applications/general/companies/multi_company>` database, the dashboard should only be
|
||||
visible to users of one company. If this field is left blank, the dashboard is visible to all
|
||||
users with the appropriate access rights, regardless of which company is currently selected in the
|
||||
database.
|
||||
|
||||
- **Unpublish a dashboard** by disabling the :guilabel:`Is Published` toggle.
|
||||
|
||||
- **Edit the underlying spreadsheet** of a dashboard by clicking :icon:`fa-pencil` :guilabel:`Edit`
|
||||
on the line of the relevant dashboard.
|
||||
|
||||
.. important::
|
||||
When customizing a standard dashboard, it is highly recommended to :ref:`duplicate the
|
||||
dashboard <build_and_customize_dashboards/customize/duplicate-dashboard>` and make any changes
|
||||
on the underlying spreadsheet of the duplicated version. Standard dashboards are reinstalled at
|
||||
each Odoo version upgrade, meaning any customizations on the original version are lost.
|
||||
|
||||
- **Delete a dashboard** by clicking the :icon:`fa-trash` :guilabel:`(trash)` icon.
|
||||
|
||||
.. tip::
|
||||
A standard dashboard that is deleted is reinstalled at the next Odoo version upgrade.
|
||||
|
||||
- **Add a new dashboard to the section** by clicking :guilabel:`Add a spreadsheet`. Two options
|
||||
exist:
|
||||
|
||||
- To convert an existing spreadsheet into a dashboard and add it to the new section, select the
|
||||
relevant spreadsheet, then click :guilabel:`Confirm`. Back in the section overview, update the
|
||||
:guilabel:`Group` and :guilabel:`Company` fields if needed.
|
||||
|
||||
- To start creating a dashboard from scratch, select :guilabel:`Blank spreadsheet`. To return to
|
||||
the section overview, click the name of the section at the top left of the page. Update the
|
||||
:guilabel:`Group` and :guilabel:`Company` fields if needed.
|
||||
|
||||
.. note::
|
||||
After a spreadsheet has been converted into a dashboard, it can only be :ref:`accessed and
|
||||
edited via the Dashboards app <build_and_customize_dashboards/customize>`.
|
||||
|
||||
.. tip::
|
||||
- A newly created dashboard is by default accessible to users belonging to the default internal
|
||||
:ref:`user group <access-rights/groups>`. Edit this if needed via the configuration page of
|
||||
the relevant dashboard section.
|
||||
- It is also possible to :ref:`convert a spreadsheet into a dashboard
|
||||
<spreadsheet/manage-spreadsheets/convert-to-dashboard>` and add it to a dashboard section
|
||||
starting from the spreadsheet in the Documents app.
|
||||
|
||||
.. _dashboards/access-and-sharing:
|
||||
|
||||
Access rights and sharing
|
||||
=========================
|
||||
|
||||
.. _dashboards/access-and-sharing/viewing:
|
||||
|
||||
Consulting dashboards
|
||||
---------------------
|
||||
|
||||
The *right to view and interact with a dashboard* is based on :ref:`user groups
|
||||
<access-rights/groups>`, and is managed in the :ref:`Configuration settings
|
||||
<dashboards/access-and-sharing/manage-view-access>` of the Dashboards app. Only users who are part
|
||||
of a group that has been granted access to a specific dashboard see that dashboard in the left-hand
|
||||
panel on the main Dashboards page. Users with `Dashboard / Admin` access rights can view all
|
||||
dashboards.
|
||||
|
||||
However, the *visibility of dynamic Odoo data within a dashboard* is handled separately. This is
|
||||
based on a user's :ref:`access rights <access-rights/users>` to the model from which the data has
|
||||
been retrieved, and takes into account any record rules that may restrict access.
|
||||
|
||||
.. important::
|
||||
User permissions are taken into account when a user opens a dashboard, with the dashboard only
|
||||
being populated with data the user is authorized to see. This means that a user could in theory
|
||||
be able to view a dashboard but, due to a lack of appropriate permissions, not be able to see the
|
||||
Odoo data the dashboard's creator intended to be displayed.
|
||||
|
||||
Therefore, it is crucial to take user permissions into consideration when granting dashboard
|
||||
access to groups.
|
||||
|
||||
.. example::
|
||||
Granting the user group `Sales / User: Own Documents Only` access to the :guilabel:`Sales`
|
||||
dashboard would serve little purpose. While users belonging to that group would be able to view
|
||||
and interact with the dashboard, they would only see data related to their own sales, rendering
|
||||
the overall dashboard misleading.
|
||||
|
||||
.. _dashboards/access-and-sharing/manage-view-access:
|
||||
|
||||
Manage access rights to view dashboards
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To manage users' rights to view and interact with a dashboard:
|
||||
|
||||
#. In the Dashboards app, go to :menuselection:`Configuration --> Dashboards`.
|
||||
#. From the list of dashboard sections, open the relevant section.
|
||||
#. On the line of the relevant dashboard, in the :guilabel:`Group` column:
|
||||
|
||||
- add a user group by clicking the field until a dropdown with user groups appears, then
|
||||
selecting the appropriate user group. In the dropdown, click :guilabel:`Search More` to access
|
||||
the full list of user groups;
|
||||
- remove a user group by clicking the relevant group name, then clicking :icon:`fa-times`
|
||||
:guilabel:`(Delete)`.
|
||||
|
||||
.. _dashboards/access-and-sharing/customize-configure-build:
|
||||
|
||||
Building, customizing and configuring dashboards
|
||||
------------------------------------------------
|
||||
|
||||
Only users with `Dashboards / Admin` access rights can :ref:`customize dashboards
|
||||
<build_and_customize_dashboards/customize>` or :ref:`configure dashboard settings
|
||||
<dashboards/configuration>`. To :ref:`build a dashboard from scratch
|
||||
<build_and_customize_dashboards/build>`, a user must have both `Dashboards / Admin` and `Documents
|
||||
/ User` access rights.
|
||||
|
||||
.. _dashboards/access-and-sharing/sharing:
|
||||
|
||||
Share dashboard snapshot
|
||||
------------------------
|
||||
|
||||
To share a frozen version of a dashboard with an internal user who does not have the appropriate
|
||||
access or with an external party, click :icon:`fa-share-alt` :guilabel:`Share` at the top-right of
|
||||
the page then click the :icon:`fa-clone` :guilabel:`(copy)` icon to copy a shareable link to your
|
||||
clipboard.
|
||||
@@ -0,0 +1,223 @@
|
||||
==============================
|
||||
Build and customize dashboards
|
||||
==============================
|
||||
|
||||
In addition to consulting :ref:`standard dashboards <dashboards/consult-dashboards/standard>`, users
|
||||
with the appropriate :ref:`access rights <dashboards/access-and-sharing/customize-configure-build>`
|
||||
can :ref:`build custom dashboards from scratch <build_and_customize_dashboards/build>` or
|
||||
:ref:`customize existing dashboards <build_and_customize_dashboards/customize>` to respond to
|
||||
specific business needs.
|
||||
|
||||
.. _build_and_customize_dashboards/build:
|
||||
|
||||
Build a dashboard
|
||||
=================
|
||||
|
||||
In its most simple terms, building a dashboard involves :doc:`inserting Odoo data into a spreadsheet
|
||||
<../../../applications/productivity/spreadsheet/insert>` then :ref:`converting that spreadsheet into
|
||||
a dashboard <spreadsheet/manage-spreadsheets/convert-to-dashboard>`.
|
||||
|
||||
However, to build a dashboard that delivers relevant and valuable insights, it is important to
|
||||
consider the process in terms of three key stages: :ref:`preparation
|
||||
<build_and_customize_dashboards/build-preparation>`, :ref:`data insertion and manipulation
|
||||
<build_and_customize_dashboards/build-insertion-manipulation>`, and :ref:`data visualization
|
||||
<build_and_customize_dashboards/build-visualization>`.
|
||||
|
||||
.. _build_and_customize_dashboards/build-preparation:
|
||||
|
||||
Preparation
|
||||
-----------
|
||||
|
||||
This stage involves:
|
||||
|
||||
- defining the purpose of the dashboard, in other words, the business questions it needs to answer,
|
||||
and deciding what data would answer those questions;
|
||||
- determining where to find the relevant Odoo data and deciding which :doc:`type of view
|
||||
<../../../applications/studio/views>` (i.e., list, pivot table, or chart) is most suited for the
|
||||
data analysis needed;
|
||||
- preparing the Odoo data by refining the views to focus on the most relevant information, e.g., by
|
||||
using :doc:`search filters <../../../applications/essentials/search>`, by making only certain list
|
||||
fields visible, or by deciding which dimensions and measures a pivot table should use;
|
||||
- sourcing any other information needed to support the dashboard.
|
||||
|
||||
.. _build_and_customize_dashboards/build-insertion-manipulation:
|
||||
|
||||
Data insertion and manipulation
|
||||
-------------------------------
|
||||
|
||||
This stage involves:
|
||||
|
||||
- :doc:`inserting the prepared lists, pivot tables or charts
|
||||
<../../../applications/productivity/spreadsheet/insert>` into the spreadsheet you will use to
|
||||
build your dashboard;
|
||||
- manipulating the data, if needed, to be able to draw the necessary insights. This may involve
|
||||
performing calculations or creating custom metrics using :doc:`standard or Odoo-specific functions
|
||||
and formulas <../../../applications/productivity/spreadsheet/functions>`, referencing data from
|
||||
various sources within the spreadsheet, or :doc:`converting static pivot tables to dynamic pivot
|
||||
tables <../../../applications/productivity/spreadsheet/dynamic_pivot_tables>`.
|
||||
|
||||
.. _build_and_customize_dashboards/build-visualization:
|
||||
|
||||
Data visualization
|
||||
------------------
|
||||
|
||||
This stage involves:
|
||||
|
||||
- presenting the data on at least the first sheet of your spreadsheet (i.e., the sheet that will
|
||||
serve as the front end of your dashboard) in a clear, visual, and meaningful way so it is easy to
|
||||
interpret. Concretely, this means deciding on the layout and order of elements such as tables and
|
||||
charts, as well as using tools and techniques to guide the user, such as clear and descriptive
|
||||
headings, text formatting and colors, carefully chosen chart types, and conditional formatting to
|
||||
highlight specific data visually;
|
||||
- :ref:`inserting clickable links <spreadsheet/insert/clickable-links>`, if relevant, to provide
|
||||
access to Odoo menu items, URLs, or other sheets within the same spreadsheet if these should also
|
||||
be accessible from the front end of your dashboard;
|
||||
- :doc:`creating global filters <../../../applications/productivity/spreadsheet/global_filters>` to
|
||||
allow users to tailor the view to their needs;
|
||||
- :ref:`converting the spreadsheet into a dashboard
|
||||
<spreadsheet/manage-spreadsheets/convert-to-dashboard>`, determining whether to add the dashboard
|
||||
to an existing or new dashboard section, and :ref:`managing access rights to the dashboard
|
||||
<dashboards/access-and-sharing/manage-view-access>`.
|
||||
|
||||
.. tip::
|
||||
- Use standard dashboards as inspiration for how to best present and visualize data. For example,
|
||||
for charts, :ref:`open the underlying spreadsheet
|
||||
<build_and_customize_dashboards/customize/open-spreadsheet>` of a standard dashboard, hover
|
||||
over a chart and click the :icon:`fa-bars` :guilabel:`(menu)` icon, then
|
||||
:icon:`fa-pencil-square-o` :guilabel:`Edit` to see the chart properties on the right side of
|
||||
the screen.
|
||||
- The possibility to link to other sheets within the same spreadsheet allows the creation of a
|
||||
multi-page dashboard, with users able to navigate between pages thanks to clickable links.
|
||||
Global filters apply across all pages of a dashboard.
|
||||
|
||||
.. seealso::
|
||||
`Odoo Tutorial: Dashboard from scratch
|
||||
<https://www.odoo.com/slides/slide/dashboard-from-scratch-8957>`_
|
||||
|
||||
.. _build_and_customize_dashboards/customize:
|
||||
|
||||
Customize a dashboard
|
||||
=====================
|
||||
|
||||
Dashboards are customized by editing the dashboard's underlying spreadsheet.
|
||||
|
||||
.. important::
|
||||
When customizing a :ref:`standard dashboard <dashboards/consult-dashboards/standard>`, it is
|
||||
highly recommended to :ref:`duplicate the dashboard
|
||||
<build_and_customize_dashboards/customize/duplicate-dashboard>` and make any changes on
|
||||
the underlying spreadsheet of the duplicated version. Standard dashboards are reinstalled at
|
||||
each Odoo version upgrade, meaning any customizations on the original version are lost.
|
||||
|
||||
.. _build_and_customize_dashboards/customize/open-spreadsheet:
|
||||
|
||||
Open the underlying spreadsheet
|
||||
-------------------------------
|
||||
|
||||
To open a dashboard's underlying spreadsheet:
|
||||
|
||||
#. In the Dashboards app, go to :menuselection:`Configuration --> Dashboards`.
|
||||
#. Open the relevant dashboard section, then, on the line of the relevant dashboard, click
|
||||
:icon:`fa-pencil` :guilabel:`Edit`.
|
||||
|
||||
.. tip::
|
||||
- Users who do not have the appropriate :ref:`access rights
|
||||
<dashboards/access-and-sharing/customize-configure-build>` to customize a dashboard can still
|
||||
access a read-only version of the dashboard's underlying spreadsheet.
|
||||
- To temporarily unpublish a dashboard while you make changes, disable :guilabel:`Is Published`
|
||||
*before* editing the dashboard, making note to republish it when the customization has been
|
||||
finalized.
|
||||
- With :ref:`developer mode <developer-mode>` activated, click on the :icon:`fa-pencil`
|
||||
:guilabel:`(Edit)` icon beside the name of a dashboard in the left panel to open its underlying
|
||||
spreadsheet.
|
||||
|
||||
The spreadsheet that opens typically consists of at least two sheets:
|
||||
|
||||
- **The first sheet** always serves as the front end of your dashboard, and contains the tables
|
||||
and charts used to structure and visualize the data.
|
||||
|
||||
- **The second and any subsequent sheets** typically contain data used for the calculation of key
|
||||
metrics shown on the first sheet.
|
||||
|
||||
.. note::
|
||||
The :ref:`data sources <spreadsheet/insert/data-sources>` that maintain the connection between
|
||||
the spreadsheet and the relevant models in your database can be viewed by clicking
|
||||
:menuselection:`Data` on the spreadsheet's menu bar. These data sources are identified by
|
||||
their respective :icon:`oi-view-pivot` :guilabel:`(pivot table)`, :icon:`oi-view-list`
|
||||
:guilabel:`(list)` or :icon:`fa-bar-chart` :guilabel:`(chart)` icon, followed by their ID and
|
||||
name, e.g., :icon:`oi-view-pivot` *(#1) Sales Analysis by Product*.
|
||||
|
||||
For :ref:`standard dashboards <dashboards/consult-dashboards/standard>`, while the data sources
|
||||
are still active and visible in the :menuselection:`Data` menu, the corresponding lists and pivot
|
||||
tables have been removed from the spreadsheet for better performance and a neater appearance.
|
||||
|
||||
.. _build_and_customize_dashboards/customize/duplicate-dashboard:
|
||||
|
||||
Duplicate a dashboard
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
To duplicate a dashboard:
|
||||
|
||||
#. In the Dashboards app, go to :menuselection:`Configuration --> Dashboards`.
|
||||
#. Open the relevant dashboard section, then, on the line of the dashboard you want to duplicate,
|
||||
click :icon:`fa-pencil` :guilabel:`Edit`.
|
||||
#. In the spreadsheet that opens, click :menuselection:`File -->` :icon:`os-copy-file`
|
||||
:menuselection:`Make a copy`.
|
||||
#. Rename the duplicated dashboard by clicking the name of the spreadsheet at the top left of the
|
||||
screen and editing as needed.
|
||||
|
||||
.. tip::
|
||||
- To return to the overview of the dashboard section, click the name of the original dashboard at
|
||||
the top left of the page, then the name of the dashboard section.
|
||||
- After duplicating a dashboard, delete the original dashboard by clicking the :icon:`fa-trash`
|
||||
:guilabel:`(trash)` icon or rename it by clicking on the name then editing it.
|
||||
|
||||
.. _dashboards/customize-dashboard/edit-spreadsheet:
|
||||
|
||||
Add, edit, or remove dashboard elements
|
||||
---------------------------------------
|
||||
|
||||
Dashboards can be customized in various ways, such as by:
|
||||
|
||||
- adding new tables and charts based on previously inserted or :ref:`newly inserted Odoo data
|
||||
<dashboards/customize-dashboard/edit-spreadsheet-new-odoo-data>`. This requires a similar approach
|
||||
to :ref:`building a dashboard from scratch <build_and_customize_dashboards/build>`;
|
||||
- :doc:`adding new global filters <../../../applications/productivity/spreadsheet/global_filters>`
|
||||
or editing or deleting existing ones;
|
||||
- :ref:`adding or editing clickable links <spreadsheet/insert/clickable-links>` to Odoo menus, URLs,
|
||||
or to other sheets within the same spreadsheet.
|
||||
|
||||
.. tip::
|
||||
Dashboard elements that are no longer needed can be deleted from the spreadsheet. If, after
|
||||
deleting a dashboard element, a :ref:`data source <spreadsheet/insert/data-sources>` is no longer
|
||||
being used in the spreadsheet, this is indicated by a :icon:`fa-exclamation-triangle`
|
||||
:guilabel:`(warning)` icon in the :guilabel:`Data` menu.
|
||||
|
||||
.. image:: build_and_customize_dashboards/list-deleted.png
|
||||
:alt: Warning to indicate data source no longer used in spreadsheet
|
||||
|
||||
.. _dashboards/customize-dashboard/edit-spreadsheet-new-odoo-data:
|
||||
|
||||
Insert new Odoo data
|
||||
--------------------
|
||||
|
||||
Inserting new Odoo data into a dashboard's underlying spreadsheet requires starting from the
|
||||
relevant Odoo view. To do so:
|
||||
|
||||
#. With the relevant list view, pivot view or graph view open in your database, proceed as follows:
|
||||
|
||||
- For a list view, click the :icon:`fa-cog` :guilabel:`(Actions)` icon beside the name of the
|
||||
view, then :guilabel:`Spreadsheet -->` :icon:`oi-view-list` :menuselection:`Insert list in
|
||||
spreadsheet`.
|
||||
- For a pivot or graph view, click :guilabel:`Insert in Spreadsheet` at the top left of the view.
|
||||
|
||||
#. In the window that opens, edit the name if needed. For a list, edit the number of records, i.e.,
|
||||
rows to be inserted, if needed.
|
||||
#. Click the :guilabel:`Dashboards` tab then select in which dashboard the list, pivot table, or
|
||||
chart should be inserted.
|
||||
|
||||
A list or pivot table is inserted into a new sheet in the dashboard's underlying spreadsheet; a
|
||||
chart is inserted on the first sheet of the spreadsheet.
|
||||
|
||||
.. seealso::
|
||||
:doc:`Inserting Odoo data into a spreadsheet
|
||||
<../../../applications/productivity/spreadsheet/insert>`
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 11 KiB |
@@ -0,0 +1,70 @@
|
||||
============
|
||||
My Dashboard
|
||||
============
|
||||
|
||||
**My Dashboard** allows you to centralize the :doc:`Odoo views <../../studio/views>` you consult
|
||||
most regularly, making it possible to see critical tasks at a glance without having to first
|
||||
navigate through multiple apps. Unlike other Odoo dashboards, My Dashboard is not based on **Odoo
|
||||
Spreadsheet**.
|
||||
|
||||
Views inserted in My Dashboard are fully dynamic and retain many features of the source view, e.g.,
|
||||
sorting of lists, changing the measures used for a pivot table or cohort view, changing the chart
|
||||
type, or clicking on a value or data point to view the underlying record(s).
|
||||
|
||||
.. tip::
|
||||
It is not possible to change the domain, i.e., the filtering or grouping, of a view that has been
|
||||
added to My Dashboard. To change the domain, make the necessary changes in the original view,
|
||||
then re-insert the view in My Dashboard and delete the originally inserted view.
|
||||
|
||||
Add views
|
||||
=========
|
||||
|
||||
Most Odoo views can be added to My Dashboard, including:
|
||||
|
||||
- :ref:`multiple record views <studio/views/multiple-records>` like list, kanban, and map
|
||||
- :ref:`timeline views <studio/views/timeline>` like calendar, cohort, and gantt
|
||||
- :ref:`reporting views <studio/views/reporting>` like pivot and graph
|
||||
|
||||
To add a view to My Dashboard:
|
||||
|
||||
#. With the relevant view open in your database, click the :icon:`fa-cog` :guilabel:`(Actions)` icon
|
||||
beside the name of the view, then :menuselection:`Dashboard`.
|
||||
#. Under :guilabel:`Add to my Dashboard`, rename the view if desired, then click :guilabel:`Add`.
|
||||
|
||||
.. image:: my_dashboard/add-view.png
|
||||
:alt: Adding a view to My Dashboard
|
||||
:scale: 80%
|
||||
|
||||
#. Refresh the page.
|
||||
|
||||
The added view is now visible as a widget in My Dashboard in the Dashboards app.
|
||||
|
||||
.. tip::
|
||||
If added views are not showing in My Dashboard, refresh the browser page.
|
||||
|
||||
Customize layout
|
||||
================
|
||||
|
||||
When at least one view has been added to My Dashboard, the page can be customized as follows:
|
||||
|
||||
- **Change the layout of the page**: Click :guilabel:`Change Layout` in the top-right corner and
|
||||
select the desired layout.
|
||||
|
||||
.. tip::
|
||||
For multi-column layouts, the column limits are identified by :icon:`fa-caret-left`
|
||||
:guilabel:`(left caret)` and :icon:`fa-caret-right` :guilabel:`(right caret)` icons at the
|
||||
bottom of the page. If needed, scroll to the bottom of the page to see the column limits.
|
||||
|
||||
.. image:: my_dashboard/column-limits.png
|
||||
:alt: Column limits visible at bottom of page
|
||||
|
||||
- **Collapse and expand widgets**: By default, an inserted widget is shown fully expanded. To
|
||||
collapse, or minimize, a widget, and show only the title, click the :icon:`fa-window-minimize`
|
||||
:guilabel:`(minimize)` icon at the top right of the widget. To expand a widget, click the
|
||||
:icon:`fa-window-maximize` :guilabel:`(maximize)` icon.
|
||||
- **Move widgets**: Drag and drop widgets to the desired location in the same column or a different
|
||||
column.
|
||||
- **Remove widgets**: To remove a widget from the page, click the :icon:`fa-times`
|
||||
:guilabel:`(remove)` icon.
|
||||
|
||||
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 17 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 928 B |
BIN
content/applications/productivity/dashboards/sales-dashboard.png
Normal file
BIN
content/applications/productivity/dashboards/sales-dashboard.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 63 KiB |
@@ -33,13 +33,17 @@ With Odoo Spreadsheet, you can:
|
||||
The Spreadsheet module is part of **Odoo Documents**.
|
||||
|
||||
.. note::
|
||||
Odoo spreadsheets serve as the foundation for the dashboards available in **Odoo Dashboards**. On
|
||||
a dashboard, charts and data tables are used to display dynamic Odoo data and provide an overview
|
||||
of key business metrics.
|
||||
Odoo spreadsheets serve as the foundation for the :doc:`dashboards available in Odoo Dashboards
|
||||
<../../applications/productivity/dashboards>`. On a dashboard, charts and data tables are used to
|
||||
display dynamic Odoo data and provide an overview of key business metrics.
|
||||
|
||||
Standard, pre-configured dashboards can be customized by editing the dashboard's underlying
|
||||
spreadsheet via Dashboards. Custom dashboards can also be created from scratch, starting
|
||||
from an Odoo spreadsheet; any subsequent modifications are performed via Dashboards.
|
||||
:ref:`Standard, pre-configured dashboards
|
||||
<dashboards/consult-dashboards/standard>` can be :ref:`customized
|
||||
<build_and_customize_dashboards/customize>` by editing the dashboard's underlying spreadsheet via
|
||||
Dashboards. :ref:`Custom dashboards
|
||||
<build_and_customize_dashboards/build>` can also be created from scratch, starting from an Odoo
|
||||
spreadsheet; any subsequent :ref:`modifications <build_and_customize_dashboards/customize>` are
|
||||
performed via Dashboards.
|
||||
|
||||
.. _spreadsheet/create-new:
|
||||
|
||||
@@ -125,16 +129,9 @@ spreadsheet via the :guilabel:`File` menu:
|
||||
- :icon:`fa-print` :guilabel:`Print`: prints a copy of the spreadsheet on a connected printer.
|
||||
- :icon:`os-cog` :guilabel:`Settings`: allows you to view and change the :ref:`locale
|
||||
<spreadsheet/manage-spreadsheets/regional-settings>` of the current spreadsheet.
|
||||
- :icon:`os-add-to-dashboard` :guilabel:`Add to dashboard`: allows you to turn the current
|
||||
spreadsheet into a new dashboard that is accessible via Odoo Dashboards. The following fields must
|
||||
be completed: :guilabel:`Dashboard Name`, the :guilabel:`Dashboard Section` in which the new
|
||||
dashboard will be saved, and :guilabel:`Access Groups` to determine which user groups can access
|
||||
the dashboard.
|
||||
|
||||
.. note::
|
||||
When a spreadsheet is converted into a dashboard, the original spreadsheet is deleted from Odoo
|
||||
Spreadsheet. However, it is still possible to edit the dashboards's underlying spreadsheet via
|
||||
Odoo Dashboards.
|
||||
- :icon:`os-add-to-dashboard` :guilabel:`Add to dashboard`: :ref:`converts
|
||||
<spreadsheet/manage-spreadsheets/convert-to-dashboard>` the current spreadsheet into an Odoo
|
||||
dashboard.
|
||||
|
||||
.. _spreadsheet/manage-spreadsheets/version-history:
|
||||
|
||||
@@ -201,3 +198,30 @@ right of the spreadsheet. To change the locale, select the appropriate locale fr
|
||||
|
||||
If no :icon:`fa-globe` :guilabel:`(globe)` icon is shown, this means the spreadsheet's locale is
|
||||
the same as that of your user profile.
|
||||
|
||||
.. _spreadsheet/manage-spreadsheets/convert-to-dashboard:
|
||||
|
||||
Convert a spreadsheet into a dashboard
|
||||
--------------------------------------
|
||||
|
||||
A user with the appropriate :ref:`access rights <access-rights/groups>` can convert an Odoo
|
||||
spreadsheet into a dashboard that is then accessible via
|
||||
:doc:`Odoo Dashboards <../../../applications/productivity/dashboards>`. To do so:
|
||||
|
||||
#. Click :menuselection:`File -->` :icon:`os-add-to-dashboard` :menuselection:`Add to dashboard`
|
||||
from the menu bar.
|
||||
#. Enter the :guilabel:`Dashboard Name`.
|
||||
#. Select the relevant :guilabel:`Dashboard Section` from the dropdown or, to create a new dashboard
|
||||
section, type the name of the new section, then click :guilabel:`Create`.
|
||||
#. If necessary, modify the :guilabel:`Access Groups` to determine which :ref:`user groups
|
||||
<dashboards/access-and-sharing>` can access the dashboard.
|
||||
#. Click :guilabel:`Create`.
|
||||
|
||||
.. tip::
|
||||
- By default, the first tab of the spreadsheet serves as the front end of the dashboard.
|
||||
- It is also possible to convert a spreadsheet to a dashboard from within the :ref:`Dashboard
|
||||
configuration settings <dashboards/configuration>`, by directly adding the spreadsheet to
|
||||
an existing or new dashboard section.
|
||||
- After a spreadsheet has been converted to a dashboard, it is deleted from Odoo Documents. Any
|
||||
subsequent :ref:`modifications <build_and_customize_dashboards/customize>` need to be made via
|
||||
Odoo Dashboards.
|
||||
|
||||
@@ -252,6 +252,8 @@ With the :guilabel:`Filter properties` pane open:
|
||||
Furthermore, if the values in the range have been retrieved dynamically from the database, as in
|
||||
this case, the text filter is also dynamic, i.e., will reflect changes made to those values.
|
||||
|
||||
.. _spreadsheet/global-filters/manage:
|
||||
|
||||
Manage and use global filters
|
||||
=============================
|
||||
|
||||
|
||||
Reference in New Issue
Block a user