User-Related and Group-Related Functions
Function
Signature
Meaning
Availability
Group
ArtifactDto Group(Object idOrName)
Returns the user group artifact with the specified ID or name, for example, Group(1) is the user group with id == 1, Group("sysadmin") is the user group with name == "sysadmin"
Codebeamer 9.3.0 and later
groups
List groups(Object... values)
Returns a list of groups according to the specified values. for example,groups(assignedTo, supervisors) returns a list of all distinct groups, that are directly assigned to or supervisor of the current item. groups(this, true, assignedTo) returns a list of all distinct groups, that are either directly or indirectly (using role) assigned to the current item. groups(project, Role("Project Admin")) returns a list of all user groups, that have the role Project Admin in the current project. groups(4711, "sysadmin") returns a list containing the group with id == 4711 and also the group with name == "sysadmin"
Codebeamer 9.3.0 and later
members
List members(Object... values)
Returns a list of users, groups and roles according to the specified values. for example, members(Group("sysadmin")) gives all users, that are members of the sysadmin. group members(project, Role("Developer"), Role("Stakeholder"), Project("Demo"), Role("Tester") gives the distinct set of users and groups, that have the roles "Developer" or "Stakeholder" in the current project, or the role "Tester" in the "Demo" project. members(assignedTo, supervisors, choiceList[4]) gives the distinct set of all users, groups and roles, that are referenced in the fields assignedTo, supervisors and choiceList[4].
Codebeamer 9.3.0 and later
Role
RoleDto Role(Object idOrName)
Returns the role stereotype with the specified id or name, For example,. Role(1) is the role (stereotype) with id == 1, Role("Project Admin") is the role (stereotype) with name == "Project Admin"
Codebeamer 9.3.0 and later
roles
List roles(Object... values)
Returns a list of roles according to the specified values. For example,. roles(assignedTo, supervisors) returns a list of all distinct roles, that are directly assigned to or supervisor of the current item. roles(project) returns a list of all roles in the current project roles("ProjectAdmin", "Developer") returns a list with specified named roles
Codebeamer 9.3.0 and later
User
UserDto User(Object idOrName)
Returns the user with the specified id or name, For example,. User(1) is the user with id == 1, User("bond") is the user with name == "bond"
Codebeamer 9.3.0 and later
users
List users(Object... values)
Returns a list of users according to the specified values. For example,. users(assignedTo, supervisors) gives all users, that are directly assigned to or supervisors of this item. users(this, true, assignedTo) gives the distinct set of users, that are directly assigned to this item, or indirectly, because they are member in a group, that is assigned. users(project, true, Role("Developer")) gives the distinct set of users, that are either directly or indirectly member in the role "Developer" of the current project. users("klaus", "bond") returns a list containing the users with names "klaus" and "bond". users("bond", Group("sysadmin"), Project("Demo"), true, Role("Project Admin"), Role("Stakeholder")) returns a list containing the distinct set of user "bond", members of group "sysadmin" and direct and indirect members of role "ProjectAdmin" and "Stakeholder" of project "Demo".
Codebeamer 9.3.0 and later
Was this helpful?