Epson TrueOrder KDS Epson TrueOrder KDS XML Specification
Epson TrueOrder KDS Manual
 |
View all Epson TrueOrder KDS manuals
Add to My Manuals
Save this manual to your list of manuals |
Epson TrueOrder KDS manual content summary:
- Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 1
111-56-URM-013 Epson TrueOrder KDS XML Configuration About this Guide This guide presents the configuration specification for the Epson TrueOrder KDS. As detailed here, the configuration of the entire KDS system can be stored in a single XML - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 2
Table of Contents 1. KDS CONFIGURATION 5 1.1. Basics ...5 1.1.1. Configuration File ...5 1.1.2. File Handling ...5 1.1.3. Caveats ...5 1.2. DTD...6 1.3. Versions and Compatibility ...9 1.4. DHCP Handling ...10 2. Detailed Description 11 2.1. General ...11 2.1.1. Document Root and Basic Structure - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 3
2.4.6. DisplayID ...22 2.4.7. BackupDisplayID...22 2.4.8. IsPrinter ...22 2.4.9. AllowPrint ...22 2.4.10. PrintItemOnBumpAtSelf ...22 2.4.11. PrintTileOnBumpAtSelf ...22 2.4.12. PrintTileOnBumpAtMaster ...22 2.4.13. SerialNumber ...22 2.4.14. DeviceName...23 2.4.15. StationName ...23 2.4.16. - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 4
2.6.12. void...30 2.6.13. append_item ...30 2.6.14. expeditor_bump_background ...30 2.6.15. selection ...30 2.6.16. alert ...30 2.6.17. font_size...30 2.6.18. lines_per_tile ...31 2.6.19. header_name ...31 2.6.20. tile_type...31 2.6.21. LineSpacing ...31 2.6.22. LeftColumnHeaderLabel ...31 2.6.23. - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 5
configuration file: • http://xx.xx.xx.xx/webconfig/config_appl_kvsconfig.cgi This is the human-accessible web page which can be used to manually upload a configuration file. • http://xx.xx.xx.xx/webconfig/upload_kvs_configfile_updater.cgi This is the actual web page used to POST the configuration - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 6
,NoMergeTimeZone,TimeServer,MenuRouting,EnableTouc hCalibration)> GUID CDATA #REQUIRED> IP CDATA #REQUIRED> GUID CDATA #REQUIRED> - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 7
TileItemName,CustomerFacingDisplay Background,CustomerFacingDisplayHeader)> GUID CDATA #REQUIRED> GUID CDATA #REQUIRED> - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 8
CDATA #REQUIRED> GUID CDATA #REQUIRED> ]> Some of the data requires more specification than the standard DTD format can allow. Form: F-730-028 v1.00 Epson TrueOrder KDS - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 9
1.3. Versions and Compatibility This document defines the XML file format as it is created by the Configurator (web-based configuration utility) hosted on each TrueOrder KDS device. Efforts have been made to ensure bi-directional compatibility as much as possible, so that newer versions of the - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 10
1.4. DHCP Handling There is some special consideration required if the KDS devices are to be configured for DHCP. Specifically, all the notes about IP and MAC addresses under Caveats above are still true: all the MAC addresses must match the devices, and all IP addresses must match the current IP - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 11
first hex digit of the fourth parameter must be 8, 9, a, or b. GUID hex digits should be in a consistent case within the file to allow for text the usual dotted notation "ddd.ddd.ddd.ddd". (IPv6 is currently not supported.) As noted above, both of these addresses must already be pre-configured - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 12
• \v - vertical tab • \xnn - character specified by hexadecimal data • \0nnn - character specified by octal data The strings should be no more than 255 characters, though that limit is on the data after parsing, not the pre-parsed text in the XML file. So pre-defined graphics logos can be used, but - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 13
on an order by sending the item directly to that display rather than to the master. MenuFilters are not needed. Note that the KDS actually supports both types of routing at all times; the only time anything in the configuration needs to be changed based on routing type is if the - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 14
• Order 1234 sent a void for 'Burger' and '- Fries' to display 2 only Also, the presence of a separate expediter display is used to show what is stored. In practice there is not much point in using an KDS-run expediter if NoMerge is True, and especially if both are true. 2.2.4.1. NoAppend = False, - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 15
which apply to the KDS system as a whole, which must be identical for all machines on the network. Site Name 2016-4-29T14:14:5 4.20 - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 16
2.3.3. DateTimeStamp The 'DateTimeStamp' element contains text of a simple timestamp of the time the configuration file was created, and can be used to define which file was the most recent. It is normally local time, presented in a slightly simplified ISO 8601 format as "yyyy-mm-ddThh:mm:ss". The - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 17
for a complete list. Note that this must be a name that is actually installed, and not all are by default. The base list guaranteed to be supported by the KDS includes: • Africa/Cairo Form: F-730-028 v1.00 Epson TrueOrder KDS XML Configuration Page 17 of 33 111-56-URM-013 R3 - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 18
• America/Anchorage • America/Caracas • America/Chicago • America/Denver • America/Los_Angeles • America/New_York • America/Sao_Paulo • Asia/Dhaka • Asia/Dubai • Asia/Hong_Kong • Asia/Karachi • Asia/Tokyo • Australia/Adelaide • Australia/Brisbane • Australia/Darwin • Australia/Perth • Australia/ - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 19
• Etc/GMT-12 • Etc/GMT-13 • Etc/GMT-14 • Etc/GMT-2 • Etc/GMT-3 • Etc/GMT-4 • Etc/GMT-5 • Etc/GMT-6 • Etc/GMT-7 • Etc/GMT-8 • Etc/GMT-9 • Etc/GMT0 • Etc/Greenwich • Etc/UCT • Etc/UTC • Etc/Universal • Etc/Zulu • Europe/London • Europe/Moscow • Europe/Paris • GB • GMT • GMT+0 • GMT-0 • GMT0 • - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 20
). 2.3.22. EnableTouchCalibration For TrueOrder KDS, this is currently not supported as calibration is handled at the OS level on the KDS which they don't want printed, but others use this header for special instructions which they do want printed. This flag was previously known as 'EnableLabelPrint - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 21
box. As noted above, the Printer element contains three attributes: GUID, IP, and MAC. Burger Station 1 - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 22
be blank. This is no longer a restriction: the master device can now support a display no matter the size of the network. 2.4.6. DisplayID The 'DisplayID' display. If it contains data, it must contain a GUID value which matches the GUID attribute of one of the 'Display' subsections. That matching - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 23
2.4.14. DeviceName The 'DeviceName' element contains the model of the KDS device. For backward compatibility, all KDS devices present themselves as Epson TM-T88V printers. As with 'SerialNumber', this is only used by the configuration utility, not the firmware. 2.4.15. StationName The 'StationName' - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 24
the two devices will always be showing the same thing. This may or may not be what you want. Burger Display 1 1bd0d90a-3eca-4ca7-b347-3b0529dab13f Burger%20Display - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 25
file. 2.5.3. DisplayTileID The 'DisplayTileID' element contains a GUID value which matches the GUID attribute of one of the 'Tile' subsections. That "S2X6" for a screen with two rows and six columns. The system can support from one to three rows, and anywhere from four to six columns. 2.5.7. - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 26
the element consists of a list of GUIDs matching the GUIDs of MenuItem elements from the Menu section. These GUIDs are separated by pairs of colons, • Chinese_Gong • Ding1 (solid bell) • Ding2 (old countertop call for service bell) • Dong (tube chime) • Electronic_01 (quick fanfare) • Electronic_02 - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 27
name for display on a Customer Facing Display. If available, this replaces the default "Epson" logo. 2.5.26. MerchantLogo The 'MerchantLogo' element is a GUID representing the desired logo image file from the list of Logos uploaded as part of this configuration. See Section 2.8. If available, a logo - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 28
2.5.28. CustomerFacingDisplayBackground The 'CustomerFacingDisplayBackground' element contains the hexadecimal value of the Customer Facing Display background colour. The possible values are '#000000' and '#FFFFFF'. 2.5.29. CustomerFacingDisplayHeader The 'CustomerFacingDisplayHeader' element - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 29
to one particular 'theme' so that they can be all changed at once rather than changing each individually. 10-Liner Tile #FFFFFF Default%20Colors #020002 - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 30
2.6.4. foreground The 'foreground' element is a colour describing the default text colour of the order. 2.6.5. ListIndex The 'ListIndex' element is purely for the use of the Utility. It can be left blank in this section. 2.6.6. item The 'item' element is a colour describing the text colour of new - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 31
the text for the numeric column in the order display. This should be either 'SEAT' (for the seat number in table service) or 'QTY' (for the item quantity in quick service). 2.6.20. tile_type The 'tile_type' element describes what type of tile information this provides, and is only of interest to the - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 32
. Note that this value actually has no meaning to the KDS devices; it is purely used by the configuration utility to assign several GUIDs to a filter at once. 2.7.3. FriendlyName The 'FriendlyName' attribute is a string of a slightly more human-readable description of the item in question, and is - Epson TrueOrder KDS | Epson TrueOrder KDS XML Specification - Page 33
Epson Logo. Each Logo is a base64 encoded image. Base64 encoded image data Base64 encoded image data 2.8.1. Logo
-
1 -
2 -
3 -
4 -
5 -
6 -
7 -
8
-
9
-
10
-
11
-
12
-
13
-
14
-
15
-
16
-
17
-
18
-
19
-
20
-
21
-
22
-
23
-
24
-
25
-
26
-
27
-
28
-
29
-
30
-
31
-
32
-
33
 |
 |
Epson TrueOrder KDS
XML Configuration
Page 1 of 33
111-56-URM-013
R3.00
Form: F-730-028 v1.00
About this Guide
This guide presents the configuration specification for the Epson TrueOrder KDS. As detailed here, the
configuration of the entire KDS system can be stored in a single XML file.
EPSON is a registered trademark and EPSON is a registered logomark of Seiko Epson Corporation. All other product and brand names
are trademarks and/or registered trademarks of their respective companies. Epson disclaims any and all rights in these marks.
Copyright 2023 Seiko Epson Corporation.
111-56-URM-013
Epson TrueOrder KDS
XML Configuration