Graphics Builder > Configure Graphics Pages > Edit the Properties for a Page > Page properties - Keyboard Commands

Page properties - Keyboard Commands

The Keyboard Commands property lets you define keyboard commands for the page. A keyboard command is a particular key sequence which executes a command when it is typed in by the operator at runtime.

You can also define a message which will log every time the key sequence is entered.

If an operator does not satisfy the Access requirements specified under Security (see below), they will not be able to enter keyboard commands for this page at runtime.

Keyboard commands have the following properties:

Field

Description

Key sequence

Enter the key sequences that the operator can enter to execute a command (32 characters or less).

You can enter as many key sequences as you like. To add a key sequence, click Add, and type in the sequence or select one from the menu. To edit an existing sequence, click the relevant line, and click Edit. You can also remove key sequences by clicking Delete. See Define Key Sequences for Commands.

Key sequence command

The commands (set of instructions) to be executed immediately when the selected key sequence is entered. The key sequence command can have a maximum length of 254 characters.

To insert a tag or a function, click the Wizard button to the right of this field. This button displays two options: Insert Tag, and Insert Function.

[Security] Same area as page

Select this check box to assign the keyboard command to the same area as the page (see Page Properties - General). Only users with access to this area (and any necessary privileges) can issue this command or log the message. If you want to assign this keyboard command to another area, leave this check box clear and enter another area below.

[Security] Command area

Enter the area to which this keyboard command belongs up to a maximum of 16 characters. Only users with access to this area (and any necessary privileges) can issue this command or log the message. For example, if you enter Area 1 here, operators need to have access to Area 1 to issue this command.

Click an area from the menu or type in an area number.

[Security] No privilege restrictions

Tick this box to disable privilege restrictions; otherwise, leave it blank, and enter another privilege below.

The result of not assigning a privilege restriction differ according to whether you have used areas in your security setup:

  • No Areas: Every operator has full control of the page.
  • Areas: An operator will only need view access to the area assigned to this page to have full control over the page.

[Security] Privilege level

Enter the privilege level that a user needs to possess to issue this command or log the message. For example, if you enter Privilege Level 1 here, operators need to possess Privilege Level 1 to issue this command. You can also combine this restriction with area restrictions (see above). For example, if you assign the keyboard command to Area 5, with Privilege Level 2, the user needs to be set up with Privilege 2 for Area 5.

Choose a privilege from the menu or type in an area number.

[Logging] Log Message

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 maximum). The message can be plain text, Super Genie syntax, or a combination of the two.

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.

The log device to which the message is sent is specified through the General page properties.

Click Apply, and then click OK. Click Clear Property to clear property details, and disable the property. To define further properties for the page, click the relevant tabs.

See Also

Published June 2018