SetElementGroupsSecurity function for IBM Planning Analytics (TM1)

Where can the SetElementGroupsSecurity function be used?

TurboIntegrator

Which TM1 Server version is the SetElementGroupsSecurity function available for?

Version 11 and 12

What is the syntax for SetElementGroupsSecurity?

SetElementGroupsSecurity(SecurityLevel, DimensionName, ElementName)

• SecurityLevel = Level of security to be granted to all non-admin groups to a given dimension element.​
• DimensionName = Name of the parent dimension of the element to have security access set​
• ElementName = Name of the element to have the security set to all non-admin groups. There are 6 types of security:​
  • Admin
  • Lock
  • None
  • Read
  • Reserve
  • Write 

Relevant Functions

• AddClient = Creates a new client on the server.
• AddGroup = Create a new group on the server
• AssignClientPassword = Change the password for a user.
• AssignClientToGroup = Assigns an existing client on a server to an existing user group.
• AssociateCAMIDToGroup = creates an association between a TM1 user group and a CAMID (Cognos Access Manager ID) that can be viewed in }ClientCAMAssociatedGroups control cube.
• CellSecurityCubeCreate = Creates cell security for a cube
• CellSecurityCubeDestroy = Deletes cube’s cell security
• DeleteClient = Deletes an existing client from the server.
• DeleteGroup = Deletes a group from the server
• ElementSecurityGet = Retrieves the security level assigned to a specified group for a dimension element
• ElementSecurityPut = Assigns a security level to a specified group for an element
• HierarchyElementSecurityGet = Returns the level of security privilege designated to a group for an element
• HierarchyElementSecurityPut = Sets security access for a group to an element
• RemoveCAMIDAssociation = Removes all associations of a specified CAMID with TM1 user groups
• RemoveCAMIDAssociationFromGroup = Removes an association between a TM1 user group and a CAMID
• RemoveClientFromGroup = Removes a client from a TM1 user group.
• SecurityOverlayCreateGlobalDefault = Creates Security Overlay cube for a specific cube with a dimension map based on the dimension order in the cube to lock and unlock specific intersections at the cell level
• SecurityOverlayDestroyGlobalDefault = Deletes the Security Overlay cube for a specific cube with a dimension map based on the dimension order in the cube
• SecurityOverlayGlobalLockCell = Locks or unlocks a specific intersection or cell in the cube based on the combination of dimension elements assigned in the Security Overlay cube of a specific cube
• SecurityOverlayGlobalLockNode = Locks or unlocks a specific intersection or cell in the cube based on the combination of dimension elements assigned in the Security Overlay cube of a specific cube
• SecurityRefresh = Applies any security changes to the TM1 Server. This function reads all the security control cubes and applies security changes to the TM1 Server
• SetDimensionGroupsSecurity = Sets the level of security to a dimension for non-admin groups
• SetElementGroupsSecurity = Sets the level of security to an element for non-admin groups
• SetHierarchyElementGroupsSecurity = Sets the level of security to an element on a hierarchy to non-admin groups
• SetHierarchyGroupsSecurity = Sets level of security to an element on a hierarchy to non-admin groups