The function CUMULATE adds values and returns a number. By default, the values are added across a time period. You can also choose to add values across a list.
CUMULATE (Values to add [, Boolean] [, List])
Arguments
| Argument | Data type | Description |
| Values to add (required) | Number | The numeric line item to cumulatively add the values of. |
| Boolean | Boolean | A Boolean argument that you can use to reset the cumulation of values. |
| List | N/A | A list of items to add the values of. |
The CUMULATE function returns a number.
Constraints
Order of List argument
In Classic, if you provide the List argument, the order in which values are added follows the original order of the list in General Lists, even if the list is reordered.
Time range requirements
The time range used for the Values to add argument must match the time range for the result line item.
Calculation engine functionality differences
In Polaris:
- You cannot use CUMULATE in formulas of line items with a formula summary method. In the Classic Engine, you can.
- The List argument must identically match a dimension of the line item to which the formula is applied. In the Classic engine, you can also use a subset of a line item dimension as List.
- The order of a List argument follows the correct hierarchical ordering instead of the order of the General Lists.
Examples
In the example below, CUMULATE is used with a number formatted Sales line item as single source parameter. It adds Sales values over time in months.
| Jan 12 | Feb 12 | Mar 12 | Apr12 | |
| Sales | 88,753 | 87,450 | 88,945 | 86,523 |
Cumulative sales
| 88,753 | 176,203 | 265,148 | 351,671 |
The second example below uses a Boolean parameter. It resets the cumulative calculation for Sales in March.
| Jan 12 | Feb 12 | Mar 12 | Apr 12 | |
| Sales | 88,753 | 87,450 | 88,945 | 86,523 |
Cumulative sales
| 88,753 | 176,203 | 88,945 | 175,468 |
| Reset Sales cumulate |
The third example below uses the list parameter Sales Reps, without a Boolean parameter. This is set to FALSE.
| Edgar Harrington | Joe Tipple | Harry Boyde | Nicky Spinks | |
| Sales | 88,753 | 87,450 | 88,945 | 86,523 |
Cumulative sales
| 88,753 | 176,203 | 265,148 | 351,671 |
