diff --git a/content/applications/essentials/search.rst b/content/applications/essentials/search.rst index aefcd171a..3443b2535 100644 --- a/content/applications/essentials/search.rst +++ b/content/applications/essentials/search.rst @@ -181,6 +181,75 @@ It is possible to *customize groups* by using a field present on the model. To d cluster, the next one that is added further divides the main group's categories, and so on. Furthermore, filters and groups can be used together to refine the view even more. +.. _search/comparison: + +Comparison +========== + +Certain reporting dashboards include a :guilabel:`Comparison` section in the drop-down menus of +their :guilabel:`Search...` bars. This includes the :doc:`Overall Equipment Effectiveness +<../inventory_and_mrp/manufacturing/workflows/oee>` report for the *Manufacturing* app, and the +:doc:`Purchase <../inventory_and_mrp/purchase/advanced/analyze>` report for the *Purchase* app, +among others. + +The options in the :icon:`fa-adjust` :guilabel:`Comparison` section are used to compare data from +two different time periods. There are two comparison options to choose from: :guilabel:`(Time +Filter): Previous Period` and :guilabel:`(Time Filter): Previous Year`. + +.. important:: + For some reports, the :guilabel:`Comparison` section **only** appears in the + :guilabel:`Search...` bar drop-down menu if one (or more) time periods have been selected in the + :guilabel:`Filters` column. This is because, if no time period is specified, there is nothing to + compare. + + Additionally, some reports only allow use of the :guilabel:`Comparison` feature when the + :icon:`fa-pie-chart` :guilabel:`(pie chart)` graph type, or the :icon:`oi-view-pivot` + :guilabel:`(pivot)` view, is selected. A :guilabel:`Comparison` option can be selected even if + another view is enabled, but doing so does **not** change the way data is displayed on the + report. + +.. image:: search/comparison-section.png + :align: center + :alt: The Search... bar for the production analysis report. + +To view data using one of the two comparisons, begin by selecting a time period in the +:guilabel:`Filters` column of the :guilabel:`Search...` bar drop-down menu. Then, select either +:guilabel:`(Time Filter): Previous Period` or :guilabel:`(Time Filter): Previous Year` in the +:guilabel:`Comparison` section. + +With one of the :guilabel:`Comparison` options enabled, the report compares the data for the +selected period, with the data for the same unit of time (month, quarter, year), one period or year +prior. The way the data is displayed depends on the selected view: + +- The :icon:`fa-bar-chart` :guilabel:`(bar chart)` shows two bars, side-by-side, for each unit of + time for the selected time period. The left bar represents the selected time period, while the + right bar represents the previous time period. +- The :icon:`fa-line-chart` :guilabel:`(line chart)` is displayed with two lines, one representing + the selected time period, and the other representing the previous time period. +- The :icon:`fa-pie-chart` :guilabel:`(pie chart)` appears as a large circle with a smaller circle + inside. The larger circle represents the selected time period, while the smaller circle represents + the previous time period. +- The :icon:`oi-view-pivot` :guilabel:`(pivot table)` is displayed with each column split into two + smaller columns. The right column represents the selected time period, while the left column + represents the previous time period. + +.. example:: + In the :guilabel:`Production Analysis` report of the :menuselection:`Manufacturing` app, data for + the second quarter of 2024 is compared to data for the second quarter of 2023. :guilabel:`Q2` is + selected in the :guilabel:`End Date` filter section of the :guilabel:`Search...` bar drop-down + menu. In the :guilabel:`Comparison` section, :guilabel:`End Date: Previous Year` is selected. + + The current year is 2024, so the larger circle shows data for the second quarter (Q2) of 2024. + The smaller circle shows data for the second quarter (Q2) of 2023, which is the same time period, + but one *year* prior. + + If :guilabel:`End Date: Previous Period` is selected instead, the smaller circle shows data for + the first quarter (Q1) of 2024, which is the same time period, but one *period* prior. + + .. image:: search/comparison.png + :align: center + :alt: The comparison view of the Production Analysis report. + .. _search/favorites: Favorites diff --git a/content/applications/essentials/search/comparison-section.png b/content/applications/essentials/search/comparison-section.png new file mode 100644 index 000000000..5f390bcc3 Binary files /dev/null and b/content/applications/essentials/search/comparison-section.png differ diff --git a/content/applications/essentials/search/comparison.png b/content/applications/essentials/search/comparison.png new file mode 100644 index 000000000..b524fae9e Binary files /dev/null and b/content/applications/essentials/search/comparison.png differ