Dashboards

Dashboards

A Dashboard in Pricefx is a type of graphical user interface (typically a combination of several charts) that often provides at-a-glance views of key performance indicators relevant to a particular objective or business process. The aim is to provide real-time results by aggregating and extracting value from all the data collected.

Dashboards are accessed from the Dashboards page in the main menu.

dashboards_screen.png

Listing with Folders

During the implementation of version 15.0, the Dashboards page was converted to a listing format with folders. This change replaced the older Select Dashboard dropdown with a more scalable structure and is intended to align with the final design and functionality of Dashboards 2.0. The page remains titled Dashboards and retains its position in the main menu.

  • Instead of the Select Dashboard dropdown, you now see a folder structure on the Dashboards screen.

  • You can search for a specific dashboard using the Search input field search_input_field.png.

  • When you select All Dashboards, you see a list of all available dashboards.

  • The ability to assign dashboards to custom folders is exclusively available in the Dashboards Admin section (Administration > Dashboards).

si_outliers_dashboard.png

Actions with Folders

You can perform the following actions with folders on the Dashboards page:

  • Add Folder – Create a new folder to organize dashboards.

  • Rename – Change the name of an existing folder.

  • Delete – Remove a folder.

These actions help keep a growing number of dashboards organized in a way that matches your business structure (for example by region, product line, or role).

Columns

Since version 15.0, the list of columns is fixed and cannot be modified, as it only displays existing pre-configured dashboards.

  • ID – (Object ID and Type Code combination, e.g., 2147483934.DB)

  • Name – (dashboard name, link to open dashboard)

  • Label – (dashboard label, link to open dashboard)

  • Created – (date and time)

  • Created By – (username)

  • Last Update Date – (date and time)

  • Last Update By – (username)

Actions in the Dashboards List

In version 15.0, the only action available in the Dashboards list is:

  • Open – Opens the selected dashboard.

Opening and Navigating Dashboards

The functionalities and appearance of the individual dashboards themselves are unchanged compared to earlier versions; what has changed is how you select and open them from the Dashboards page.

When you open a dashboard:

  • It is identified by the simple filter used in the previously existing Select Dashboard dropdown (now represented as folders and selection on the listing page).

  • You can use the Back to Dashboards arrow button to return from a specific dashboard back to the Dashboards list.

  • The selected dashboard value is retained in the filter when you go back, so you can quickly return to the same folder or dashboard context.

Dashboards are highly configurable:

  • You can modify dashboards so that they reflect exactly the information your business requires.

  • You can also create customized dashboards from scratch, choosing the information and layouts you want to display (subject to your permissions and system configuration).

  • The dashboard can be configured to provide different predefined charts depending on the information you choose, controlled by selecting specific logics in the corresponding dropdowns.

  • The information displayed can be further tailored using filter options, such as input portlets and cascading filters (described later).

Working with Portlets

What Are Portlets?

Portlets are the building blocks of dashboards. A dashboard canvas is composed of multiple portlets, which can be:

  • System portlets – These are the same portlets that are available on the Home page.

  • Portlets predefined by an administrator – Configured specifically for certain dashboards or business use cases.

Once on the canvas, portlets can be removed, resized, or reordered to create the layout that works best for you.

Note: Portlets that contain only inputs (filters) are hidden by default and must be added manually if you want them displayed on the dashboard.

Adding and Removing Portlets

You can customize which portlets appear on your dashboard:

  • Remove a portlet – From the portlet's context menu (three-dot menu), choose Remove to take it off the canvas.

  • Add a portlet – Click the Add Portlet button and select the portlet you want to add. You can also re‑add a portlet you previously removed.

This allows each user to focus on the portlets that matter most to their role, while still starting from a common default layout defined by administrators.

Reorganizing Portlets

You can restructure the dashboard visually by:

  • Drag and drop portlets to a new position on the canvas.

  • Resize portlets by dragging the bottom‑right corner of a portlet.

There are some minimum size rules to keep the layout readable:

  • The minimum height for portlets added via Add Portlet, or that have no default size set in the logic and no saved view preference, is 320 pixels.

  • The minimum width is relative to the screen size:

    • On the largest screens, the minimum width is one third of the canvas width.

    • On the smallest screens (below 1024 px), the minimum width is the entire width of the canvas.

  • Chart portlets always have a minimum width of 100% of the container width.

When a portlet’s size is determined, this order of precedence applies:

  1. View preference (if a user has saved a layout).

  2. Settings in calculation logic for that portlet.

  3. Default portlet size.

Viewing Portlets in a Pop‑Up (Dialog)

If many portlets are present, the content on the dashboard can become hard to read. In that case, you can:

  • Use the Expand icon on the portlet to open it in a pop‑up window for better readability.

  • Use the Open in Dialog option in the portlet’s context menu to display the portlet in a large pop‑up window.

This is particularly helpful for detailed tables or complex charts that require more space.

Chart Tooltips

Most chart portlets show tooltips when you hover over data points. If necessary, you can:

  • Disable chart tooltips by clicking the Hide tooltips button next to the portlet’s context menu.

This can make the chart easier to read during presentations or when tooltips would otherwise obscure important data.

Editing Charts

If a portlet contains a chart, you can:

  • Click the Edit button in the portlet context menu to open the chart in Analytics and continue working with it there.

Important: You cannot change the dashboard chart definition itself this way. Actual dashboard chart configuration must be changed in the dashboard configuration, not via the Analytics edit view.

Embedded Dashboards

Interactive embedded dashboards are supported and behave like regular portlets:

  • Embedded dashboards are displayed as standard portlets on the canvas.

  • They can be resized and moved around just like other portlets.

This enables nesting or reusing dashboards inside other dashboards for composite views.

Wizard Dashboards

Wizard dashboards are dashboards that guide users step‑by‑step through the application or a certain process. The following target pages are currently supported:

  • customersPage

  • contractsPage (Agreements & Promotions)

  • dashboardPage

  • priceListPage

  • productsPage

  • priceShopPage (Quoting)

  • rebateAgreementsPage

  • rebateRecordsPage

Wizard dashboards can be useful for onboarding new users or enforcing specific workflows.

Cascading Filters

If a dashboard contains cascading filters, you can control how dependent filters are shown:

  • Enable Cascade Filter Inputs:

    • Dependent filters become visible only after a value is selected in the master filter.

  • Disable Cascade Filter Inputs:

    • All filters are shown at once, but selecting a value in one filter still limits the values available in the other filters.

This allows you to balance simplicity (fewer visible filters at first) with transparency (all filters visible at once).

Alerts in Portlets

By default, warnings and errors related to portlets are displayed inside the portlet itself. You can define alerts using the following Groovy API methods:

Type

Groovy API Method

With the release of Caribou Lou 14.0, there is no longer a need to enable alerts using the showPortletAlerts feature flag, as this functionality is now enabled by default. Consequently, the showPortletAlerts feature flag is no longer available. For more information see Feature Flags (Dashboard).

Create Action from a Portlet

You can create follow‑up actions directly from dashboards:

  • Create Action – Creates a new action of a specific action type provided by the Pricefx Agents.

  • After using this option, you are taken to User Profile > Actions, where you can edit the newly created action.

Saving Layouts: Preferences and Default Dashboards

When you customize a dashboard (for example by moving portlets, resizing them, or adjusting tables), you can save those changes as a view preference.

What a View Preference Can Store

A preference can store the following types of customizations:

  • Size and position of portlets.

  • Added or removed portlets.

  • All table customizations:

    • Column order

    • Column size

    • Hidden columns

    • Sorting and filtering, etc.

  • Values selected in dashboard inputs, if you choose the option Save inputs preference in the Save dialog (applies only to visible inputs, not hidden inputs).

  • Result matrix customizations – these can optionally be disabled using ResultMatrix.setDisablePreferences().

Dashboards can thus be adjusted to how you like to work (by role, by region, by task) and reopened exactly the same way using preferences.

Managing Preferences (Dashboard Options)

Use the Dashboard Options icon on the dashboard to open the preference management menu. From here you can:

  • Save your customizations as a new preference.

  • Update the currently selected preference with your recent changes.

  • Reset to the currently selected preference as it was last saved.

  • Manage saved preferences:

    • Choose your default preference.

    • Delete unnecessary preferences.

Additionally, you can configure default dashboards:

  • Set the current dashboard as default – This dashboard will automatically load when you open the Dashboards page.

  • Reset the default dashboard – When you open the Dashboards page, a blank page appears with no dashboard selected (unless a global default dashboard is set).

  • Set the current dashboard as the global default dashboard (admins only) – This dashboard will load when users in the partition open the Dashboards page, provided they have not set their own default dashboard.

  • Reset the global default dashboard (admins only) – Removes the global default dashboard setting.

If you are not satisfied with your layout changes at any point, click the Refresh icon to revert to the default dashboard definition for that dashboard.

Exporting Dashboards and Portlets

There are two main ways to export data from a dashboard:

Exporting Individual Portlets

  • Use the portlet context menu to export that portlet’s data to Excel.

  • For chart portlets, you can also download charts as images in various formats:

    • PNG

    • SVG

    • JPEG

    • PDF

  • User input portlets (i.e. portlets containing only inputs/filters) cannot be exported.

Exporting the Whole Dashboard

  • Click Export to Excel on the top bar to export the entire dashboard.

  • In the export dialog, you can exclude specific portlets if you do not want them included.

  • If a portlet contains a chart, the chart image is included on that portlet’s sheet in the exported Excel file.

If you want to switch to the old dashboard type, you can do so by disabling the useReactDashboard feature flag in the Administration section.
Note: The ability to switch to the old Ember dashboard is available only in versions 14.x. Starting from Southside 15.0, Ember dashboards are no longer available.

Asynchronous download is applied by default when exporting portlets or the whole dashboard to Excel.

Using Accelerators in Dashboards

Pricefx Accelerators are tools that help you set up and start running Dashboards faster. For dashboards, there are two main accelerators:

  • Accelerate Customer Insights Package – Provides analytics focused on customer behavior.

  • Accelerate Sales Insights Package – Provides analytics focused on sales performance.

These accelerators help you:

  • Upload and maintain the underlying data more easily.

  • Analyze customer and sales data faster with pre‑built logics, portlets, and dashboards.

If you use these accelerators, dashboards can be deployed much more quickly and consistently across your organization.

Legacy Dashboards and Feature Flags

If you are working with older Pricefx versions, there are some legacy options to be aware of:

  • In versions 14.x, it was possible to switch back to the old dashboard type (Ember dashboards) by disabling the useReactDashboard feature flag in the Administration section.

  • Starting from Southside 15.0, Ember dashboards are no longer available, and the Dashboards page uses React dashboards only.

  • As of Caribou Lou 14.0, the showPortletAlerts feature flag is no longer needed or available, because portlet alerts are enabled by default.

If you are on a newer version (15.0 and above), you can assume that the React‑based folder listing and alert behavior described in this document are the standard and only behavior.

See Also

Found an issue in documentation? Write to us.

 
Pricefx version 15.2.0