 |
Command:
TOTAL QRCODES
 |
Node: total_qrcodes |
|
Mandatory: |
no |
|
max. Occurrence: |
unbounded |
|
Description: This tag is used as container for commands regarding QR code definitions for totals.
|
|
 |
|
|
 |
Node: total_qrcode |
|
Mandatory: |
yes |
|
max. Occurrence: |
unbounded |
|
Supported modes: |
delete Delete the named item. deleteall Delete all items. read Read the named item. read+ Read the following item. read- Read the previous 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.
|
|
Notes: This command is used for creating, manipulating or deleting total QR code definitions. In contrast to the command <qrcodes> this definition allows a repetition of information. This is useful to encode information about registrations i.e. weight or amount.
|
|
 |
|
|
|
 |
Tag: qrcode_no |
|
Mandatory: |
yes |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
1 - 9 999
|
|
Nillable: |
no |
|
Description: The number of the total QR code.
|
|
Notes: Supported on receipts and labels/vario label in sales mode.
|
|
 |
|
|
|
 |
Tag: qrcode_description |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 50 characters
|
|
Nillable: |
no |
|
Description: Description of the total QR code definition.
This description is shown in dialogues where the QR code definition can be selected from a list via 'Info' key. e.g. NSM menu
81211.
|
|
 |
|
|
|
 |
Tag: qrcode_version |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
short |
|
Range: |
0 - 40
|
|
Nillable: |
no |
|
Description: The version (size) of the QR code.. 0 meanse the version number is selected automatically base on the QR code data.
The versions 1 - 40 are defined as following:
- |
Number of characters to be encoded |
Version |
Size (Dots) |
Error Correction Level |
Numeric |
Alphanumeric |
Byte |
Kanji |
1 |
21x21 |
LOW MEDIUM QUARTILE HIGH
|
41 34 27 17
|
25 20 16 10
|
17 14 11 7
|
10 8 7 4
|
2 |
25x25 |
LOW MEDIUM QUARTILE HIGH
|
77 63 48 34
|
47 38 29 20
|
32 26 20 14
|
20 16 12 8
|
3 |
29x29 |
LOW MEDIUM QUARTILE HIGH
|
127 101 77 58
|
77 61 47 35
|
53 42 32 24
|
32 26 20 15
|
4 |
29x29 |
LOW MEDIUM QUARTILE HIGH
|
187 149 111 82
|
114 90 67 50
|
78 62 46 34
|
48 38 28 21
|
5 |
37x37 |
LOW MEDIUM QUARTILE HIGH
|
255 202 144 106
|
154 122 87 64
|
106 84 60 44
|
65 52 37 27
|
6 |
41x41 |
LOW MEDIUM QUARTILE HIGH
|
322 255 178 139
|
195 154 108 84
|
134 106 74 58
|
82 65 45 36
|
7 |
45x45 |
LOW MEDIUM QUARTILE HIGH
|
370 293 207 154
|
224 178 125 93
|
154 122 86 64
|
95 75 53 39
|
8 |
49x49 |
LOW MEDIUM QUARTILE HIGH
|
461 365 259 202
|
279 221 157 122
|
192 152 108 84
|
118 96 66 52
|
9 |
53x53 |
LOW MEDIUM QUARTILE HIGH
|
552 432 312 235
|
335 262 189 143
|
230 180 130 98
|
141 111 80 60
|
10 |
57x57 |
LOW MEDIUM QUARTILE HIGH
|
652 513 364 288
|
395 311 221 174
|
271 213 151 119
|
167 131 93 74
|
11 |
61x61 |
LOW MEDIUM QUARTILE HIGH
|
772 604 427 331
|
468 366 259 200
|
321 251 177 137
|
198 155 109 85
|
12 |
65x65 |
LOW MEDIUM QUARTILE HIGH
|
883 691 489 374
|
535 419 296 227
|
367 287 203 155
|
226 177 125 96
|
13 |
69x69 |
LOW MEDIUM QUARTILE HIGH
|
1022 796 580 427
|
619 483 352 259
|
425 331 241 177
|
262 204 149 109
|
14 |
73x73 |
LOW MEDIUM QUARTILE HIGH
|
1101 871 621 468
|
667 528 376 283
|
458 362 258 194
|
282 223 159 120
|
15 |
77x77 |
LOW MEDIUM QUARTILE HIGH
|
1250 991 703 530
|
758 600 426 321
|
520 412 292 220
|
320 254 180 136
|
16 |
81x81 |
LOW MEDIUM QUARTILE HIGH
|
1408 1082 775 602
|
854 656 470 365
|
586 450 322 250
|
361 277 198 154
|
17 |
85x85 |
LOW MEDIUM QUARTILE HIGH
|
1548 1212 876 674
|
938 734 531 408
|
644 504 364 280
|
397 310 224 173
|
18 |
89x89 |
LOW MEDIUM QUARTILE HIGH
|
1725 1346 948 746
|
1046 816 574 452
|
718 560 394 310
|
442 345 243 191
|
19 |
93x93 |
LOW MEDIUM QUARTILE HIGH
|
1903 1500 1063 813
|
1153 909 644 493
|
792 624 442 338
|
488 384 272 208
|
20 |
97x97 |
LOW MEDIUM QUARTILE HIGH
|
2061 1600 1159 919
|
1249 970 702 557
|
858 666 482 382
|
528 410 297 235
|
21 |
101x101 |
LOW MEDIUM QUARTILE HIGH
|
2232 1708 1224 969
|
1352 1035 742 587
|
929 711 509 403
|
572
314 248
|
22 |
105x105 |
LOW MEDIUM QUARTILE HIGH
|
2409 1872 1358 1056
|
1460 1134 823 640
|
1003 779 565 439
|
618 480 348 270
|
23 |
109x109 |
LOW MEDIUM QUARTILE HIGH
|
2620 2059 1468 1108
|
1588 1248 890 672
|
1091 857 611 461
|
672 528 376 284
|
24 |
113x113 |
LOW MEDIUM QUARTILE HIGH
|
2812 2188 1588 1228
|
1704 1326 963 744
|
1171 911 661 511
|
721 561 407 315
|
25 |
117x117 |
LOW MEDIUM QUARTILE HIGH
|
3057 2395 1718 1286
|
1853 1451 1041 779
|
1273 997 715 535
|
784 614 440 330
|
26 |
121x121 |
LOW MEDIUM QUARTILE HIGH
|
3283 2544 1804 1425
|
1990 1542 1094 864
|
1367 1059 751 593
|
842 652 462 365
|
27 |
125x125 |
LOW MEDIUM QUARTILE HIGH
|
3517 2701 1933 1501
|
2132 1637 1172 910
|
1465 1125 805 625
|
902 692 496 385
|
28 |
129x129 |
LOW MEDIUM QUARTILE HIGH
|
3669 2857 2085 1581
|
2223 1732 1263 958
|
1528 1190 868 658
|
940 732 534 405
|
29 |
133x133 |
LOW MEDIUM QUARTILE HIGH
|
3909 3035 2181 1677
|
2369 1839 1322 1016
|
1628 1264 908 698
|
1002 778 559 430
|
30 |
137x137 |
LOW MEDIUM QUARTILE HIGH
|
4158 3289 2358 1782
|
2520 1994 1429 1080
|
1732 1370 982 742
|
1066 843 604 457
|
31 |
141x141 |
LOW MEDIUM QUARTILE HIGH
|
4417 3486 2473 1897
|
2677 2113 1499 1150
|
1840 1452 1030 790
|
1132 894 634 486
|
32 |
145x145 |
LOW MEDIUM QUARTILE HIGH
|
4686 3693 2670 2022
|
2840 2238 1618 1226
|
1952 1538 1112 842
|
1201 947 684 518
|
33 |
149x149 |
LOW MEDIUM QUARTILE HIGH
|
4965 3909 2805 2157
|
3009 2369 1700 1307
|
2068 1628 1168 898
|
1273 1002 719 553
|
34 |
153x153 |
LOW MEDIUM QUARTILE HIGH
|
5253 4134 2949 2301
|
3183 2506 1787 1394
|
2188 1722 1228 958
|
1347 1060 756 590
|
35 |
157x157 |
LOW MEDIUM QUARTILE HIGH
|
5529 4343 3081 2361
|
3351 2632 1867 1431
|
2303 1809 1283 983
|
1417 1113 790 605
|
36 |
161x161 |
LOW MEDIUM QUARTILE HIGH
|
5836 4588 3244 2524
|
3537 2780 1966 1530
|
2431 1911 1351 1051
|
1496 1176 832 647
|
37 |
165x165 |
LOW MEDIUM QUARTILE HIGH
|
6153 4775 3417 2625
|
3729 2894 2071 1591
|
2563 1989 1423 1093
|
1577 1224 876 673
|
38 |
169x169 |
LOW MEDIUM QUARTILE HIGH
|
6479 5039 3599 2735
|
3927 3054 2181 1658
|
2699 2099 1499 1139
|
1661 1292 923 701
|
39 |
173x173 |
LOW MEDIUM QUARTILE HIGH
|
6743 5313 3791 2927
|
4087 3220 2298 1774
|
2809 2213 1579 1219
|
1729 1362 972 750
|
40 |
177x177 |
LOW MEDIUM QUARTILE HIGH
|
7089 5596 3993 3057
|
4296 3391 2420 1852
|
2953 2331 1663 1273
|
1817 1435 1024 784
|
|
|
 |
|
|
|
 |
Tag: encoding |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
ALPHA BYTE NUMERIC KANJI AUTO
|
|
Nillable: |
no |
|
Description: .
Value |
Description |
ALPHA |
Encodes alphanumeric characters (digits 0 – 9, upper case letters A –Z, and twelve other characters: space, $ % * + - . /
: ); ).
|
BYTE |
Encodes binary values ( 8-bit data). |
NUMERIC |
Encodes numeric values only (digits 0-9). |
KANJI |
Encodes Kanji characters.
Kanji characters are Chinese characters used in Japanese writing.
Kanji characters in QR Code can have values U+8140 - U+9FFC and U+E040 - U+EBBF.
|
AUTO |
Encode alphanumeric and UTF-8 chars. |
|
|
 |
|
|
|
 |
Tag: error_correction_level |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
LOW MEDIUM QUARTILE HIGH
|
|
Nillable: |
no |
|
Description: QR Code has error correction capability to restore data if the code is dirty or damaged.
Raising this level improves error correction capability but also increases the amount of data QR Code size.
- The lower the error correction level, the less dense the QR code image is, which improves minimum printing size.
- The higher the error correction level, the more damage it can sustain before it becomes unreadable.
- Level L or Level M represents the best compromise between density and ruggedness for general marketing use.
- Level Q and Level H are generally recommended for industrial environments where keeping the QR code clean or un-damaged will
be a challenge.
Be aware higher levels of error correction require more bytes, so the higher the error correction level, the larger the QR
code becomes.
Based on QR code version and error correction level, the number of character encoded to QR code is varied.
For more details about the number of characters to be encoded refer to <qrcode_version>.
Value |
Description |
LOW |
Recovers 7% of data. |
MEDIUM |
Recovers 15% of data. |
QUARTILE |
Recovers 25% of data. |
HIGH |
Recovers 30% of data. |
|
|
 |
|
|
|
 |
Tag: qrcode_header |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 400 characters
|
|
Nillable: |
no |
|
Description: The header is the part of the total QR code which contains general information that isn't depending on a registration.
This is i.e. the total of a receipt, date/time of a receipt, ... Information on registration level has to be encoded in <data_definition>. It can contain literal text and/or references.
References are marked in the data definition as following:
$D(DataSource Parameter)
where
$D( |
Marks the start of the reference. |
DataSource |
Name defined in the table below. |
Parameters |
Parameter list defined in the table below. |
) |
Marks the end of the reference. |
Data sources
Value |
Description |
Start Position
|
Max. Length
|
Fill Character
|
Justification |
Precision |
Format |
Algebraic Sign |
TransactionID |
The receipt number |
|
|
|
|
|
|
|
DateToday |
Current date. |
|
|
|
|
|
|
|
TransactionOperatorID |
Number of the operator printed the receipt/label. |
|
|
|
|
|
|
|
TicketTotalPrice |
The summarized total (including markups/discounts). |
|
|
|
|
|
|
|
DeviceID |
Number of the device. |
|
|
|
|
|
|
|
TicketItemCount |
Number of positions or number of items on the receipt/label. This is depending on the configuration switch bSummationPos in command <configuration_profiles>.
|
|
|
|
|
|
|
|
TransactionQRData |
QR data assigned in the configuration to the receipt/label. |
|
|
|
|
|
|
|
Parameters
Parameters marked as mandatory (
) in the table above have to be sent. Otherwise the QR code is not printed.
Parameter |
Description |
Values |
-sp |
Start Position: Is used to specify the start location of the string.
For example, if start position is 5, the string from 5th character is taken for encoding to QR code.
Default is 1. |
1 - max. string length. |
-l |
Max. Length: If maximum length is specified, specified number of character is included.
If it is not specified, entire text will be included into QR code data.
Default is 0.
If maximum length is 0, it will take entire text for QR code data. Maximum value of Maximum length is 999.
|
0 - 999; |
-fc |
Fill Character: If fill character is specified, that character is filled for remaining length of specified maximum length. Only one character
is allowed for fill character. If more than one character is specified, first character will be taken. Fill character should
be specified within single quotes. Default value is ‘0’ for numeric and ‘ ‘ (space) for strings.
|
|
-ju |
Justification: Defines from which side the number will be filled.
The default fill character position is LEFT.
If reference name or reference number is invalid, that text is not included into the QR code data.
If text is not available in the specified reference number, it is also not included into the QR code data.
If actual text size is less than specified size (maximum length), the whole text will be included; otherwise specified text
will be included.
If number of actual digits (in numeric fields) is greater than maximum length, specified length of digits will be encoded
If maximum length is not specified, the whole text will be included into QR code data.
If fill character is not specified, data will be framed without fill character.
If fill character position is not specified, fill character position is not considered for framing
|
LEFT: Fill the specified character in the left side of the text
RIGHT: Fill the specified character in the right side of the text
|
-p |
Precision: This parameter is valid for price and weight related reference name to print number of digits after the decimal point.
Default: If this parameter is not specified, it will take precision value from application. |
0 - 9 |
-f |
Format:This parameter is valid for date fields.
Parameter |
Description |
YYYY |
Year including the century (e.g. 2013) |
YY |
Year not including the century (e.g. 13 for the year 2013) |
M |
Month in year without leading 0 (e.g. 9 for September or 12 for December) |
MM |
Month in year using leading 0, if necessary (e.g. 09 for September or 12 for December) |
D |
Day of month without leading 0 (e.g. 5 and not 05)
|
DD |
Day of month using leading 0 (e.g. 05 or 12) . |
H |
Hour of the day (0 - 23) without leading 0 (e.g. 5 and not 05)
|
HH |
Two digit hour using leading zero (e.g. 05 or 12) |
N |
Day of the year without leading zero (e.g. 5) |
NNN |
Three digit Day of the year using leading zero (e.g. 005) |
|
|
-as |
Algebraic Sign: This parameter is valid for price related reference names encoding an algebraic sign to indicate a positive or negative value.
Default: If this parameter is not specified, the algebraic sign is not encoded.
Parameter |
Description |
a |
Algebraic sign is encoded alphanumerical ('+'/'-')
+15,12 € with a length of 8 characters is encoded as following: +0001512
-15,12 € with a length of 8 characters is encoded as following: -0001512
|
n |
Algebraic sign is encoded numerical ('0'/'1')
+15,12 € with a length of 8 characters is encoded as following: 00001512
-15,12 € with a length of 8 characters is encoded as following: 10001512
|
|
See description.
|
|
|
Notes: See examples page.
|
|
 |
|
|
|
 |
Tag: data_definition |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
string |
|
Range: |
max. 600 characters
|
|
Nillable: |
no |
|
Description: The data definition reflects the repetitive part. For each registration the data definition is used to encode the information
in the QR code. The data definition can contain literal text and/or references.
References are marked in the data definition as following:
$D(DataSource Parameter)
where
$D( |
Marks the start of the reference. |
DataSource |
Name defined in the table below. |
Parameters |
Parameter list defined in the table below. |
) |
Marks the end of the reference. |
Data sources
Value |
Description |
Start Position
|
Max. Length
|
Fill Character
|
Justification |
Precision |
Format |
Algebraic Sign |
ItemPLU |
Article/item number |
|
|
|
|
|
|
|
ItemUAN |
UAN assigned to an article/items |
|
|
|
|
|
|
|
DateToday |
Current date. |
|
|
|
|
|
|
|
TransactionDepartmentID |
Department number the article/items belongs to. |
|
|
|
|
|
|
|
DeviceID |
Number of the device the article/item has been registered. |
|
|
|
|
|
|
|
TransactionItemCount |
Number of items of a registration. |
|
|
|
|
|
|
|
TransactionNetWeight |
Weight of a registration. |
|
|
|
|
|
|
|
TransactionItemTaxID |
VAT number used for a registration. |
|
|
|
|
|
|
|
TransactionBasePrice |
Base price of an article/item. |
|
|
|
|
|
|
|
LotNumber |
Lot number assigned to an article/item. |
|
|
|
|
|
|
|
TransactionPrice |
Amount the customer has to pay for this article/item.
In general, the amount is the result of base price multiplied by weight or base price multiplied by numer of items.
|
|
|
|
|
|
|
|
Parameters
Parameters marked as mandatory (
) in the table above have to be sent. Otherwise the QR code is not printed.
Parameter |
Description |
Values |
-sp |
Start Position: Is used to specify the start location of the string.
For example, if start position is 5, the string from 5th character is taken for encoding to QR code.
Default is 1. |
1 - max. string length. |
-l |
Max. Length: If maximum length is specified, specified number of character is included.
If it is not specified, entire text will be included into QR code data.
Default is 0.
If maximum length is 0, it will take entire text for QR code data. Maximum value of Maximum length is 999.
|
0 - 999; |
-fc |
Fill Character: If fill character is specified, that character is filled for remaining length of specified maximum length. Only one character
is allowed for fill character. If more than one character is specified, first character will be taken. Fill character should
be specified within single quotes. Default value is ‘0’ for numeric and ‘ ‘ (space) for strings.
|
|
-ju |
Justification: Defines from which side the number will be filled.
The default fill character position is LEFT.
If reference name or reference number is invalid, that text is not included into the QR code data.
If text is not available in the specified reference number, it is also not included into the QR code data.
If actual text size is less than specified size (maximum length), the whole text will be included; otherwise specified text
will be included.
If number of actual digits (in numeric fields) is greater than maximum length, specified length of digits will be encoded
If maximum length is not specified, the whole text will be included into QR code data.
If fill character is not specified, data will be framed without fill character.
If fill character position is not specified, fill character position is not considered for framing
|
LEFT: Fill the specified character in the left side of the text
RIGHT: Fill the specified character in the right side of the text
|
-p |
Precision: This parameter is valid for price and weight related reference name to print number of digits after the decimal point.
Default: If this parameter is not specified, it will take precision value from application. |
0 - 9 |
-f |
Format:This parameter is valid for date fields.
Parameter |
Description |
YYYY |
Year including the century (e.g. 2013) |
YY |
Year not including the century (e.g. 13 for the year 2013) |
M |
Month in year without leading 0 (e.g. 9 for September or 12 for December) |
MM |
Month in year using leading 0, if necessary (e.g. 09 for September or 12 for December) |
D |
Day of month without leading 0 (e.g. 5 and not 05)
|
DD |
Day of month using leading 0 (e.g. 05 or 12) . |
H |
Hour of the day (0 - 23) without leading 0 (e.g. 5 and not 05)
|
HH |
Two digit hour using leading zero (e.g. 05 or 12) |
m |
Minute of the hour (0 - 59) without leading 0 (e.g. 5 and not 05)
|
mm |
Two digit minutes using leading zero (e.g. 05 or 12) |
s |
Seconds of the minute (0 - 59) without leading 0 (e.g. 5 and not 05)
|
ss |
Two digit seconds using leading zero (e.g. 05 or 12) |
N |
Day of the year without leading zero (e.g. 5) |
NNN |
Three digit Day of the year using leading zero (e.g. 005) |
|
|
-as |
Algebraic Sign: This parameter is valid for price related reference names encoding an algebraic sign to indicate a positive or negative value.
Default: If this parameter is not specified, the algebraic sign is not encoded.
Parameter |
Description |
a |
Algebraic sign is encoded alphanumerical ('+'/'-')
+15,12 € with a length of 8 characters is encoded as following: +0001512
-15,12 € with a length of 8 characters is encoded as following: -0001512
|
n |
Algebraic sign is encoded numerical ('0'/'1')
+15,12 € with a length of 8 characters is encoded as following: 00001512
-15,12 € with a length of 8 characters is encoded as following: 10001512
|
|
See description.
|
|
|
Notes: See examples page.
|
|
 |
|
|
|
 |
Tag: last_change |
|
Mandatory: |
no |
|
max. Occurrence: |
1 |
|
Datatype: |
dateTime |
|
Range: |
- |
|
Nillable: |
yes |
|
Description: The last time when the record was changed. 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
|
|
 |
|
|