Components of UIMapping
A report can either be shown as a flatlist, scorecard, or chart.
Required Editions
Available in: Lightning Experience Available in: Enterprise and Unlimited Editions where Consumer Goods Cloud is enabled |
Flatlist
A flatlist is collapsed and doesn’t load data unless the account plan or the Volume Planning Card is loaded for a promotion.
Here are the components of a flatlist.
- displaygroupsfirst: If set to True you can display the aggregated totals before the product dimensions. By default, product dimensions are displayed before the aggregated total values in RTR.
- layout: Layout of a flatlist.
- coldims: Column dimensions that are identified based on the dimension used for the report.
- rowdims: Order of dimensions and aggregation. Use rowdims to group reports.
- Grouping: List of attributes to a group of rows and columns. Define grouping criteria in the same order as the rowdims. For each defined grouping criterion, a row is shown in the report that aggregates the value. For example, you can group all promotion records by phase, if Phase is defined as a grouping attribute for promotion dimension.
Configure the layout of a flatlist by defining the rowtypefilters, columns, and rowstyles.
In rowtypefilter, define the aggregation levels to be shown. The table provides details of how values are aggregated. The last two columns in the table are examples for rowtypefilter in account category analysis and promotion tactic reports.
The rowtypefilter aren’t adjusted if there are missing rows because of the selection of higher product levels. In such reports, you can't use the rowtypefilter to skip intermediate grouping rows. The rowtype mapping column in an Excel sheet shows the correct product level information.
| rowtype | Description | Account Category Analysis Report | Promotion Tactic Report |
|---|---|---|---|
| 0 | Most detailed row | Product-level KPI | Promotion tactic KPIs - brand level |
| 1 | First level of aggregation | Brand rows | Promotion tactic category rows |
| 2 | Second level of aggregation | Category rows | Promotion tactic rows, KPIs aggregated by tactic |
| 3 | Third level of aggregation | Total rows | Promotion rows, KPIs aggregated by promotion |
| 4 | Fourth level of aggregation | — | Promotion phase, KPIs aggregated by phase |
| 5 | Fifth level of aggregation | — | Total |
| 0-P | Details with missing dimension | — | Promotion brand rows. For example, promotion KPIs. |
| 1-P | First group with missing dimension | — | Promotion category rows |
In rowstyles, define the row format depending on the row hierarchy level. Define the color and font used for rows to show different grouping levels. You can use these values to format rows. To switch to default row style, delete all styles defined in rowstyles section of your flatlist.
| Values | Description | Example | Valid For |
|---|---|---|---|
| bgColor | Background color | light blue, #AABBCC | Rows |
| fontColor | Foreground color | red, #AABBCC | Rows |
| fontStyle | Font weight | 600 | Rows |
| width | Column width | 200 px | Columns |
| alignment | Content horizontal alignment | left, center, right | Rows and Columns |
In columns, define the configuration of the columns shown. These are the attributes of columns in a flatlist.
- label: Enter a label.
- values: Select the dimension attributes that are shown in columns. You can reference each attribute of a dimension by using the syntax: <<dimensionname.attributename>>.
- format: Define the format of the values. For example, dates can have format DD/MM/YYYY.
- style: Define width of a column.
- mode: Select the mode that the column values are shown in:
- value: To show the value of one attribute.
- lines: To show attributes in multiple lines.
- hierarchy: To merge attributes into a single value. Use this mode for all your product dimensions.
- concatenate: To concatenate multiple values separated by a comma.
- fixed: Control whether the column is fixed. The default value is false.
- coltype: Specify whether the column is a dimension attribute or a value. For all value columns (KPIs or time dimension), specify coltype as the value.
To display product-related data in a flaList, define columns in flatLists and add
references using the syntax: productdimension.<level>.<attribute>.
For example, to display the product code at the lowest product level, use productdimension.id.productcode.
"uimapping": {
"FlatList": {
"layout": {
...
"configuration": [
{
"columns": [
{
"label": [
"Product Code"
],
"values": [
"productdimension.id.productcode"
],
"format": [
"string"
],
"style": {
"width": "200px"
},
"mode": "value",
"fixed": true,
"coltype": "attribute"
}Scorecard
References the group of reporting measures and defines columns and rows. The attributes of a scorecard are:
- RowLabels
- ColumnLabels
Use scorecards to view the totals for key metrics at the top of a report.
To show a KPI in the scorecard, define a KPI dimension and set the type as scorecard. The report is enhanced and the report metadata gets a new section.
Here’s a sample JSON for scorecard.
"ScoreCard1": {
"KPIGroup": "ScoreCard1",
"RowLabels": [
"Plan",
"LE",
"Actual"
],
"ColumnLabels": [
"Volume",
"Gross Revenue",
"Total Spend",
"Net Revenue",
"Profit",
"Profit Margin (%)"
],
"MatrixRows": 3,
"MatrixColumns": 6
}The KPIGroup links to the KPIs that you’ve previously defined. The first reporting KPI definition listed is shown in the first row of the first column. The second KPI is shown in the first row of the second column, and so on.
Charts
In addition to flatlists and scorecards, you can view reports as charts. Charts are applicable only to the KPIs for which the object scope is set as Account. With charts, you get better insights about KPI values and the visual representation of data makes reports more comprehensive. Therefore, you can analyze data quickly and easily and make quick and effective decisions.
You can use one of these chart components. Define and view the minimum and maximum values of a KPI. Define the minimum and maximum values as numeric or as KPI values (only if the KPI is included in the selected KPI group).
- Progress bars: View data in a linear format. Here’s an example for progress bar
configuration.
"ProgressBar1": { "KPIGroup": "ScoreCard", "value": "APActualizedTotalVolume", "minValue": 0, "maxValue": "RTRAPPlanTotalVolume" },In this configuration, view the details of only the KPIs that are included in the ScoreCard KPI group.
- Gauges: View data in a semi-circular format—similar to a dial. The data shown in gauges
depends on the distribution type and
value of a KPI. This table gives a few examples of how the gauge is shown for a
distribution type and KPI value combination.
Distribution Type Value of KPI Configuration (Example) Gauge result Equal The range defined by the minimum and maximum values of the KPI is equally distributed per the distribution value. "Gauge1": { "KPIGroup": "ScoreCard", "value": "RTRAPPlanVsLYVolume", "minValue": -30, "maxValue": 30, "distributiontype": "equal", "distributionvalue": 6 },The RTRAPPPlanVsLYVolume KPI is represented as a gauge within the range -30 to 30. Because the distribution value is 6, the entire range is divided into six equal segments. Each segment is marked by a separator and has individual lower and upper thresholds.
- Segment 1: -30 to -20
- Segment 2: -20 to -10
- Segment 3: -10 to 0
- Segment 4: 0 to 10
- Segment 5: 10 to 20
- Segment 6: 20 to 30
Fixed The range defined by the minimum and maximum values of the KPI are distributed into equal-sized segments where the distribution value determines the size of each segment. "Gauge2": { "KPIGroup": "ScoreCard", "value": "RTRAPPlanVsLYVolume", "minValue": -30, "maxValue": 30, "distributiontype": "fixed", "distributionvalue": 15 },The RTRAPPPlanVsLYVolume KPI is represented as a gauge within the range -30 to 30. Because the distribution value is 15, the entire range is divided into different segments and the range of each segment is 15. Each segment is marked by a separator and has individual lower and upper thresholds.
- Segment 1: -30–-15 -15
- Segment 2: -15–0
- Segment 3: 0–15
- Segment 4: 15–30
