CellPutProportionalSpread function for IBM Planning Analytics (TM1)

    Where can the CellPutProportionalSpread function be used?

      Which TM1 Server version is the CellPutProportionalSpread function available for?

        What is the syntax for CellPutProportionalSpread ?

        • Value = numeric value to be sent to the cube​
        • Cube = Cube Name
        • ​e1,e2….en = Dimension element names determining the data point within the cube to be retrieved. The sequence of the element arguments should match the order of the dimensions in the cube.​

          Note: This function will replace an existing value in the cube cell. It will not add/subtract from the cube value. It will also update only those children within the consolidations with non-zero values unless the entire children under the specified consolidation are all zero.

        Relevant Functions

        • AddCubeDependency = Establish cube dependency manually
        • CellGetN = Retrieves a numeric value from a cube cell.
        • CellGetS = Retrieves a string value from a cube cell.
        • CellIncrementN = Increases a numeric value by a value.
        • CellIsUpdateable = Checks whether a cube cell can be written to. If the cell can be written to, the function returns 1, otherwise a 0 is returned.
        • CellPutProportionalSpread = Proportionally spreads a value to the children of a consolidation.
        • CellPutN = Writes a numeric value to a cube cell.
        • CellPutS = Writes a string value to a cube cell.
        • CubeClearData = clears the entire data for a Cube
        • CubeCreate = Creates a cube using the list of specified dimensions
        • CubeDestroy = Deletes a Cube from the TM1 Server
        • CubeDimensionCountGet = Returns the number of dimensions in a cube
        • CubeExists = Used check if a cube exists on the TM1 Server
        • CubeGetLogChanges = Determines whether the logging property of a cube is turned on or not
        • CubeSaveData = Serialises a cube to disk
        • CubeSetConnParams = Sets the connection parameters and encrypt the password for a virtual cube stored in }CubeProperties control cube
        • CubeSetLogChanges = Sets the logging property for a cube
        • CubeTimeLastUpdated = Returns a serial value which refers to the last time the cube was updated
        • CubeUnload = Unloads a cube and its view from the memory