a!groupsByName() Function

Function

a!groupsByName( groupName )

Returns an array of groups with the given name, or an empty array if no group exists.

See also: group():

Parameters

Returns

Group Array

Usage considerations

If there are multiple groups that have the same name, a!groupsByName() will return all of the groups, sorted by id, ascending.

a!groupsByName() always returns an array.

If the user running the expression does not have permission to see a group, that group will not be returned in the result. If the user does not have permission to see any of the groups, an empty array will be returned. See also: Group Visibility

System groups cannot be retrieved using a!groupsByName().

a!groupsByName() cannot be used to define a column of process report data or in a process event.

Using this function in a process model with autoscale enabled may result in degraded site or application performance. It should be used with caution and tested thoroughly before deploying it for real-world use. When the application is in production, use the Autoscaled Process Activity tab to monitor how the process performs at scale.

Examples

You can copy and paste these examples into the Expression Rule Designer to see how this works.

Given there is one group named Case Viewers - 123 with id 7:

1
a!groupsByName("Case Viewers - 123")

Returns {[Group:7]}.

Given there are no groups named Group Does Not Exist:

1
a!groupsByName("Group Does Not Exist")

Returns {}.

Feature compatibility

Feedback