CubeDataReservationAcquire function for IBM Planning Analytics (TM1)

CubeDataReservationAcquire acquires data reservation for a cube, user and intersection.

Learn how to use the CubeDataReservationAcquire to acquire data reservation for the user, TEST, in the General Ledger cube.

Where can the CubeDataReservationAcquire function be used?

TurboIntegrator

Which TM1 Server version is the CubeDataReservationAcquire function available for?

Version 11

What is the syntax for CubeDataReservationAcquire?

CubeDataReservationAcquire(CubeName, User, BooleanForce, Address, AddressDelimiter)

CubeName = The cube where the data reservation will be acquired.
User = client on the TM1 Server
BooleanForce = “1” will force the reservation, “0” will only acquire data reservation if there is no conflict.
Address = This needs the elements of each dimension in the cube. It also needs to be in the order that the dimensions are ordered in the cube.
AddressDelimiter = This can be any character that will split the elements if the character is not in the element name. “|” is the default.

Relevant Functions

CubeDataReservationAcquire = Acquires data reservation for a cube, user and intersection
CubeDataReservationGet = Finds the data reservations for a cube
CubeDataReservationGetConflicts = Gets data reservation set for a cube that conflicts with a user, address and tuple
CubeDataReservationRelease = Releases the data reservation for a cube, user and address
CubeDataReservationReleaseAll = Releases all the data reservations specified
CubeDRAcquire = Acquires data reservation for a user in a cube according to an element list. This function applies to dimensions with one or more hierarchies, while CubeDataReservationAcquire is used for dimensions with a single hierarchy
CubeDRGet = Finds existing reservations on a specific cube for all or one user. This function applies to dimensions with one or more hierarchies, while CubeDataReservationGet is used for dimensions with a single hierarchy.
CubeDRGetConflicts = Gets the cube’s current data reservation conflicts. This function applies to dimensions with one or more hierarchies, while CubeDataReservationGetConflicts is used for dimensions with a single hierarchy.
CubeDRRelease = Releases the data reservation specified in the element list. This function applies to dimensions with one or more hierarchies, while CubeDataReservationRelease is used for dimensions with a single hierarchy.
CubeDRReleaseAll = Releases all the data reservations specified in the element list. This function applies to dimensions with one or more hierarchies, while CubeDataReservationReleaseAll is used for dimensions with a single hierarchy.