Create a Payment Report
Use a Payment report to view the payment amount spent for a tactic and product, along with their planned funds or remaining liability. To analyze outstanding payments and the difference between the actual and expected payments, add attributes from payment or condition attributes on payment tactic reports.
Required Editions
Available in: Lightning Experience Available in: Enterprise and Unlimited Editions where Consumer Goods Cloud is enabled |
| User Permissions Needed | |
|---|---|
| To configure a report dimension: | CGCloud Real-Time Reporting Admin |
-
Use the PromotionTacticPaymentMeasures and AllPromotionTacticPaymentMeasures as
datasources.
The PromotionTacticPaymentMeasures datasource shows only the promotion records with the tactics that have at least one payment related to it. The AllPromotionTacticPaymentMeasures datasource shows all promotions and tactics including the payment information for the tactics that have payments related to them.
Snippet for datasource.
"datasources": [ {" name": "PromotionTacticPaymentMeasures" } ], -
To include information about payment status, payout, payment amount, and payment type,
configure the attributes list of the payment dimension.
Snippet to add attributes.
"paymentdimension": [ {" name": "paymentstatus", "label": "Payment Status" }, {" name": "totalpayout", "label": "Tactic Payout" }, {" name": "amount", "label": "Amount" }, {" name": "paymenttype", "label": "Payment Type" } ], -
To include KPI definitions at the promotion-tactic-payment level, adapt the list of
measures.
You can calculate the remaining spend or liability directly by using the payment-tactic and promotion-tactic KPIs.
Snippet to configure the remaining spend.
// PayPaymentAmount = Payment KPI // FixedAmountLumpSum = Tactic KPI (PayPaymentAmount, FixedAmountLumpSum) => { if (PayPaymentAmount && FixedAmountLumpSum){ return FixedAmountLumpSum - PayPaymentAmount; } return null; } -
To combine information from records with conditions created for a specific tactic and
product in a payment report, add condition Information.
For example, include the Tactic Product condition attribute in the metadata to show costs of tactics as columns in a flatlist. You can’t use the Tactic Product Condition attribute for grouping or sorting. So, you can’t add these attributes to rowdims.
Snippet to define the Tactic Product Condition attribute.
"tacticproductconditionattr": [ {" name": "status", "label": "Condition Status" }, {" name": "value", "label": "Condition Value" } ], -
Configure the UIMapping.
Define the payment dimension as the row dimensions of the report and define the columns similar to the other reports.
You can make the aggregation order flexible. So, you can show the spend of multiple payments related to individual tactics, or group and aggregate all promotions by product level. To make the aggregation order flexible, adapt the dimension order. If you define the dimension order as promotion dimension, tactic dimension, payment dimension, and product dimension, the payment KPIs at the product level are aggregated by payment, then by tactic, and finally by promotion. Similarly, if you define the dimension order as promotion dimension, tactic dimension, product dimension, and payment dimension, then all payments are aggregated by product, tactic, and finally promotion.
To define the dimension order and the dimensions that the report are grouped by, define the rowdims.
The grouping defines the attributes that each dimension are grouped by—for example, phase for promotion, type for tactic, category for product, and total for time dimension. These attributes are part of the attributes list of the report configuration. Always define them in the same order as the related dimension in the rowdims. If you don’t want a grouping criterion for a dimension, use an empty bracket as a placeholder.
Snippet to define an aggregation order.
"FlatList": { "rowdims": [ "promotiondimension", "tacticdimension", "paymentdimension", "productdimension", "timedimension" ], "coldims": [ "kpidimension" ], "grouping": { "rows": [ [ "phase" ], [], [], [ "category", "brand" ], [ "Total" ] ], "cols": [ [] ] },
