Skip to content

Commit 753f58d

Browse files
authored
Update documentation for Critical Commanding and Command Authority (#2240)
* Update documentation on Critical Commanding and Command Authority * Reuse existing images * PR Feedback
1 parent b137fc0 commit 753f58d

File tree

3 files changed

+32
-8
lines changed

3 files changed

+32
-8
lines changed

docs.openc3.com/docs/configuration/_command.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,21 @@ When defining command parameters you can choose from the following data types: I
2222

2323
<div style={{"clear": 'both'}}></div>
2424

25+
## Command Authority (Enterprise)
26+
27+
Command Authority can be enabled in the Admin Console under the Scopes tab and is enabled scope wide. Once Command Authority is enabled, individual users can take and release Command Authority which enables exclusive command and script access to that target for that user. Without taking Command Authority, users can not send a command or start a script under that target. Note, commands or scripts scheduled with Calendar or Autonomic are not affected by Command Authority.
28+
29+
![Command Authority](/img/cmd_tlm_server/cmd_authority.png)
30+
![Command Authority in CmdTlm Server](/img/cmd_tlm_server/targets.png)
31+
32+
## Critical Commanding (Enterprise)
33+
34+
Critical Commanding can be enabled in the Admin Console under the Scopes tab and is enabled scope wide. Critical commanding requires a different user to approve critical commands. When Critical Commanding mode is set to NORMAL, HAZARDOUS and RESTRICTED commands need approval. When Critical Commanding mode is set to ALL, all manual commands will require approval. OFF is the default, and disables Critical Commanding.
35+
36+
Here is an example of sending a HAZARDOUS command in Command Sender when Critical Command Mode is set to NORMAL.
37+
38+
![Critical Command](/img/cmd_tlm_server/critical_cmd_sender.png)
39+
2540
# Command Keywords
2641

2742
COSMOS_META

docs.openc3.com/docs/configuration/command.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,21 @@ When defining command parameters you can choose from the following data types: I
2222

2323
<div style={{"clear": 'both'}}></div>
2424

25+
## Command Authority (Enterprise)
26+
27+
Command Authority can be enabled in the Admin Console under the Scopes tab and is enabled scope wide. Once Command Authority is enabled, individual users can take and release Command Authority which enables exclusive command and script access to that target for that user. Without taking Command Authority, users can not send a command or start a script under that target. Note, commands or scripts scheduled with Calendar or Autonomic are not affected by Command Authority.
28+
29+
![Command Authority](/img/cmd_tlm_server/cmd_authority.png)
30+
![Command Authority in CmdTlm Server](/img/cmd_tlm_server/targets.png)
31+
32+
## Critical Commanding (Enterprise)
33+
34+
Critical Commanding can be enabled in the Admin Console under the Scopes tab and is enabled scope wide. Critical commanding requires a different user to approve critical commands. When Critical Commanding mode is set to NORMAL, HAZARDOUS and RESTRICTED commands need approval. When Critical Commanding mode is set to ALL, all manual commands will require approval. OFF is the default, and disables Critical Commanding.
35+
36+
Here is an example of sending a HAZARDOUS command in Command Sender when Critical Command Mode is set to NORMAL.
37+
38+
![Critical Command](/img/cmd_tlm_server/critical_cmd_sender.png)
39+
2540
# Command Keywords
2641

2742

docs.openc3.com/docs/tools/cmd-tlm-server.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,15 +34,9 @@ The Targets tab displays all the targets and their mapped interfaces along with
3434

3535
![Targets](/img/cmd_tlm_server/targets.png)
3636

37-
Command Authority is enabled in the Admin Console and is enabled scope wide. Once Command Authority is enabled, individual users can give and take Command Authority which enables exclusive command and script access to that target. Without Command Authority, users can not send a command or start a script under that target. Note, commands or scripts scheduled with Calendar or Autonomic are not affected by Command Authority.
37+
[Command Authority (Enterprise)](../configuration/command.md#command-authority-enterprise) allows individual users to take and release Command Authority which enables exclusive command and script access to that target for that user. Without taking Command Authority, users can not send a command or start a script under that target. Note, commands or scripts scheduled with Calendar or Autonomic are not affected by Command Authority.
3838

39-
![Command Authority](/img/cmd_tlm_server/cmd_authority.png)
40-
41-
The other option shown in the Scope List is the Critical Command Mode. Critical commanding requires a different user to approve each command. It can either be enabled on just HAZARDOUS and RESTRICTED commands or on all manual commanding.
42-
43-
Here is an example of sending a HAZARDOUS command in Command Sender when Critical Command Mode is set to NORMAL.
44-
45-
![Critical Command](/img/cmd_tlm_server/critical_cmd_sender.png)
39+
Command Authority, along with [Critical Commanding (Enterprise)](../configuration/command.md#critical-commanding-enterprise), can be enabled in the Admin Console under the Scopes tab.
4640

4741
## Command Packets Tab
4842

0 commit comments

Comments
 (0)