CubeClearData Syntax and Use

CubeClearData clears all of the data in a cube.

It is a TurboIntegrator function, valid only in TurboIntegrator processes.

This function is much faster than doing an operation such as creating a view to cover the entire cube, and then doing a ViewZeroOut() to zero out the entire cube, however it does not give you the flexibility to delete the data from a view or slice of a cube.

When you use CubeClearData to clear data from a cube, any cells in the cube that are fed with feeders are also cleared. You must resave the rule that establishes the feeders or use the CubeProcessFeeders function to restore the fed cells.

Note: This call just deletes the cube data, it does not delete and re-create the cube itself. This has implications when sandboxes are used. If a cube is deleted and then re-created any sandboxes a user may have will be discarded, since the cube against which those sandboxes were created was deleted (even though a cube may have been re-created with the same name). If however the CubeClearData() call is used, the sandbox data will still be considered valid, since the cube against which the sandbox was created continues to exist.

Syntax of CubeClearData

CubeClearData( name-of-cube-as-string );

Argument

The name of the cube to clear, as a string.

Example

CubeClearData( 'Labour' );
If you like this post, please spread the love…

About John

Managing Director of Infocube. We are a management accounting consultancy that specialises in Business Analytics.
This entry was posted in TI Processes and tagged CubeClearData. Bookmark the permalink.