Object Properties - Input (Keyboard Commands)

The keyboard commands property lets you assign keyboard commands to the object/group. A keyboard command is a particular key sequence which executes a command when it is typed in by the operator at runtime. To execute an object/group keyboard command, the operator positions the cursor over the object/group and enters the key sequence using the keyboard.

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

For example, the operator could change the water level in a tank by placing the mouse over the symbol representing the tank, and typing in the new level. At the same time, a message could be logged, listing the time and date, and the name of the operator.

Operators who do not satisfy the access requirements specified under Security below cannot enter keyboard commands for this object/group at runtime.

For a detailed explanation of keyboard command input see the topic Getting Runtime Operator Input in the Cicode Programming Reference.

Objects and groups have the following keyboard commands input properties:

Key sequence

Enter the key sequences that the operator can enter to execute a command. For example, you might define the key sequence ### Enter. During runtime, this key sequence would allow you to type in any three digit number, and click Enter to change variable tag values from mimic pages and so on

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.

Key sequence command

The commands (set of instructions) to be executed immediately when the selected key sequence is entered. The commands can be a maximum of 253 characters long.

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 object/group

Select this box to assign the keyboard command to the same areaA large application can be visualized as a series of discrete sections or areas. Areas can be defined geographically (where parts of the plant are separated by vast distances) or logically (as discrete processes or individual tasks). as the object/group. Only users with access to this area (and any necessary privileges) will be able to issue this command or log the message. If you want to assign this keyboard command to another area, do not select this box; instead, enter another area below.

[Security] Command area

Enter the area to which this keyboard command belongs. Only users with access to this area (and any necessary privileges) will be able to issue this command or log the message. For example, if you enter Area 1 here, operators need to have access to Area 1 (plus any necessary privileges) to issue this command.

Click the menu to the right of this field to select an area, or type in an area number directly.

You can leave this field blank by selecting the Same privilege as object/group box.

[Security] Same privilege as object/group

Select this box to assign the keyboard command the same privilege as the object/group. Only users with this privilege level will be able to issue this command, or log the message. If you want to assign this keyboard command a different privilege, do not select this box; instead, enter another privilege below.

[Security] Privilege level

Enter the privilege level that a user needs to possess to be able 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 be able to issue this command. You can also combine this restriction with area restrictions. 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.

Click the menu to the right of this field to select a privilege, or type in an area number directly.

You can leave this field blank by selecting the Same privilege as object/group box.

[Logging] Log Message

The text message sent to the MsgLog field of the Log Device when the selected action is performed by the operator at runtime. The message is plain text, and can include tag name substitutions using Genie or Super Genie syntax. When using Super Genie syntax, the data type needs to be specified. The name of the tag will then be included in the text. The message can be a maximum of 32 characters long.

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 Access tab.