Skip to content

Commit b6c6987

Browse files
committed
[IMP] spreadsheet: insert odoo data various updates
task-3595405 closes #13720 Signed-off-by: Xavier Platteau (xpl) <[email protected]>
1 parent 3a05404 commit b6c6987

File tree

1 file changed

+68
-40
lines changed
  • content/applications/productivity/spreadsheet

1 file changed

+68
-40
lines changed

content/applications/productivity/spreadsheet/insert.rst

Lines changed: 68 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ Several elements from your Odoo database can be inserted into an Odoo spreadshee
1010

1111
Each time a list, pivot table, or chart is inserted, a :ref:`data source
1212
<spreadsheet/insert/data-sources>` is created. This data source connects the spreadsheet to your
13-
Odoo database, retrieving up-to-date information every time the spreadsheet is opened or reloaded.
13+
Odoo database, retrieving up-to-date information every time the spreadsheet is opened, the browser
14+
page is reloaded, or data is manually refreshed by clicking :menuselection:`Data --> Refresh all
15+
data` from the menu bar.
1416

1517
:ref:`Inserted lists <spreadsheet/insert/list>` and :ref:`inserted pivot tables
1618
<spreadsheet/insert/pivot-table>` use formulas with Odoo-specific :ref:`list functions
@@ -19,6 +21,10 @@ Odoo database, retrieving up-to-date information every time the spreadsheet is o
1921
further manipulated in the spreadsheet. Certain elements of :ref:`inserted charts
2022
<spreadsheet/insert/chart>` can be modified, but no data manipulation or computation is possible.
2123

24+
.. note::
25+
Lists, pivot tables, and charts from different apps and models can be inserted into the same
26+
spreadsheet.
27+
2228
.. tip::
2329
If you intend to use :doc:`global filters <global_filters>` to dynamically filter Odoo data in
2430
a spreadsheet or dashboard, do not use the same conditions to establish the initial list, pivot
@@ -41,7 +47,8 @@ Data sources
4147
Data sources, which are created each time a :ref:`list <spreadsheet/insert/list>`, :ref:`pivot table
4248
<spreadsheet/insert/pivot-table>` or :ref:`graph <spreadsheet/insert/chart>` is inserted into an
4349
Odoo spreadsheet, connect the spreadsheet and the relevant :doc:`model
44-
<../../studio/models_modules_apps>` in your database.
50+
<../../studio/models_modules_apps>` in your database, keeping the data in the spreadsheet
51+
up-to-date.
4552

4653
Each data source is defined by properties that can be accessed via the :guilabel:`Data` menu. Data
4754
sources are identified by their respective :icon:`oi-view-pivot` :guilabel:`(pivot table)`,
@@ -51,12 +58,17 @@ by their ID and name, e.g., :icon:`oi-view-pivot` *(#1) Sales Analysis by Produc
5158
.. image:: insert/data-menu.png
5259
:alt: Data sources listed in Data menu
5360

54-
Clicking on a data source opens its properties in a pane to the right of the spreadsheet.
61+
Clicking on a data source opens the related properties in a pane on the right of the spreadsheet.
5562

5663
.. tip::
57-
Once the properties of a specific data source are open, they remain open even when navigating
58-
between spreadsheet tabs. To close the properties pane, click the :icon:`fa-times`
59-
:guilabel:`(close)` icon at the top right of the pane.
64+
- The properties pane can also be opened by right-clicking any cell of an inserted list or pivot
65+
table, then clicking :icon:`oi-view-list` :guilabel:`See list properties` or
66+
:icon:`oi-view-pivot` :guilabel:`See pivot properties`, or by clicking the :icon:`fa-bars`
67+
:guilabel:`(menu)` icon at the top right of an inserted chart, then clicking
68+
:icon:`fa-pencil-square-o` :guilabel:`Edit`.
69+
- Once the properties of a specific data source are open, they remain open even when navigating
70+
between spreadsheet tabs. To close the properties pane, click the :icon:`fa-times`
71+
:guilabel:`(close)` icon at the top right of the pane.
6072

6173
.. note::
6274
Deleting an inserted list or pivot table, or deleting the sheet into which it was inserted, does
@@ -83,9 +95,9 @@ Insert a list
8395

8496
To insert a list:
8597

86-
#. With the list view selected, click the :icon:`fa-cog` :guilabel:`(Actions)` icon
87-
beside the name of the view, then :menuselection:`Spreadsheet -->` :icon:`oi-view-list`
88-
:menuselection:`Insert list in spreadsheet`.
98+
#. With the relevant list view open in your database, click the :icon:`fa-cog`
99+
:guilabel:`(Actions)` icon beside the name of the view, then :menuselection:`Spreadsheet -->`
100+
:icon:`oi-view-list` :menuselection:`Insert list in spreadsheet`.
89101

90102
.. note::
91103
To insert only specific records, select the relevant records, click the :icon:`fa-cog`
@@ -139,6 +151,9 @@ name of the list followed by the list ID, e.g., *Quotations by Total (List #1)*.
139151
side of the screen shows the :ref:`list properties <spreadsheet/insert/list-properties>`.
140152

141153
.. tip::
154+
- To view an individual record of an inserted list, right-click on any cell of the relevant row,
155+
then click :icon:`fa-eye` :guilabel:`See record`. To return to the spreadsheet, click the name
156+
of the spreadsheet in the breadcrumbs at the top of the page.
142157
- To sever the link between an inserted list and your database, select the entire list,
143158
right-click and select :icon:`fa-clone` :guilabel:`Copy` then right-click again and select
144159
:menuselection:`Paste special --> Paste as value`.
@@ -168,9 +183,10 @@ The arguments of the function are as follows:
168183
- `field_name`: the technical name of the field.
169184

170185
.. tip::
171-
To see the formulas of spreadsheet cells, click :menuselection:`View -->` :icon:`fa-eye`
172-
:menuselection:`Show --> Formulas` on the menu bar. The example below shows the functions used to
173-
retrieve list values.
186+
Clicking on an individual cell displays the related formula, if relevant, in the formula bar. To
187+
display all the formulas of a spreadsheet at the same time, click :menuselection:`View -->`
188+
:icon:`fa-eye` :menuselection:`Show --> Formulas` on the menu bar. The example below shows the
189+
functions used to retrieve list headers and values.
174190

175191
.. image:: insert/list-formulas.png
176192
:alt: Viewing formulas of spreadsheet cells
@@ -182,7 +198,8 @@ List properties
182198

183199
The list properties appear on the right side of the screen when a list is inserted. They can be
184200
accessed at any time via the :guilabel:`Data` menu by clicking the relevant list, as prefaced by
185-
the :icon:`oi-view-list` :guilabel:`(list)` icon.
201+
the :icon:`oi-view-list` :guilabel:`(list)` icon, or by right-clicking anywhere on the list and
202+
clicking :icon:`oi-view-list` :guilabel:`See list properties`.
186203

187204
The following list properties are shown, some of which can be edited:
188205

@@ -331,17 +348,14 @@ Insert a pivot table
331348
====================
332349

333350
.. tip::
334-
When a pivot table is inserted into a spreadsheet, it is by default static. Converting a static
335-
pivot table to a :doc:`dynamic pivot table <dynamic_pivot_tables>` ensures the pivot table can
336-
expand to accommodate new data series, such as sales data for a new quarter, and allows you to
337-
modify the dimensions (i.e., columns and rows) and measures.
338-
339-
It is therefore possible to insert a basic pivot table with minimal configuration and refine it
340-
directly in the spreadsheet after converting it to a dynamic pivot table.
351+
Converting an inserted pivot table to a :doc:`dynamic pivot table <dynamic_pivot_tables>` allows
352+
you to add, remove, and manipulate dimensions (i.e., columns and rows) and measures. It is
353+
therefore possible to insert a basic pivot table with minimal configuration, convert it to a
354+
dynamic pivot table, then refine it directly in the spreadsheet.
341355

342356
To insert a pivot table:
343357

344-
#. With the pivot view selected, click :guilabel:`Insert in Spreadsheet`.
358+
#. With the relevant pivot view open in your database, click :guilabel:`Insert in Spreadsheet`.
345359
#. In the window that opens, edit the :guilabel:`Name of the pivot` if needed.
346360

347361
This name is used in the sheet name and in the :ref:`pivot table properties
@@ -366,6 +380,18 @@ shows the name of the pivot table followed by the pivot table ID, e.g., *Sales A
366380
Team (Pivot #1)*. A pane on the right side of the screen shows the :ref:`pivot table properties
367381
<spreadsheet/insert/pivot-table-properties>`.
368382

383+
.. tip::
384+
- To view the records referenced by an individual cell of a pivot table, right-click on the cell,
385+
then click :icon:`fa-eye` :guilabel:`See record`. To return to the spreadsheet, click the name
386+
of the spreadsheet in the breadcrumbs at the top of the page.
387+
- To sever the link between an inserted pivot table and your database, select the entire pivot
388+
table, right-click and select :icon:`fa-clone` :guilabel:`Copy`, then right-click again and
389+
select :menuselection:`Paste special --> Paste as value`.
390+
- Do not modify the pivot table ID in the sheet name, as the inserted pivot table retains this ID
391+
for the lifetime of the spreadsheet. This pivot table ID is used in the :ref:`spreadsheet
392+
functions <spreadsheet/insert/pivot-table-functions-static>` that retrieve data from your
393+
database.
394+
369395
.. _spreadsheet/insert/pivot-table-functions-static:
370396

371397
Pivot table functions
@@ -393,9 +419,10 @@ The arguments of the functions are as follows:
393419
period targeted.
394420

395421
.. tip::
396-
To see the formulas of spreadsheet cells, click :menuselection:`View -->` :icon:`fa-eye`
397-
:menuselection:`Show --> Formulas` on the menu bar. The example below shows the functions for a
398-
static pivot table.
422+
Clicking on an individual cell displays the related formula, if relevant, in the formula bar. To
423+
display all the formulas of a spreadsheet at the same time, click :menuselection:`View -->`
424+
:icon:`fa-eye` :menuselection:`Show --> Formulas` on the menu bar. The example below shows the
425+
functions used to retrieve headers and values of a static pivot table.
399426

400427
.. image:: insert/pivot-table-formulas.png
401428
:alt: Functions of a static pivot table
@@ -511,7 +538,7 @@ Insert a chart
511538

512539
To insert a chart from an Odoo database into an Odoo spreadsheet:
513540

514-
#. With the graph view selected, click :guilabel:`Insert in Spreadsheet`.
541+
#. With the relevant graph view open in your database, click :guilabel:`Insert in Spreadsheet`.
515542
#. In the window that opens, edit the :guilabel:`Name of the graph` if needed.
516543

517544
#. Click :guilabel:`Blank spreadsheet` or select in which existing spreadsheet the chart should be
@@ -527,6 +554,14 @@ To insert a chart from an Odoo database into an Odoo spreadsheet:
527554

528555
Charts are inserted on the first sheet of the spreadsheet.
529556

557+
.. tip::
558+
Clicking on a data point in a chart opens the relevant list view in the database. In the example,q
559+
clicking on :guilabel:`Jessica Childs` opens the list view of all sales by this salesperson that
560+
match the domain of the chart.
561+
562+
.. image:: insert/clickable-link-chart.png
563+
:alt: A clickable link to an Odoo menu plus clickable data point
564+
530565
.. _spreadsheet/insert/chart-properties:
531566

532567
Chart properties
@@ -677,10 +712,11 @@ sections.
677712

678713
The :guilabel:`General` section lets you modify the following elements:
679714

680-
- :guilabel:`Background color`: Add or change the background color by clicking on the circle. Choose
681-
one of the standard colors or click the :icon:`fa-plus` icon to manually select a custom color.
682-
- :guilabel:`Chart title`: Edit the chart title. The font formatting, horizontal alignment and
683-
color of the title can be modified using the editor.
715+
- :guilabel:`Background color`: Add or change the background color by clicking on the color dot.
716+
Choose one of the standard colors or click the :icon:`fa-plus` icon to manually select a custom
717+
color.
718+
- :guilabel:`Chart title`: Edit the chart title, if needed. The font formatting, horizontal
719+
alignment and color of the title can be modified using the editor.
684720
- :guilabel:`Vertical axis position`: Choose whether the vertical axis is placed on the left or
685721
right in line, column, and area charts.
686722
- :guilabel:`Legend position`: Change the position of the legend or opt to have no legend.
@@ -729,9 +765,9 @@ To insert a clickable link from a cell:
729765
right-click on the cell, then click :icon:`fa-link` :guilabel:`Insert link`. Next, depending on
730766
the desired outcome, perform one of the following actions:
731767

732-
- Click the :icon:`fa-bars` :guilabel:`(menu)` icon, then :guilabel:`Link an Odoo menu`. Select the relevant
733-
menu item from the list or click :guilabel:`Search more` to choose from a list of all menu
734-
items. Click :guilabel:`Confirm`.
768+
- Click the :icon:`fa-bars` :guilabel:`(menu)` icon, then :guilabel:`Link an Odoo menu`. Select
769+
the relevant menu item from the list or click :guilabel:`Search more` to choose from a list of
770+
all menu items. Click :guilabel:`Confirm`.
735771
- Click the :icon:`fa-bars` :guilabel:`(menu)` icon, then :guilabel:`Link sheet`, then choose the
736772
relevant sheet from the current spreadsheet.
737773
- Under :guilabel:`Link`, type a URL.
@@ -755,14 +791,6 @@ To insert a clickable link from a chart to an Odoo menu item:
755791
Hover over the top right of the chart's box to see that a new :icon:`fa-external-link`
756792
:guilabel:`(external link)` icon has been added.
757793

758-
.. tip::
759-
Clicking on a data point in a chart opens the relevant list view in the database. In the example
760-
clicking on :guilabel:`Jessica Childs` opens the list view of all sales by this salesperson that
761-
match the domain of the chart.
762-
763-
.. image:: insert/clickable-link-chart.png
764-
:alt: A clickable link to an Odoo menu plus clickable data point
765-
766794
.. _spreadsheet/insert/financial-data:
767795

768796
Insert financial data

0 commit comments

Comments
 (0)