system.groups.removeGroups
This function is used in Python Scripting.
Description​
Removes the specified groups from the project. The group paths are Folder/Path/To/GroupName, separated by forward slashes.
note
This function is scoped for Perspective Sessions, but since all scripts in Perspective run on the Gateway, the file must be located on the Gateway's file system.
Client Permission Restrictions​
This scripting function has no Client Permission restrictions.
Syntax​
system.groups.removeGroups(projectName, paths)
Parameters​
| Type | Parameter | Description |
|---|---|---|
| String | projectName | The project to remove from. If the project does not exist, throws an IllegalArgumentException. |
| List[String] | paths | A list of paths to remove. Group paths are the full path to the resource, separated by forward slashes, e.g., "Folder/Path/To/GroupName". |
Returns​
Nothing
Scope​
Gateway, Perspective Session
Code Examples​
Example #1 - Removing Transaction Group from Project
projName = "MyProject"
groups = ["Historical/Group1","DataSync/Group2"]
system.groups.removeGroups(projName, groups)
Keywords​
system groups removeGroups, groups.removeGroups