CellPutProportionalSpread

CellPutProportionalSpread distributes a specified value to the leaves of a consolidation proportional to existing cell values. CellPutProportionalSpread replaces existing cell values; it cannot be used to add to or subtract from existing cell values.

The function is analogous to the Proportional Spread data spreading method. If you must add to or subtract from existing cell values, use the Proportional Spread method, which can be executed through the user interface or through data spreading syntax.

Note: When using CellPutProportionalSpread to distribute a value to the leaves of a consolidation, only those leaves already containing non-zero values are changed. This is because zero values cannot be incremented or decremented proportionally; any proportion of zero is still zero.

This function is valid in TM1® TurboIntegrator processes only.

Syntax

CellPutProportionalSpread( value, cube, e1, e2, e3...,en );

Argument	Description
value	The value you want to distribute.
cube	The name of the cube into which you want to distribute the value.
e1...en	The names of the elements that identify the consolidation whose leaves will accept the distributed value. Arguments e1 through en are sequence-sensitive. e1 must be an element from the first dimension of the cube, e2 must be an element from the second dimension, and so on. These arguments can also be the names of aliases for dimension elements or TurboIntegrator variables.

Argument

Description

value

The value you want to distribute.

cube

The name of the cube into which you want to distribute the value.

e1...en

The names of the elements that identify the consolidation whose leaves will accept the distributed value.

Arguments e1 through en are sequence-sensitive. e1 must be an element from the first dimension of the cube, e2 must be an element from the second dimension, and so on. These arguments can also be the names of aliases for dimension elements or TurboIntegrator variables.

Example

CellPutProportionalSpread(7000,'SalesCube', 'Actual','North America', 
'S Series 1.8L Sedan', 'Sales', 'Jan')

This example distributes the value 7000 to the children of the consolidation in the SalesCube identified by the elements Actual, North America, S Series 1.8L Sedan, Sales, and Jan.