placeholder Command:  KEYBOARD LAYOUT CONFIGURATIONS 


Short version Long version Changes Example

Mandatory: no
max. Occurrence:  unbounded
Description:
This tag is used as container for commands regarding the configuration of the keyboard layouts.
 
Mandatory: yes
max. Occurrence:  unbounded
Supported modes: delete Delete the named item.
deleteall Delete all items.
read Read the named item.
readall Read all items from the desired device(s). This doesn't mean comparable reading as in the L2 protocol.
write Write the named item.
Description:
This command is used for creating, manipulating or deleting a keyboard layout configuration.
Notes:
The mode ''deleteall'' uses the values of the elements keyboard_type and keyboard_no.
Thus all keys of a keyboard configuration will be deleted and not all available keyboard configurations.

The mode ''readall'' uses the values of the elements keyboard_type and keyboard_no.
Thus, it is returning all keys of a keyboard configuration and not all available keyboard configurations.
   
Mandatory: yes
max. Occurrence: 1
Datatype: string
Range: -
Nillable: no
Description:
The following values are supported:
Value Description
KeyboardtypeAsIs The operation has effect on the current used keyboard type.
Keyboardtype79 Keyboard with 79 keys -> Compact Scale.
Keyboardtype99 Keyboard with 99 keys -> Service Scale.
Keyboardtype100 Keyboard with 100 keys -> Selfservice Scale.
Keyboardtype144 Keyboard with 144 keys -> Selfservice Scale.
Keyboardtype180 Keyboard with 180 keys -> Selfservice Scale.
KeyboardtypeTouch The keyboard of a touch device can be configured.

   
Mandatory: yes
max. Occurrence: 1
Datatype: short
Range: 1 - 999
Nillable: no
Description:
For each keyboard type can be defined different keyboard layouts which gets a keyboard number. For each key is defined which is its function (key_type) within this layout.
In the sales_, selfservice_ and prepack_application_configurations it is defined which keyboard number (keyboard layout) each scale uses for the different application modes.
For each keyboard there is a predefined number of keys available. The range is from 1 - the maximum number of keys (this is depending on the keyboard type). The key in the upper left corner is the key no 1.

Up to application version 1.12.0 we have the profile based configuration, and so the definition which keyboard number is used in which mode is defined within the configuration profiles configuration_profiles.
   
Mandatory: yes
max. Occurrence: 1
Datatype: short
Range: 1 - max.
Nillable: no
Description:
For each keyboard there is a predefined number of keys available. The range is from 1 - the maximum number of keys (this is depending on the keyboard type). The key in the upper left corner is the key no 1.
   
Mandatory: no
max. Occurrence: 1
Datatype: short
Range: 0 - 1
Nillable: no
Notes:
At the moment the shift key can only be used in combination with the plu key.
   
Mandatory: no
max. Occurrence: 1
Datatype: string
Range: -
Nillable: no
Description:
For touch devices (tag keyboard_type = KeyboardtypeTouch) it's only possible to assign the key type "PluKey" with this command, because all other key types must be defined direct in the XML file of the touch layout.
The PluKey's must be defined in the touch layout with button ID Presetxxx, where xxx is the button number, which must be used to identify the button with the tag key_no of this command (Layout ID: Preset123 --> key_no to use is 123).


The following values are possible for the keytype:
Name Description
PluKey An item/article is assigned. For this keytype the shift key can be used (only for tactile scales).
Price2Key Use for the next article the second price.
WeightKey Feed in the weight manual.
PresetTareKey Use the assigned tare value.
ArticleGroupKey Assigned the turnover to an article group when using manual input or free base price.
DepartmentKey A department is assigned to this key to take the next article out of this department instead of the priority department.
UanKey Selecte an article by its UAN number instead of the PLU number.
OperatorKey Define operator keys for the different operators.
ShiftKey The shift functionality of a key can be used (can only be used in combination with the PLU Keys).
The following key is supported with version 1.0.9 and higher.
InventoryKey Handle the current done registrations in sales application mode as if done in the inventory mode.
The following key is supported with version 1.0.10 and higher.
LabelKey Select another label template in prepack mode.
DateKey Assign an other packing date, best before date or best before date for a selected item in prepack mode.
The following key is supported with version 1.2.0 and higher.
ModeKey Enter another mode by pressing this key.
The following key is supported with version 1.2.1 and higher.
TextKey Assign a text when pressing this key.
The following key is supported with version 1.3.2 and higher.
TenderKey Use tender functionality when pressing this key.
The following key is supported with version 1.3.3 and higher.
RewrapKey Change to rewrap mode and back (toggle).
The following key is supported with version 1.5.0 and higher.
PadKey Start module for defining a new traceability lot of type 'Auto lot id' for the selected article when key is pressed.
OrderKey Close a receipt using 'Order Receipt' (Ticket de encargo) when pressing this key.
The following key is supported with version 1.6.0 and higher.
BasketKey Close a receipt using a basket number when pressing this key.
The following key is supported with version 1.8.0 and higher.
IngredientKey Select the ingredients of an article/item.
CategoryKey Select a category.
The following key is supported with version 1.9.0 and higher.
CustomerKey Enter the number of an order receipt or a goods receipt to transfer it to the cash register receipt.
The following keys are supported with version 1.10.0 and higher.
PageKey Link another page to this button. A button press results in a call to the referenced page.
MarkupDiscountKey Select a markup or discount when pressing this key
NaturalDiscountKey Assign natural discount to the selected article/item.
ECPaymentKey Start electronic cash payment when pressing this key.
The following key is supported with version 1.13.0 and higher.
DeliveryNoteKey Finalize registrations as delivery note.
The following key is supported with version 1.14.0 and higher.
ModeProfileKey Assign another configuration profile. The profile number assigned with this key exchanges the current profile number of the application running at the moment.
If the application runs in e.g. sales mode then the profile assigned to the sales mode of this device will be exchanged, stored and loaded.
A restart of the device results in loading the new configuration data.
The following key is supported with version 1.17.0 and higher.
OrderingKey Inititate an ordering to order items from the headquarters.

Notes:
For further information about the fuctionality assigned to the keys see the manual of the device.
   
Mandatory: no
max. Occurrence:  1
Description:
Each key has at least one property. But there are also more properties possible. This is depending on the key type.
     
Mandatory: yes
max. Occurrence:  unbounded
Description:
The subelements contains the information of one property.
       
Mandatory: yes
max. Occurrence: 1
Datatype: string
Range: -
Nillable: no
Description:
For the key type 'PluKey' the following propertiy names are necessary:
- 'department_no'
- 'plu_no'
 
For the key type 'PresetTareKey' the following property name is optional:
- 'tare_no'
 
For the key type 'DepartmentKey' the following property name is optional:
- 'department_no'
 
For the key type 'OperatorKey' the following property name is optional:
- 'operator_no'
 
For the key type 'InventoryKey' the following property name is optional:
- 'inventory_mode'
- For the range of values and its meaning see the tag <mode_no> of the command <inventory_application_configurations>.
- If this property is missing then the value 0 is the default.
 
For the key type 'ModeKey' the following property name is necessary:
- 'mode'
- The values for it are as following:
- 0 = NSM (Non Sales Mode)
-> the number for the quick select is this one shown in the right upper corner of the display when the item is selected
- 1 = Sales mode
- 2 = Prepack mode
- 3 = Selfservice mode
- 4 = Inventory mode
- 4x = Inventory Subtype X
- 5 = Customer mode
- 6 = CashRegister mode
- 9 = Operating system
 
- 'shortcode_no' if the property 'mode' is set to '0'.
- The shortcode number of the desired menu.
- The number is in the upper right corner of the desired menu.
 
- 'inventory_mode' if the property 'mode' is set to '4'.
- For the range of values and its meaning see the tag <mode_no> of the command <inventory_application_configurations>.
 
For the key type 'TenderKey' the following property name is optional:
- 'tender_no'
- For the range of values and its meaning see the tag <tender_no> of the command <tenders>.
- If this property is missing then the value 0 is the default.
 
For the key type 'IngredientKey' the following property name is optional:
- 'ingredient_no'
 
For the key type 'CategoryKey' the following property name is optional:
- 'category_no'
 
For the key type 'CustomerKey' the following property name is optional:
- 'customer_no'
 
For the key type 'PageKey' the following property name is necessary:
- 'page_no'
For the key type 'PageKey' the following property name is optional:
- 'label'
 
For the key type 'MarkupDiscountKey' the following property name is optional:
- 'markup_discount_no'
 
For the key type 'ModeProfileKey the following property name is necessary:
- 'profile_no'
       
Mandatory: yes
max. Occurrence: 1
Datatype: string
Range: -
Nillable: no
Description:
The value of the property
The range is depending on the property name.
   
Mandatory: no
max. Occurrence: 1
Datatype: dateTime
Range: -
Nillable: yes
Description:
CCYY-MM-DDThh:mm:ss
The format is as following:
C = Century
Y = Year
M = Month
D = Day
T = Separator between date and time
h = hour
m = minute
s = second