Sample KPI Set JSON
When a KPI set is changed, the system generates the configuration JSON and sends the JSON to the processing service to transport the details of the KPI set across the deployment stages.
Required Editions
Available in: Lightning Experience Available in: Enterprise and Unlimited Editions where Consumer Goods Cloud is enabled |
Here’s a sample KPI set JSON file.
{
"measures":[
{
"valuetype":"Price",
"type":"read",
"storageoptions":{
"writeback":false
},
"name":"BasePrice",
"display":{
"subsets":["Planning","Finance"],
"round":2,
"enabled":true
},
"datasource":{
"tablename":"accountproductmeasure",
"measurecode":"BASP",
"aggregationmode":"standard"
},
"aggregation":{
"timerule":"aggregate",
"skippeddimensions":["Tactic"]}
},
{
"valuetype":"Volume",
"type":"read",
"totalcalculation":{
"rule":"sum"
},
"storageoptions":{
"writeback":false
},
"name":"PlanBaseVolume",
"display":{
"subsets":["Planning","Monitoring"],
"round":0,
"enabled":true
},
"datasource":{
"weekoffset":0,
"tablename":"weeklymeasureint",
"measurecode":"BSL",
"aggregationmode":"standard"
},
"aggregation":{
"timerule":"aggregate",
"skippeddimensions":["Tactic"],
"rule":"sum"
}
},
{
"valuetype":"Volume",
"type":"editable",
"totalcalculation":{
"rule":"sum"
},
"storageoptions":{
"writeback":false,
"storagelevels":["Product"]
},
"name":"OverrideIncrVolume",
"editable":{
"storagelevel":"inputlevel",
"enablepastweeks":false,
"editmode":"week",
"code":"OIV"
},
"distribution":{
"timehierarchydisttype":"equal",
"planhierarchydisttype":"equal",
"distributionorder":"TimeThenPlan"
},
"display":{
"subsets":["Planning","Monitoring"],
"round":0,
"enabled":true
},
"aggregation":{
"timerule":"aggregate",
"rule":"sum"}
},
{
"type":"compound",
"name":"TotalVolume_Compound",
"children":[
{
"name":"ProPlanTotalVolume",
"compoundmain":true
},
{
"name":"ProUpliftPercent",
"compoundmain":false
},
{
"name":"ProPlanIncrVolume","compoundmain":false
}
]
},
{
"valuetype":"Volume",
"type":"editable_calculated",
"totalcalculation":{
"rule":"sum"
},
"storageoptions":{
"writeback":true,
"tablename":"weeklypromotionmeasureresult",
"storagelevels":["Product"],"code":"PPIV"},
"name":"ProPlanIncrVolume",
"formula":"(ProPlanTotalVolume, PlanBaseVolume) => {return
ProPlanTotalVolume - PlanBaseVolume;}",
"editable":
{
"storagelevel":"inputlevel",
"enablepastweeks":false,
"editmode":"all",
"code":"PPIV"
},
"distribution":{
"timehierarchydisttype":"equal",
"planhierarchydisttype":"equal",
"distributionorder":"TimeThenPlan"
},
"display":{
"subsets":["Planning","VPC"],
"round":0,
"enabled":true
},
"compoundmain":false,
"aggregation":{
"timerule":"aggregate",
"skippeddimensions":["Tactic"],
"rule":"sum"
}
},
{
"valuetype":"Volume",
"type":"editable_calculated",
"totalcalculation":{
"rule":"sum"
},
"storageoptions":{
"writeback":false,
"storagelevels":["Product"]
},
"name":"ProPlanTotalVolume",
"formula":"(PlanBaseVolume, ProPlanIncrVolume, ProUpliftPercent, ManualInput)
=> {\r\n\tif (ManualInput === undefined) {\r\n\t\treturn
PlanBaseVolume;\r\n\t}\r\n\tif (ManualInput === 'ProPlanIncrVolume')
{\r\n\t\treturn PlanBaseVolume + ProPlanIncrVolume;\r\n\t}\r\n\tif (ManualInput
=== 'ProUpliftPercent') {\r\n\t\treturn PlanBaseVolume * (1 +
(ProUpliftPercent/ 100.0));\r\n\t}\r\n\treturn 0;\r\n}",
"editable":{
"storagelevel":"inputlevel",
"enablepastweeks":false,
"editmode":"all",
"code":"PPTV"
},
"distribution":{
"timehierarchydisttype":"equal",
"planhierarchydisttype":"equal",
"distributionorder":"TimeThenPlan"
},
"display":{
"subsets":["Planning","VPC"],
"round":0,
"enabled":true
},
"compoundmain":true,
"aggregation":{
"timerule":"aggregate",
"skippeddimensions":["Tactic"],
"rule":"sum"
}
},
{
"valuetype":"Percentage",
"type":"editable_calculated",
"totalcalculation":{
"rule":"formula"},
"storageoptions":{
"writeback":false,
"storagelevels":["Product"]
},
"name":"ProUpliftPercent",
"formula":"(ProPlanTotalVolume, PlanBaseVolume) => {\r\n\treturn
(PlanBaseVolume != 0 && PlanBaseVolume != null) ? (ProPlanTotalVolume===
PlanBaseVolume ? null : 100 * (ProPlanTotalVolume- PlanBaseVolume) /
PlanBaseVolume) : null;\r\n}",
"editable":{
"storagelevel":"inputlevel",
"enablepastweeks":false,
"editmode":"all",
"code":"LIFT"
},
"distribution":{
"timehierarchydisttype":"equal",
"planhierarchydisttype":"equal",
"distributionorder":"TimeThenPlan"
},
"display":{
"subsets":["Planning","VPC"],
"round":2,
"enabled":true
},
"compoundmain":false,
"aggregation":{
"timerule":"formula",
"skippeddimensions":["Tactic"],
"rule":"formula"
}
},
{
"valuetype":"Money",
"type":"calculated",
"totalcalculation":{
"rule":"sum",
"cumulative":"off"
},
"storageoptions":{
"writeback":false
},
"name":"BaseRevenue",
"formula":"(PlanBaseVolume,BasePrice)=>{ return PlanBaseVolume *
BasePrice;}",
"display":{
"subsets":["Planning","Monitoring"],
"round":2,
"enabled":false
},
"aggregation":{
"timerule":"aggregate",
"skippeddimensions":["Tactic"],
"rule":"sum"
}
}
],
"axis":{
"y":["measures","Tactic","Product"],
"x":"Week"
}
}Did this article solve your issue?
Let us know so we can improve!
