cube.wipeBatchActive ^v2.4.910 ​

Enable or disable cube wipe batching. If the cube.wipe function is to be called multiple times, enabling the wipe batch will prevent unneccessary formula invalidations from occuring until the end of the batch.

Remember to turn batching off again once you have completed the cube, wipe calls, especially prior to running any cube.get calls.

cube.wipeBatchActive(cubeName, bSetBatchActive);

cube.wipeBatchActive(cubeName, bSetBatchActive);

Parameters ​

• cubeName - name of a cube.
• bSetBatchActive - Whether the batch is active. Boolean (true or false).

Example ​

cube.wipeBatchActive("Profit and Loss", true); // Enable Batch Wipes 
// Do some frequent cube.wipe calls ... 
cube.wipeBatchActive("Profit and Loss", false); // Disable Batch Wipes

cube.wipeBatchActive("Profit and Loss", true); // Enable Batch Wipes 
// Do some frequent cube.wipe calls ... 
cube.wipeBatchActive("Profit and Loss", false); // Disable Batch Wipes