Skip to content

Commit 158366a

Browse files
DOC-2315: Document the Customer Dashboard feature (#40712)
1 parent 92016d8 commit 158366a

20 files changed

+88
-7
lines changed

Diff for: user/back-office/marketing/content-widgets/index.rst

+19-3
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ Manage Content Widgets in the Back-Office
88

99
Content widgets are snippets of structured information that you can insert into any WYSIWYG field in your application. :ref:`WYSIWYG fields <getting-started-wysiwyg-editor-field>` are available throughout OroCommerce; for example, in category descriptions, on edit pages of products, content blocks, and landing pages.
1010

11-
There are four content widget types:
11+
There are six content widget types:
1212

1313
* An Image Slider
14-
* A Contact Us form
14+
* A Contact Us Form
1515
* A Product Mini Block
1616
* A Product Segment
1717
* Tabbed Content
18+
* Customer Dashboard DataGrid
1819

1920
Each of these widget types has a different set of options.
2021

@@ -45,7 +46,7 @@ To create a new content widget:
4546

4647
3. Depending on the widget type, form fields are different:
4748

48-
* **Contact Us Form** - Enables you to add a standard Contact Us form.
49+
* **Contact Us Form** - Enables you to add a standard Contact Us form to the Contact Us storefront page. Once the widget is saved, add it to the **Contact Us Form** field under the :ref:`theme configuration <back-office-theme-configuration>`.
4950

5051
.. image:: /user/img/marketing/content_widgets/contact_us.png
5152
:alt: Contact us content widget form
@@ -86,6 +87,21 @@ To create a new content widget:
8687
.. image:: /user/img/marketing/content_widgets/injected-widget-new.png
8788
:alt: Contact us widget embedded in tabbed content widget
8889

90+
.. _content-widgets--dashboard-datagrid-widget:
91+
92+
* **Customer Dashboard DataGrid** - Enables you to add a structured, table-style (datagrid) widget to the customer user’s :ref:`Dashboard <storefront--dashboard>` page in the My Account section. Each widget presents up to five of the latest records and allows customers to navigate to a dedicated page for full details. You can configure the datagrid widget to display data from one of the following entities:
93+
94+
* **Latest Orders** – Lists the most recent orders placed by the current **customer user**, including order number, total amount, status, and last update.
95+
* **Open Quotes** – Lists open quotes associated with the current **customer**, including quote number, PO number, and expiration date. Depending on the customer user's permissions, they may or may not see quotes from other users within their organization.
96+
* **My Checkouts** – Lists ongoing checkout sessions of the current **customer user**, including the number of items, subtotal, and last update. Customers can proceed to checkout directly from this widget.
97+
* **Requests for Quote** – Lists the most recent RFQs submitted by the current **customer**, including RFQ number, PO number, status, and last update. Depending on the customer user's permissions, they may or may not see RFQs from other users within their organization.
98+
* **My Shopping Lists** – Shows the shopping lists of the current **customer user**, including the shopping list name, the number of items, subtotal, and last update. Users can either edit or view the list based on their permissions.
99+
100+
Once the widget is saved, add it to the **Customer Dashboard Content Widget** field in the :ref:`theme configuration <back-office-theme-configuration>`.
101+
102+
.. image:: /user/img/marketing/content_widgets/customer-dashboard-content-widget.png
103+
:alt: Illustrating the created 5 content widgets on the customer user’s Dashboard page
104+
89105
4. Once you have provided all widget-specific details, click **Save and Close**.
90106

91107
.. .. image:: /user/img/marketing/content_widgets/widget-view.png

Diff for: user/back-office/system/theme-configuration/index.rst

+37-4
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@ To configure your current storefront theme:
1818

1919
4. In the **General** section, configure the following options:
2020

21-
.. image:: /user/img/system/theme-configuration/theme-configuration.png
22-
:alt: Theme configuration details
21+
.. image:: /user/img/system/theme-configuration/theme-configuration-general.png
22+
:alt: General section of the theme configuration
2323

2424
* **Owner** --- Select the owner responsible for the theme configuration.
2525
* **Theme** --- Select the storefront theme from the list. The default theme starting from version 6.1 LTS is *Refreshing Teal*. However, if you select one of your backup themes from the previous OroCommerce LTS versions, the settings under the Configuration menu below will become disabled. You can still configure them under the :ref:`theme system configuration <configuration--commerce--design--theme>` settings.
@@ -31,11 +31,39 @@ To configure your current storefront theme:
3131
* **Description** --- Type a short but meaningful description that can help you and other users understand the specifics of the theme.
3232
* **Type** --- Select the theme type. Currently, only storefront themes are available for configuration.
3333

34-
5. In the **Configuration** section, customize the following options. You can preview each menu configuration setting to visualize what the option does and where the selected storefront menu will be positioned.
34+
5. In the **Configuration** section, customize the following options. You can preview several menu configuration setting to visualize what the option does and where the selected storefront menu will be positioned.
35+
36+
.. image:: /user/img/system/theme-configuration/theme-configuration-config-details.png
37+
:alt: Configuration section of the theme configuration
38+
39+
* **Show Quick Access Menu** --- Enable a storefront quick access menu (:ref:`oro_customer_dashboard_quick_access_menu <menu-management-concept-guide--storefront--quick-access>`) on the customer user’s :ref:`Dashboard <storefront--dashboard>` page. You can edit this menu under *System > Storefront Menus* to include shortcuts to key sections.
40+
41+
.. image:: /user/img/system/theme-configuration/oro-customer-dashboard-quick-access-menu.png
42+
:alt: Illustrating the enabled storefront quick access menu on the customer user’s Dashboard page
43+
44+
* **Show Purchase Volume Chart** --- Enable a bar chart to show the customer user’s total purchase volume over the past 12 months on the customer user’s :ref:`Dashboard <storefront--dashboard>` page. The total purchase volume is the sum of all orders placed by or for this customer user (excluding sub-orders and canceled orders).
45+
46+
.. image:: /user/img/system/theme-configuration/volume-chart.png
47+
:alt: Illustrating the enabled Purchase Volume Chart on the customer user`s Dashboard page
48+
49+
* **Customer Dashboard Content Widget (1-6)** --- Select a :ref:`datagrid content widget <content-widgets--dashboard-datagrid-widget>` from the list of predefined widgets to display on the customer user’s :ref:`Dashboard <storefront--dashboard>` page. You can select up to six content widgets. Only the widgets of the **Customer Dashboard DataGrid** type are displayed in the dropdown list. Each widget presents up to five of the latest records in a grid format, with an option to view all other records on a dedicated page.
50+
51+
.. image:: /user/img/system/theme-configuration/customer-dashboard-content-widgets.png
52+
:alt: Illustrating the selected 5 content widgets on the customer user’s Dashboard page
53+
54+
* **Recommended Products (1-2)** --- Select a :ref:`product segment content widget <content-widgets-user-guide>` from the list of predefined widgets to display on the customer user’s :ref:`Dashboard <storefront--dashboard>` page. You can select up to two content widgets. Only the widgets of the **Product Segment** type are displayed in the dropdown list. This widget highlights specific product segments for the customer user.
55+
56+
.. image:: /user/img/system/theme-configuration/recommended-products-widgets.png
57+
:alt: Illustrating the selected 5 content widgets on the customer user’s Dashboard page
58+
59+
* **Promotional Content Block (1-2)** --- Select a :ref:`content block <user-guide--landing-pages--marketing--content-blocks>` from the dropdown list to display on the customer user’s :ref:`Dashboard <storefront--dashboard>` page. You can select up to two content blocks. This section can include important information such as news, blog posts, or other relevant content.
60+
61+
.. image:: /user/img/system/theme-configuration/dashboard-promotional-block.png
62+
:alt: Illustrating the selected 5 content widgets on the customer user’s Dashboard page
3563

3664
* **Promotional Content** --- Select a :ref:`content block <user-guide--landing-pages--marketing--content-blocks>` from the dropdown list to display it at the top of the storefront header.
3765

38-
.. image:: /user/img/system/theme-configuration/promotional-content-block.png
66+
.. image:: /user/img/system/theme-configuration/promotional-content.png
3967
:alt: Promotional content configuration and representation in the storefront header
4068

4169
* **Top Navigation Menu** --- Select a storefront menu that will be rendered above the header. Please see the :ref:`concept guide on storefront menu items <menu-management-concept-guide>` to learn more about each menu.
@@ -125,6 +153,11 @@ To configure your current storefront theme:
125153

126154
To control whether to hide or disable product attributes within filters, refer to the :ref:`filters and sorting settings <configuration--guide--commerce--configuration--catalog--filters-sorters>` documentation.
127155

156+
* **Contact Us Form** --- Select a :ref:`contact us content widget <content-widgets-user-guide>` from the dropdown list of predefined widgets to display on the Contact Us page. Only the widgets of the **Contact Us Form** type are displayed in the dropdown list.
157+
158+
.. image:: /user/img/system/theme-configuration/contact-us-form-widget.png
159+
:alt: Illustrating the selected contact us widget on the Contact Us page
160+
128161
* **Quantity Inputs in Shopping List** --- Choose how quantity inputs are displayed in the shopping list. Available options are *Plain* (displays a simple input field where users can type the desired quantity manually) and *With Stepper Buttons* (adds ``+`` and ``-`` buttons next to the input field, allowing users to adjust the quantity incrementally).
129162

130163
6. Click **Save Settings**.

Diff for: user/concept-guides/administration/menus/index.rst

+12
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ The way the menu looks and behaves on your website depends on the customization
3636

3737
Let's check each of the available menu items individually.
3838

39+
.. _menu-management-concept-guide-storefront:
40+
3941
Storefront Menu Components
4042
--------------------------
4143

@@ -56,6 +58,16 @@ Once you have configured the menu items, you can add them to the selected :ref:`
5658
.. image:: /user/img/concept-guides/menus/theme-configurations.png
5759
:alt: Selecting a menu item under Theme configuration
5860

61+
.. _menu-management-concept-guide--storefront--quick-access:
62+
63+
Oro_customer_dashboard_quick_access_menu
64+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
65+
66+
**Oro_customer_dashboard_quick_access_menu** refers to a customizable quick access menu that appears on the customer user’s :ref:`Dashboard <storefront--dashboard>` page in their **My Account** section. If enabled in the :ref:`theme configuration <back-office-theme-configuration>`, this menu provides customer users with shortcuts to key sections of their account, such as orders, shopping lists, RFQs, quotes, or other important pages. You can edit the menu to include the necessary links, helping customer users navigate their account more efficiently.
67+
68+
.. image:: /user/img/concept-guides/menus/oro-customer-dashboard-quick-access-menu1.png
69+
:alt: Illustrating the enabled storefront quick access menu on the customer user’s Dashboard page
70+
5971

6072
Frontend_menu
6173
^^^^^^^^^^^^^

Diff for: user/img/concept-guides/menus/frontend_menu_list.png

-1.73 KB
Loading
Loading
Loading

Diff for: user/img/storefront/profile/dashboard_menu.png

642 KB
Loading

Diff for: user/img/storefront/profile/my_account_menu.png

14 KB
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading
-304 Bytes
Loading

Diff for: user/img/system/theme-configuration/volume-chart.png

103 KB
Loading

Diff for: user/storefront/account/dashboard/index.rst

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
.. _storefront--dashboard:
2+
3+
Manage Dashboard in the Storefront
4+
==================================
5+
6+
The **Dashboard** menu offers a clear and organized overview of a customer user’s key account activities. Designed for convenience, it helps users stay informed about their orders, quotes, checkouts, and more in a single location. Dashboard eliminates the need to navigate through multiple pages by centralizing essential account information, providing quick access, real-time updates, and intuitive navigation for customer users.
7+
8+
Dashboard consists of multiple sections that offer instant access to important account details. The sections are customized in the :ref:`theme configuration <back-office-theme-configuration>` in the back-office.
9+
10+
* **Quick Access Menu** – A customizable menu with shortcuts to frequently used pages like orders, shopping lists, and RFQs.
11+
* **Latest Orders, Quotes, RFQs, and Checkouts** – A data grid showing recent activities and transactions, allowing customers to quickly review and manage their activity.
12+
* **Purchase Volume Chart** – A visual breakdown of total purchases over the past 12 months, helping users track their spending.
13+
* **Recommended Products** – Personalized product suggestions based on the segments configured in the back-office.
14+
* **Promotional Content** – Important announcements, news, or special offers displayed directly on the dashboard.
15+
16+
.. image:: /user/img/storefront/profile/dashboard_menu.png
17+
:alt: Illustration of the Dashboard menu
18+

Diff for: user/storefront/account/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ To reach the menu details, click **Account** in the user menu on the top left of
1616

1717
Your account menu has the following sections:
1818

19+
* :ref:`Dashboard <storefront--dashboard>` -- provides a quick and organized overview of a customer user’s key account activities.
1920
* :ref:`My Profile <frontstore-guide--profile>` -- consolidates all your personal contact information and the default addresses you use to provide the billing and shipping locations.
2021
* :ref:`Conversations <storefront-guide--conversations>` -- enables communication between back-office users and customers users.
2122
* :ref:`Address Book <frontstore-guide--address>` -- stores both your company and personal addresses.
@@ -34,6 +35,7 @@ Your account menu has the following sections:
3435
:titlesonly:
3536
:maxdepth: 1
3637

38+
Dashboard <dashboard/index>
3739
My Profile <my-profile/index>
3840
Address Book <address-book/index>
3941
Users <users/index>

0 commit comments

Comments
 (0)