BatchUpdateFinishWait

BatchUpdateFinishWait is identical to BatchUpdateFinish except the process waits until the lock becomes available and then commits changes. If a process calls BatchUpdateFinishWait but is unable to secure a cube write lock to commit changes, the process waits until the lock becomes available and then commits changes.

This function is valid in processes only.

Data changes applied in the process are not rolled back and the process is not re-executed.

Note: While waiting for the cube write lock, the process releases any read locks it acquired for other objects during process execution. Because these read locks are released before the process can commit changes to the cube, the objects for which the read locks are released can be modified before the cube is updated. This can lead to data inconsistency when using BatchUpdateFinishWait.

We recommend that BatchUpdateFinishWait be used only in controlled situations where you know that other processes are not modifying data or metadata related to the process that calls BatchUpdateFinishWait.

This function is not supported in processes on TM1 Database 12.

Syntax

BatchUpdateFinishWait(SaveChanges);

Argument	Description
SaveChanges	A flag that instructs the server to either save or discard changes committed while in batch update mode. Specify 0 to save changes, 1 to discard changes.

Example

BatchUpdateFinishWait(0);

This example instructs the server to save changes to TM1® data and exit batch update mode.