Define System Keyboard Commands
- Last UpdatedJul 18, 2023
- 2 minute read
System keyboard commands specify a key sequence that an operator can enter on a keyboard to execute a particular instruction (or series of instructions).
For information on keyboard commands that only operate for a particular page or selected object, see Keyboard Commands.
To add a system keyboard command:
-
In the Visualization activity, select Keyboard Commands.
-
Add a row to the Grid Editor.
-
Type the required information in each column, or in the Property Grid (see below for a description of the properties).
-
Click Save.
System Keyboard Command Properties
General Properties
|
Property |
Description |
|---|---|
|
Key Sequence |
The key sequence for the command (32 characters). |
|
Command |
The commands (set of instructions) to execute when an operator enters the key sequence (253 characters). |
|
Privilege |
The privilege necessary by an operator to issue the command (16 characters). |
|
Area |
The area to which the command belongs (16 characters). Only operators who belong to this area will be able to issue this command. For example, if you enter Area 1 here, operators need to have access to Area 1 (plus any necessary privileges) to issue this command. |
|
Message Log |
A text message sent to the MsgLog field of the log device when the selected action is performed by the operator at runtime (32 characters). The log device to which the message is sent is specified in the Log Device field below. The message needs to be plain text. If you want to include field data as part of a logged message, you need to insert the field name as part of the device format when you configure the device. For instance, in the Format field of the Devices form, you could enter {MsgLog,20} {FullName,15}. This would accommodate the logging of messages such as "P2 started by John Smith". |
|
Log Device |
The device to which the Message Log is sent when the command is issued (16 characters). |
|
Comment |
Any useful comment (48 characters). |
Project Properties
|
Property |
Description |
|---|---|
|
Project |
The project in which the specified keyboard command is included. |