Retrieves a detailed list of an active Scenario's content to allow status presentation of an active Scenario.
@person::getActiveScenarioMsgDetails(String messageId)
(String) messageId: the active Scenario message ID (can be retrieved using the getActiveScenarioMsgIds method).
(List) A list containing the content of the specified active Scenario, formatted according to the following table:
List Index Value |
Content |
0 |
Scenario name |
1 |
Time the Scenario was created (as a long) |
2 |
recipientCount |
3 |
getFailedCount |
4 |
getSuccessOneWayCount |
5 |
getSuccessTwoWayCount |
6 |
getNotYetNotifiedCount |
7 |
Number of configured responses |
8 + (2 * i) |
Response count |
8 + (2 * i) + 1 |
Response name |
The following example retrieves and logs the total number of recipients to be notified given a certain scenario. (For a more exhaustive example, see the generic callin script's reviewLaunchedScenarios subroutine.)
# Retrieve scenario details
$scenarioDetails = @person::getActiveScenarioMsgDetails($activeScenarioIdx)
# Retrieve recipient count
$numRecipients = $scenarioDetails::get(2)
@script::log($numRecipients)