Configure the Sankey dashboard for a custom page
To place the Sales pipeline movement (Sankey) chart on a page other than its out-of-the-box locations, add it as a component in the Freedom UI Designer. For example, add the chart to a sales team page to show how deals moved between forecast categories this quarter. Then set up its period filters and, if needed, its data source. Learn more about the chart: Pipeline movement dashboard.
You can add the chart only to Freedom UI pages. The chart is not available in the Dashboard Designer.
The functionality is disabled out of the box. To activate it, add and enable the ShowDesignerDemoItems additional feature. Learn more: Implement a custom additional feature, Manage an existing additional feature.
The chart requires the Lead and Opportunity Management and Sales Forecasts apps.
Add the chart to a page
-
Open the Freedom UI Designer for the page.
-
Add the Sales pipeline movement component to the page.
The component is in the Widgets group of the component list. The designer shows sample data for the chart.
-
Set up the widget in the Widget settings panel.
Setting
Description
Title
The widget title. Required. Out of the box, "Sales pipeline movement."
Style
The visual style of the widget: "Fully colored" or "Plain white." Out of the box, "Fully colored."
Color
The widget color.
Hide border
Whether to hide the widget border. Available only for the "Plain white" style.
Apply filter by page data
Show data related to the page. For example, show the pipeline movement of opportunities that match the filters of a list on the page. To do this, select the list in the Data source field, for example, "List Opportunity | DataTable." Then select "Id" in the Opportunity and Pipeline Movement fields.
Visibility
Whether the widget is visible. Select Set up conditions to show the widget only when the conditions are met.
-
Add a Quick filter component for the change period.
-
Set up the filter in the Quick filter settings panel.
Field name
Field value
Choose a filter type
Date/Time
Component to filter
"Sales pipeline movement (Series) | [element code]." The option shows the element code of the chart, not its title, so the option name stays the same if you rename the chart.
Choose a filtering method
Set up filter by date range
Filter column From and Filter column To
Changes Period
You can also set up the Default period, Enable time, and Show fiscal periods options. For example, in the Sales forecasts section, the change period filter uses "Current week" as the default period and shows time and fiscal periods.
-
Add another Quick filter component for the close date and set it up the same way, but select "Fiscal Period" in the Filter column From and Filter column To fields.
The chart needs both filters to calculate the movement correctly. "Changes Period" sets when the updates happened. "Fiscal Period" sets which opportunities to analyze by their close date. In the Sales forecasts section, the close date filter uses the current quarter as the default period and shows fiscal periods without time.
-
Save the page.
As a result, the Sales pipeline movement chart will appear on your custom page. It shows how opportunities moved among forecast categories in the selected periods. Users can change the periods using the quick filters.
Update filter options
Out of the box, the chart uses the "Opportunity" (Opportunity code) object and its change history. If your source object uses other column names, update the filter options at config/data/designOptions/filterOptions in the page source code.
Out of the box, filterOptions includes only the HistoricalDataEntityName, EntityName, DateColumnName, StageColumnName, and AmountColumnName parameters. If a parameter is not in filterOptions, the chart uses its default value. To change the value, add the parameter. Do not leave a parameter value empty. To use the default value, remove the parameter instead.
Parameter | Description |
|---|---|
| Name of the historical table for the source object. Out of the box, |
| Name of the source object. Out of the box, |
| Column name for the close date in the source object. Out of the box, |
| Column name for the stage in the source object. Must be a lookup. Out of the box, |
| Column name in the stage lookup that marks a stage as final. Out of the box, |
| Column name in the stage lookup that marks a final stage as successful. Out of the box, |
| Column name for the amount in the source object. Out of the box, |
| Column name for the forecast category in the source object. Must be a lookup. Out of the box, |
| Column name for the category name in the forecast category lookup. Out of the box, |
| Column name for the category color in the forecast category lookup. Out of the box, |
| Column name for the category order in the forecast category lookup. Out of the box, |
The source object must track the history of the date, stage, amount, and forecast category columns. For each of these columns, the historical table must also have a column with the same name and the Old suffix, for example, DueDateOld, StageOld, AmountOld, and ForecastCategoryOld. Learn more: Enable historical tracking for custom fields.
Change category names and colors
The Sankey chart takes the names, order, and colors of its categories from lookups:
- Movement categories, such as "New," "Pulled In," "Upgraded," "Won," or "Slipped," come from the lookup based on the "Pipeline Stage" (
PipelineStagecode) object. Use the "Order" and "Color" columns of this lookup to change the order and color of a category. - Forecast categories, such as "Pipeline," "Best case," or "Commit," come from the lookup based on the "Forecast category" (
ForecastCategorycode) object. Use its "Index" and "Color" columns to change their order and color.
Out of the box, these lookups are not registered in the Lookups section. To edit their values, register a lookup for each object first. Learn more: Create new lookups, Manage lookup values.
See also
Configure the Sales waterfall pipeline dashboard for a custom page