A $Group reference represents a group of users. The Broadcast manager interface is used to create both users and groups. Groups may be licensed to expire after a certain number of runs or after a certain date.
About Facilitator Groups and User Accounts
$Group properties represent attributes of the group.
A list of run objects representing completed runs by all users in this group, sorted in descending order of Score. For runs sorted by score that are not completed, use Scores.
Example FML statement:
#foreach($r in $Group.CompletedScores)
Run $foreachCount by $r.EndUser.FirstName $r.EndUser.LastName with score
$r.Values.get("Score")|
#end
Example result:
Run 1 by Jeff Smith with score $110,255
Run 2 by Alexia Sands with score $55,211
Run 3 by Jon Banks with score $21,567
The number of days before the group expires.
Example FML statement:
Your group expires in $Group.DaysLeft days.
Example result:
Your group expires in 30 days.
A reference to the run set by the facilitator as the default scenario.
Example FML statement:
$Group.DefaultRun.Name
Example result:
Base Case Scenario
A list of $User references for all users in the group.
Example FML statement:
The group has $Group.EndUsers.size() users.
Example result:
The group has 75 users.
The date that the simulation group expires, or null if no expiration date is set.
Example FML statement:
The group will expire on $Formatter.date($Group.ExpirationDate).
Example result:
The group will expire on 03-11-05.
Expired
True if the group has expired. This might be due to exceeding the licensed number of runs or going past the expiration date.
Example FML statement:
|
#if ($Group.Expired) |
Example result:
All accounts in your group expired on 03-11-05. Users may view old run information but may not start a new one.
True if the group is licensed by runs, false otherwise.
Example FML statement:
#if($Group.IsLicensedByRuns) You have used $Group.RunsUsed. #end
Example result:
You have used 30 runs.
A list of $Run references for all runs in the group with the property $Run.Listed set to true.
Example FML statement:
The group has $Group.ListedRuns.size() runs to date.
Example result:
The group has 3000 runs to date.
The name of the current group
Example FML statement:
$Group.Name
Example result:
Strategy 101
A list of $Run references for all runs in the group.
Example FML statement:
The group has $Group.Runs.size() runs to date.
Example result:
The group has 3000 runs to date.
The total number of runs licensed to the group, if applicable.
Example FML statement:
The group has used $Group.RunsUsed of $Group.RunsLicensed total runs licensed.
Example result:
The group has used 30 of 500 total runs licensed.
A counter of the total number of runs used by users in this group. Incremented every time each user steps for the first time in a run. If this group is licensed by runs and this number is greater than RunsLicensed, users in this group will not be permitted to start new runs.
Example FML statement:
The group has used $Group.RunsUsed of $Group.RunsLicensed total runs licensed.
Example result:
The group has used 30 of 500 total runs licensed.
A list of run objects representing runs by all users in this group, sorted in descending order of Score. For completed runs only, use CompletedScores.
Example FML statement:
#foreach($r in $Group.Scores)
Run $foreachCount by $r.EndUser.FirstName $r.EndUser.LastName with score
$r.Values.get("Score")|
#end
Example result:
Run 1 by Jeff Smith with score $110,255
Run 2 by Alexia Sands with score $55,211
Run 3 by Jon Banks with score $21,567