a!doesGroupExist() Function

Function

a!doesGroupExist( groupId )

Verifies whether a group with the specified group ID already exists in the environment.

Parameters

Returns

Boolean

Usage considerations

Returns true when the specified group exists on the system, regardless of security.

This function is particularly useful to add error handling around group IDs that have been stored and then retrieved from a database.

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

Examples

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

1
a!doesGroupExist(6)

Returns true if there is a group with an ID of 6/

1
a!doesGroupExist(null)

Returns false

1
2
3
4
if(a!doesGroupExist(ri!myGroup),
  group(ri!myGroup, "groupName"),
  "Unavailable"
)

1. Create a rule input named myGroup of type Group.
2. In the Expression box of the Test Inputs, enter an integer to represent a group ID.
3. Click TEST RULE.

Returns either a group name or "Unavailable".

Looping through multiple inputs

1
2
3
4
a!localVariables(
  local!groupIds: {2,3,30000},
  a!doesGroupExist(local!groupIds)
)

Returns {true, true, false}. This example may return different values depending on the groups in the environment.

Feature compatibility

Feedback