SecurityOverlayGlobalLockNode

SecurityOverlayGlobalLockNode is used to restrict the access rights of a node to read-only by locking it. It uses the global overlay so all users are affected. The overlay cube must be created prior to using this command. The elements provided in the address must be only for the dimensions used in the overlay.

The process must be configured to modify security data to successfully execute SecurityOverlayGlobalLockNode.

The function returns True if successful and a major error if unsuccessful.

This function is valid in TM1® TurboIntegrator processes only.

Syntax

SecurityOverlayGlobalLockNode(bLock, Cube, Address, [AddressDelimiter])

Argument	Description
bLock	If 1 lock it. 0 unlock it
Cube	Name of the cube.
Address	Tokenized string sequence of overlay element names that define the tuple. The order must match the original dimension order of the cube.
AddressDelimiter	Optional character string used to separate element names in the Address parameter. Default value ‘\|’.

Examples

SecurityOverlayGlobalLockNode(1,’Sales’,’MA’);           
SecurityOverlayGlobalLockNode(0,’Products’,’MA | 2011’);           
SecurityOverlayGlobalLockNode(0,’Products’, ‘MA : 2011’, ‘:’);

In the first example there is only one dimension used for the overlay. The other two examples use two dimensions.