Promotion Report
You can use this JSON structure for configuring a Promotion report.
Required Editions
Available in: Lightning Experience Available in: Enterprise and Unlimited Editions where Consumer Goods Cloud is enabled |
Example
{
"datasources": [
{
"name": "PromotionMeasures"
}
],
"attributes": {
"promotiondimension": [
{
"name": "datefrom",
"datatype": "datetime",
"label": "Date From",
"sort": 1
},
{
"name": "datethru",
"datatype": "datetime",
"label": "Date Thru"
},
{
"name": "instoredatefrom",
"datatype": "datetime",
"label": "In Store From",
"sort": 1
},
{
"name": "instoredatethru",
"datatype": "datetime",
"label": "In Store Thru"
},
{
"name": "type",
"label": "Promotion Type"
},
{
"name": "slogan",
"label": "Promotion Slogan"
},
{
"name": "id",
"label": "Name"
},
{
"name": "phase",
"label": "Phase"
}
],
"productdimension": [
{
"name": "category",
"label": "Category"
},
{
"name": "subcategory",
"label": "Sub Category"
},
{
"name": "brand",
"label": "Brand"
},
{
"name": "product",
"label": "Product"
}
],
"timedimension": [
{
"name": "Total"
}
],
"kpidimension": [
{
"measures": [
{
"name": "PlanEffBaseVolume",
"label": "Planned Baseline"
},
{
"name": "RTRPlanIncrVolume",
"label": "Planned Incr. Volume"
},
{
"name": "RTRProPlanTotalVolume",
"label": "Planned Total Volume"
},
{
"name": "RTRProPlanGrossRev",
"label": "Planned Gross Revenue"
},
{
"name": "RTRProPlanNonPromoSpend",
"label": "Planned Non Promo Spend"
},
{
"name": "RTRProPlanPromoSpend",
"label": "Planned Promo Spend"
},
{
"name": "RTRProPlanNetRevenue",
"label": "Planned Net Revenue"
},
{
"name": "RTRProPlanGrossProfit",
"label": "Planned Gross Profit"
},
{
"name": "RTRProPlanProfitMargin",
"label": "Planned Profit Margin (%)"
},
{
"name": "RTRProPlanROI",
"label": "Planned ROI (%)"
}
],
"name": "Plan",
"type": "filter"
},
{
"measures": [
{
"name": "ActualizedTotalVolume",
"label": "Actual Total Volume"
},
{
"name": "ActualGrossRevenue",
"label": "Actual Gross Revenue"
},
{
"name": "RTRProActualNonPromoSpend",
"label": "Actual Non Promo Spend"
},
{
"name": "RTRProActualPromoSpend",
"label": "Actual Promo Spend"
},
{
"name": "RTRProActualNetRevenue",
"label": "Actual Net Revenue"
},
{
"name": "RTRProActualGrossProfit",
"label": "Actual Gross Profit"
},
{
"name": "RTRProActualProfitMargin",
"label": "Actual Profit Margin (%)"
},
{
"name": "RTRProActualROI",
"label": "Actual ROI (%)"
}
],
"name": "Actual",
"type": "filter"
},
{
"measures": [
{
"name": "RTRProLETotalVolume",
"label": "LE Total Volume"
},
{
"name": "RTRProLEGrossRevenue",
"label": "LE Gross Revenue"
},
{
"name": "RTRProLENonPromoSpend",
"label": "LE Non Promo Spend"
},
{
"name": "RTRProLEPromoSpend",
"label": "LE Promo Spend"
},
{
"name": "RTRProLENetRevenue",
"label": "LE Net Revenue"
},
{
"name": "RTRProLEGrossProfit",
"label": "LE Gross Profit"
},
{
"name": "RTRProLEProfitMargin",
"label": "LE Profit Margin (%)"
},
{
"name": "RTRProLEROI",
"label": "LE ROI (%)"
}
],
"name": "LE",
"type": "filter"
},
{
"measures": [
{
"name": "RTRProPlanTotalVolume",
"label": "Planned Volume"
},
{
"name": "RTRProPlanGrossRev",
"label": "Planned Gross Revenue"
},
{
"name": "RTRProPlanNonPromoSpend",
"label": "Planned Non Promo Spend"
},
{
"name": "RTRProPlanPromoSpend",
"label": "Planned Promo Spend"
},
{
"name": "RTRProPlanNetRevenue",
"label": "Planned Net Revenue"
},
{
"name": "RTRProPlanGrossProfit",
"label": "Planned Gross Profit"
},
{
"name": "RTRProPlanProfitMargin",
"label": "Planned Profit Margin (%)"
},
{
"name": "RTRProPlanROI",
"label": "Planned ROI (%)"
},
{
"name": "RTRProLETotalVolume",
"label": "LE Total Volume"
},
{
"name": "RTRProLEGrossRevenue",
"label": "LE Gross Revenue"
},
{
"name": "RTRProLENonPromoSpend",
"label": "LE Non Promo Spend"
},
{
"name": "RTRProLEPromoSpend",
"label": "LE Promo Spend"
},
{
"name": "RTRProLENetRevenue",
"label": "LE Net Revenue"
},
{
"name": "RTRProLEGrossProfit",
"label": "LE Gross Profit"
},
{
"name": "RTRProLEProfitMargin",
"label": "LE Profit Margin (%)"
},
{
"name": "RTRProLEROI",
"label": "LE ROI (%)"
},
{
"name": "ActualizedTotalVolume",
"label": "Actual Total Volume"
},
{
"name": "ActualGrossRevenue",
"label": "Actual Gross Revenue"
},
{
"name": "RTRProActualNonPromoSpend",
"label": "Actual Non Promo Spend"
},
{
"name": "RTRProActualPromoSpend",
"label": "Actual Promo Spend"
},
{
"name": "RTRProActualNetRevenue",
"label": "Actual Net Revenue"
},
{
"name": "RTRProActualGrossProfit",
"label": "Actual Gross Profit"
},
{
"name": "RTRProActualProfitMargin",
"label": "Actual Profit Margin (%)"
},
{
"name": "RTRProActualROI",
"label": "Actual ROI (%)"
}
],
"name": "ScoreCard",
"type": "scorecard"
}
]
},
"filters": [
{
"label": "Period",
"type": "periodmonth",
"name": "periodmonth"
},
{
"type": "multiselect",
"name": "accountsfids",
"label": "Accounts",
"source": "PlanAccounts",
"required": true
},
{
"type": "multiselect",
"label": "Categories",
"level": "category",
"name": "productsfids",
"source": "Products",
"required": true
},
{
"type": "multiselect",
"label": "Promotion Template",
"name": "promo_templatesfid",
"source": "PromotionTemplate",
"required": true
},
{
"type": "multiselect",
"name": "promo_phase",
"label": "Promotion Phase",
"source": "PromotionPhase",
"defaultValue": [
"Planning"
]
},
{
"type": "singleselect",
"name": "productlevel",
"label": "Lowest Product Level",
"source": "ProductDimension"
},
{
"type": "singleselect",
"name": "kpigroup",
"label": "KPI Set",
"source": "KPIGroup"
}
],
"uimapping": {
"FlatList": {
"rowdims": [
"promotiondimension",
"productdimension",
"timedimension"
],
"coldims": [
"kpidimension"
],
"grouping": {
"rows": [
[
"phase"
],
[
"category",
"subcategory",
"brand"
],
[
"Total"
]
],
"cols": [
[]
]
},
"layout": {
"configuration": [
{
"rowtypefilter": [
0,
1,
2,
3,
4,
5,
"0-P"
],
"columns": [
{
"label": [
"Promotion"
],
"values": [
"promotiondimension.phase",
"promotiondimension.id"
],
"format": [
"string",
"string"
],
"style": {
"width": "100px"
},
"mode": "hierarchy",
"fixed": true,
"coltype": "attribute"
},
{
"label": [
"Product"
],
"values": [
"productdimension.category",
"productdimension.subcategory",
"productdimension.brand",
"productdimension.id"
],
"format": [
"string",
"string",
"string"
],
"style": {
"width": "200px"
},
"mode": "hierarchy",
"fixed": true,
"coltype": "attribute"
},
{
"label": [
"Promotion Slogan",
"Promotion Type"
],
"values": [
"promotiondimension.slogan",
"promotiondimension.type"
],
"format": [
"string",
"string"
],
"style": {
"width": "150px"
},
"mode": "lines",
"fixed": false,
"coltype": "attribute"
},
{
"label": [
"In Store Dates"
],
"values": [
"promotiondimension.instoredatefrom",
"promotiondimension.instoredatethru"
],
"format": [
"DD/MM/YYYY",
"DD/MM/YYYY"
],
"style": {
"width": "100px"
},
"mode": "lines",
"fixed": false,
"coltype": "attribute"
},
{
"label": [
"Shipment Dates"
],
"values": [
"promotiondimension.datefrom",
"promotiondimension.datethru"
],
"format": [
"DD/MM/YYYY",
"DD/MM/YYYY"
],
"style": {
"width": "100px"
},
"mode": "lines",
"fixed": false,
"coltype": "attribute"
},
{
"format": [
"number"
],
"style": {
"width": "100px"
},
"mode": "value",
"fixed": false,
"coltype": "value"
}
]
}
]
}
},
"ScoreCard": {
"KPIGroup": "ScoreCard",
"RowLabels": [
"Plan",
"LE",
"Actual"
],
"ColumnLabels": [
"Volume",
"Gross Revenue",
"Non-Promotion Spend",
"Promotion Spend",
"Net Revenue",
"Gross Profit",
"Profit Margin (%)",
"ROI (%)"
],
"MatrixRows": 3,
"MatrixColumns": 8
}
}
}
Did this article solve your issue?
Let us know so we can improve!

