a!groupsByName( groupName )
Returns an array of groups with the given name, or an empty array if no group exists.
See also: group():
| Keyword | Type | Description |
|---|---|---|
|
|
Text |
The case-insensitive name of the group to retrieve. |
Group Array
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.
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 | Note |
|---|---|---|
| Portals | Partially compatible | Can be used with Appian Portals if it is connected using an integration and web API. |
| Offline Mobile | Compatible | |
| Sync-Time Custom Record Fields | Incompatible | |
| Real-Time Custom Record Fields | Incompatible | Custom record fields that evaluate in real time must be configured using one or more Custom Field functions. |
| Process Reports | Incompatible | Cannot be used to configure a process report. |
| Process Events | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
a!groupsByName() Function
