TOTAL macro

The TOTAL macro is available in HCL® Campaign and HCL Interact.

Syntax

TOTAL(data [, keyword])

Parameters

data

The numerical values to compute the sum of. This can be a constant value, a column, a cell range, or an expression evaluating to any of the above. For the format definition of data, see the "Macro Function Parameters" section in the chapter in this guide for your HCL product.

keyword

This optional keyword determines how the computation is performed over the input data range. Select one of the following:

ALL - Performs the computation on all cells in data (default)

COL - Performs the computation separately for each column of data

ROW - Performs the computation separately for each row of data

For more details on using keywords in HCL Campaign, see Format Specifications.

Note: Many macro functions take the keyword parameters {ALL | COL | ROW}. These keywords do not apply in HCL Campaign because the input data is always a single column or field. The macro will always behave as if the COL keyword were specified. Therefore, you do not need to specify these keywords when using HCL Campaign .

Description

TOTAL calculates the sum of all the cells in the specified data range.

Note: TOTAL is the same as the SUM macro function.

Examples


`TEMP = TOTAL(3)` Creates a new column named `TEMP` containing the value three.
`TEMP = TOTAL((COLUMN(3, 5, 1))` Creates a new column named `TEMP` containing the value nine.
`TEMP = TOTAL(V1)` Creates a new column named `TEMP` containing a single value which is the sum of the contents of column `V1`.
`TEMP = TOTAL(V1:V3)` Creates a new column named `TEMP` containing a single value which is the sum of the contents of columns `V1`, `V2`, and `V3`.
`TEMP = TOTAL(V1[1:5]:V4)` Creates a new column named `TEMP` containing a single value which is the sum of the cells in rows 10-20 of columns `V1` through `V4`.
`TEMP = TOTAL(V1:V3, COL)` Creates three new columns named `TEMP`, `VX`, and `VY`. The single value in the `TEMP` column is the sum of the contents of column `V1`, the single value in the `VX` column is the sum of the contents of column `V2`, and the single value in the `VY` column is the sum of the contents of column `V3`.
`TEMP = TOTAL(V1[1:5]:V3, COL)` Creates three new columns named `TEMP`, `VX`, and `VY`, each containing a single value. The value in column `TEMP` is the sum of the cells in rows 1-5 of column `V1`, the value in column `VX` is the sum of the cells in rows 1-5 of column `V2,` and the value in column `VY` is the sum of the cells in rows 1-5 of column `V3`.
`TEMP = TOTAL(V1:V3, ROW)` Creates a new columns named `TEMP` where each cell entry is the sum of the corresponding row across columns `V1`, `V2`, and `V3`.
`TEMP = TOTAL(V1[1:5]:V3, ROW)` Creates a new column named `TEMP`, where the cells in rows 1-5 contain the sum of the corresponding row across columns `V1` through `V3`. The other cells in `TEMP` are empty.

Related functions


Function	Description
`AVG` or `MEAN`	Computes the arithmetic mean or average of a range of cells