|
<< Click to Display Table of Contents >> Navigation: Support > Reconfigurable Rulebook > Definition Objects > CommandAutomation |
Description
CommandAutomations are automatize actions to happen when the associated SegmentGroupCommand is in focus. Commonly used to show or hide remarks on a participant.
CommandAutomation is an abstract object with two possible concrete implementations. The concrete class identifier is the Subject property.
All CommandAutomation concrete objects have the following common properties.
Property Name |
Value |
Description |
Subject |
String enum CommandAutomationSubject |
The concrete class identifier, identifies the type of CommandAutomation Required. |
Id |
Integer |
A unique identifier for this CommandAutomation. Must be unique within the COURSE OF FIRE definition. Recommend using sequential values. Required. |
Effectively a no-op command.
Property Name |
Value |
Description |
Subject |
String enum CommandAutomationSubject |
The concrete class identifier, identifies the type of CommandAutomation Required. Must be NONE |
{
"Subject": "NONE"
}
A CommandAutomationRemark is a (SegmentGroupCommand) automation directive., it adds or hides a Remark (e.g. DSQ) to one or more Participants in a Result List, based on their rankings.
Property Name |
Value |
Description |
Subject |
String enum CommandAutomationSubject |
The concrete class identifier, identifies the type of CommandAutomation Required. Must be REMARK |
Action |
String enum RemarkVisibility |
The action to take. •SHOW: Adds the remark to the Participant and makes the remark visible. •HIDE: Hides the remark, if it exists on the Participant, making it not visible. •DELETE: Deletes the remark from the Participant. Not required, defaults to HIDE. |
ParticipantRanks |
String formatted as a ValueSeries |
The ranks of the participants to apply this Command Automation to. For example, "1..8" means to apply this Command Automation to participants in first through eight place. An empty string value ("") means to not apply this Command Automation to any participant. Not required, defaults to an empty string. |
Condition |
String enum ParticipantRemark |
The remark to show, hide, or delete. Not required, defaults to BUBBLE. |
This example would apply and show the ELLIPSES remark to participants ranked 1 through 8.
{
"Condition": "ELLIPSES",
"ParticipantRanks": "1..8",
"Action": "SHOW",
"Id": 1,
"Subject": "REMARK"
}