Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Scripting_function


Panel
titleDescription

Removes the specified groups from the project. The group paths are "Folder/Path/To/GroupName", separated by forward slashes. 

Note_friendly

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 permissions restrictions


Panel
titleSyntax

system.groups.removeGroups(projectName, paths)

  • Parameters

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

Panel
titleCode Examples
Code Block
languagepy
titleCode Snippet - Removing Transaction Group from Project
projName = "MyProject"
groups = ["Historical/Group1","DataSync/Group2"]

system.groups.removeGroups(projName, groups)
Panel
titleKeywords

system groups removeGroups, groups.removeGroups