RTRReportResult.Flatlist | Consumer Goods Cloud Developer Guide

Namespace

The RTRReportResult.Flatlist class extends RTRReportResult.ReportComponent.

The supported modifiers are global and virtual.

1cgcloud

Supported Methods

Table 1. RTRReportResult.Flatlist Supported Methods
Method signature	Description	Version
`FlatlistRowIterable getRows()`	Returns an `FlatlistRowIterable` instance with all the Flatlist rows.	60.0
`FlatlistRowIterable getRows(String rowTypeFilter)`	Returns an `FlatlistRowIterable` instance with all the rows matching the specified row type filter. rowTypeFilter: String. The available values for the row type filter can be extracted with the `getRowTypes` method. If a non-existent row type filter is specified, the method throws an exception.	60.0
`Set<String> getColumns()`	Returns a set of all the available column names in the flat list. The dimension attribute column values are returned in this format: `<Dimension Name.Report Field>`. For example, `productdimension.id`, `promotiondimension.phase`. The KPI column values are returned with the KPI names. For example, `ProPlanIncrVolume`. Use these column names to request specific values for each row.	60.0
`Set<String> getRowTypes()`	Returns all the available row type filters present in the flat list. The wow type filters can be used to filter the dataset.	60.0

Example Implementation

After the report is executed, extract the Flatlist data from the RTRReportResult object.

1// Extract the Flatlist from the result
2// - The component name must match its 'uimapping' name
3// - The result must be casted to the correct type.
4cgcloud.RTRReportResult.Flatlist flatlist = (cgcloud.RTRReportResult.Flatlist) reportResult.getComponent('FlatList');
5    
6// Retrieve the rows Iterable object
7// All rows can be retrieved with the parameter-less "getRows"
8cgcloud.RTRReportResult.FlatlistRowIterable iterator = flatlist.getRows('Promo-Product');
9
10// Iterate over all the rows
11while (iterator.hasNext()) {
12    cgcloud.RTRReportResult.FlatlistRow row = iterator.next();
13    
14    // Extract column data. We assume the specified columns are in the report
15    
16    // Dimension information can be extracted with <dimension name>.<field>
17    String promotionId = String.valueOf(row.getColumnValue('promotiondimension.id'));
18    // KPI Value information can be extracted by querying the KPI Name
19    Decimal kpiValue = (Decimal) row.getColumnValue('ProPlanIncrVolume');
20    
21    system.debug('Values: ' + promotionId + ' ' + kpiValue);
22}