Epson TrueOrder KDS Epson TrueOrder KDS Configurator User Manual
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 Configurator User Manual - Page 1
111-56-URM-007 Epson TrueOrder KDS KDS Configurator About this Guide This guide is a user manual for the KDS Configuration Utility AKA Configurator. The Configurator is a web-based application that can be accessed by any device running a browser, such as a PC - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 2
Table of Contents 1. Introduction...3 1.1. Definitions ...3 1.2. Network Setup Requirements...3 1.3. System Overview ...4 2. KDS Configuration Utility Operation 6 2.1. Log In Screen ...6 2.1.1. Default Username and Password 6 2.2. Main Menu ...8 2.3. Stations ...11 2.3.1. Station Configuration ... - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 3
or controller that is not connected and receiving orders from the POS. LAN - Local Area Network. 1.2. Network Setup Requirements • LAN connection should support broadcast service through the network. • TCP Port 80 open and unblocked. • UDP Port 3290 open and unblocked. • Firewall on the PC must be - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 4
1.3. System Overview The following figures show a sample Epson TrueOrder Single Station KDS setup and a Multi-Station setup. The KDS devices (AIOs and controller boxes) are connected over the LAN and DHCP is the factory default. The Configuration Utility can easily discover all the devices and allow - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 5
KDS Config WebApp All In One Touchscreen Network router/switch Ethernet USB Media Box Figure 2: Sample Muti Station KDS Setup. Form: F-730-028 v1.00 Epson TrueOrder KDS KDS Configurator Page 5 of 67 111-56-URM-007 R4.34 Trademarks - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 6
2. KDS Configuration Utility Operation 2.1. Log In Screen The KDS can be configured via a web-based Configurator hosted on all KDS devices. Using a browser, access the Configurator at http://xxx.xxx.xxx.xxx (IP address of the device). The Configuration Utility Web App is a tool that can alter the - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 7
If the username and password are valid and it is the user's first login, it will be shown a warning regarding the end user license agreement. Figure 5: End user license agreement warning. After proceeding, a modal will be shown with the end user license agreement. To continue using the system, the - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 8
main menu. Stations - Manage a collection of stations and devices, their network settings, and some device-specific settings. In addition, it gives support to perform some file settings actions (system settings full import and export) Layout - Manage KDS Grids and their functionality, as well as - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 9
sessions and preferences, including settings for roles and users (in the Global Settings option). It is also possible to access the user manual (this document), through the User Manual option, and the About modal. Also, the user will be able to sign out of the system by clicking on Sign Out - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 10
Figure 11: Profile Menu Options. Clear Options: When the user accesses the clear options menu, then it will drop actions according to the user's permissions which are: Figure 12: Clear Options. Clear All Devices: Use this command to clear all devices on KDS. Clear All Grids: Use this command to - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 11
2.3. Stations 2.3.1. Station Configuration A Station represents a TrueOrder KDS device that needs to be configured by the customer as per the requirements of the kitchen. There can be a single station KDS setup or a multi-station KDS setup. Both will be described in detail in later sections. One of - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 12
Name: Name of the station. This name must be unique. Description: Optional station description. Station Print Only: It is a flag that specifies that this station will only be used for printing. Station Type: Section to choose among Kitchen, Expeditor, or Customer Facing. Layout: Pick the associated - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 13
Figure 16: Automatically duplicating a grid with the exact layout to be associated with the station. 2.3.1.2. Mirror a Station One of the possible options in a station is to mirror a station, that is, to create a station with the same layout settings. Thus, if there is a change in any configuration - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 14
An icon with a tooltip will be shown next to the station name when it is a mirrored station. Figure 18: Mirrored Station. When the user enters a station's edition form, there will be a section alerting if this station is a mirror. Figure 19: Mirrored station alert section. 2.3.1.3. Device - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 15
at this point they can be configured further. If you had not used the wizard, you could still discover them here and configure each one manually. This section will explain some of the things that can be done. When you enter the device configuration screen, if there is no device configured - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 16
is used to import. 2.3.1.4. Add a new Device This option allows you to add new devices to the system, with the possibility of doing this addition manually or performing a network search to find an existing device. Form: F-730-028 v1.00 Epson TrueOrder KDS KDS Configurator Page 16 of 67 111-56 - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 17
Figure 25: Select device - Add Device via manual mode or search for a Device on the network. 2.3.1.5. Manual Figure 26: Manually adding a device form. In this option, it is necessary to add the correct device information, so the configuration may occur successfully, and the device will - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 18
Otherwise, it will display ERROR status in the device list, as you can see in the image below. Figure 27: Manually adding a Device from the display of an incorrectly configured device. 2.3.1.6. Search This command opens a discovery window that allows you to easily add a device to your - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 19
Figure 28: Select Device - Discovery of network-connected Devices. After the successful search and insertion of the device, it will be displayed in the list of already registered, being able to edit/delete in the future. Form: F-730-028 v1.00 Epson TrueOrder KDS KDS Configurator Page 19 of 67 111 - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 20
Figure 29: Display of a correctly configured Device. 2.3.1.7. Device Options On the initial screen listing Devices already registered, you can access the Device options menu, using the button. Among the action options, we have: Form: F-730-028 v1.00 Figure 30: Actions options in Device Menu. - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 21
Edit: It is possible to enter the Device's edit mode by adjusting the existing settings. You can also access the mode by clicking directly on the card. Figure 31: Edition mode screen of a Device. Edit IP Settings: This command allows you to change IP settings for a device. This brings up the Set new - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 22
Calibrate Touch Screen: This command will trigger the touch screen calibration. Figure 33: Calibrate Touch Screen. Import Configuration: Imports previously exported device settings. Please note that IP, MAC, and the Name will not be altered. Figure 34: Import configuration to a Device/ Export - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 23
Figure 35: Export configuration of a Device. Delete: This command deletes a device from the list. Once deleted, the discovery should be able to re-discover it. Figure 36: Modal confirmation for deleting an already configured Device. 2.3.1.8. File Config If necessary, there is the possibility of - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 24
Figure 37: Screen of File Config: Export and Import settings. 2.3.2. Layout Control the layout of the KDS Configuration tool by controlling the following properties. These settings stay local to your account and do not affect the KDS Configuration File. 2.3.2.1. Grids In the Grids section, you can - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 25
Figure 38: Configured Grids listing screen. 2.3.2.2. Add New Layout This option allows you to add a new layout to the system. You will be redirected to the grid registration form with some default attributes that can be fully configured and saved. Once added, the grid configuration becomes active. - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 26
Figure 40: Form for configuring a Kitchen Grid. Name: Name of the grid. This name must be unique. Description: Optional grid description. Grid Type: Layout type of the grid. • Flexible Grid: Kitchen grid that makes "overflowing" tickets display the remaining information in the adjacent column ( - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 27
Ticket: Specifies which ticket is chosen and shows a preview of said ticket. Priority Time: Specifies how much time in minutes and seconds must pass for the item to change to priority mode. The priority mode for the item indicates that it took longer for the item to be prepared, and that action - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 28
order should be displayed before it is automatically bumped off. If both the Minutes and Seconds are set to zero, then the orders must be manually bumped. 2.3.2.3. Sound on New Order The sound that will play when a new order is displayed on the screen can be selected. Figure 42: "Sound on - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 29
2.3.2.4. Summary Ticket Filter To indicate which items the summary ticket (located on the right side of the display) will display when orders are added to the system, the technician must specify items either by selecting a group or by checking individual items from the Menu List. This list - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 30
2.3.2.5. Menu Item Filter To indicate which items will display when orders are added to the system, the technician must specify items either by selecting a group or by checking individual items from the Menu List. This list references the Menu & Recipe list that must be created separately from Grid. - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 31
2.3.2.6. Ticket Manager A grid ticket must be selected so that the grid knows how to render the orders on the screen. These ticket definitions are created separately from grids, in the cases of kitchen and expeditor grids. When clicking on the button, a selection modal will be displayed, being able - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 32
To create a new Customer Ticket, navigate to the CUSTOMIZE tab, as shown in the figure below. Figure 50: Modal to customize and create Customer Facing Tickets. Under the font-size options, the customize option allows the user to range between the font size preset giving more freedom to choose as - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 33
Figure 52: Customer Ticket customize font size option. To edit a Customer Ticket, click the vertical three dot (kebab) button to open the actions menu and select edit. The CUSTOMIZE tab will be opened with the ticket data for further modifications. Figure 53: Customer Ticket menu actions. Form: F- - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 34
2.3.2.7. Grid Preview Preview of how the Grid will be displayed on the monitor. Figure 54: Preview of settings applied to Grid. Form: F-730-028 v1.00 Epson TrueOrder KDS KDS Configurator Page 34 of 67 111-56-URM-007 R4.34 Trademarks - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 35
2.3.2.8. Grid Options Figure 55: Actions options in Grid Menu. On the initial screen listing Grids already registered, you can access the Grid options menu, using the button. Among the action options, we have: Edit: Enters Grid's edit mode by adjusting the existing settings. You can also access the - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 36
2.3.3. Tickets Tickets specify how a display will render items on the screen. A user can create a ticket, and then reference that ticket in multiple grids to apply the look and feel of the ticket to the grid. This section describes some of the options that can be set for a ticket. Figure 56: - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 37
2.3.3.1. Create/Edit Ticket Figure 58: Form for configuring a ticket for a Kitchen Grid Name: Specifies a unique name of the ticket. Description: A user description of the ticket. This item is optional. Item Font Size: Font size that will be used for the ticket to display items. For bigger font - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 38
• Void Item - Color of the void item. • Alert - Color of the alert item such as allergies for example. • Appended Item - Color of the appended item. • Expeditor Bump Background - Expeditor Background Bumped Items. • Item Selection - Selected Item Color. For items Ticket Header Colors and Color - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 39
Figure 61: Kitchen Ticket customize font option. 2.3.3.2. Ticket Rendering The application will render all the changes for the ticket on the left side of the screen as they happen. The rendered screen can be put into New, Priority, Rush, and Recall modes to see the header colors for each mode. As - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 40
2.3.3.3. Ticket Options Figure 63: Actions options in Ticket Menu On the initial screen listing Tickets already registered, you can access the Ticket options menu, using the button. Among the action options, we have: Edit: Enters Ticket's edit mode by adjusting the existing settings. You can also - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 41
2.4. Menu & Recipes 2.4.1. Groups Group is used to help the user route the items to the appropriate KDS display/screen. For example, you can have the following groups: Wings, Drinks, and Pasta. When you set up your KDS environment you will be able to specify the group that the display will show. A - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 42
should be routed to which display. The list represents all the unique items sold at the location. At this time the list must be entered manually by the user and must be updated every time changes are made it. Figure 65: Menu Items page. Add Item: Use this command to add - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 43
• Item Name: This is a unique name that must match the item as it appears on the receipt. If this name does not match the item on the receipt precisely, the item may not route correctly onto the display. • Description: Optional description of the item. This can be a human-readable form name or - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 44
2.5. Application Settings 2.5.1. Site Wide Settings The site wide settings are used to name your business site, choose the parser target and other general settings to help the system function. Figure 66: Site Wide Settings Form. Form: F-730-028 v1.00 Epson TrueOrder KDS KDS Configurator Page 44 - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 45
67: Fields for General Configuration (Subsection of Site Wide Settings Form). Name: Give the name of the business location. Useful for identifying a particular site if troubleshooting is ever required. POS Type: Select the POS System that is to be used with the KDS. This tells the KDS which data to - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 46
It is possible to remove some POS Parser by selecting it and then clicking on the remove button or remove all by selecting the 'Select All' checkbox and then clicking in the remove button. To add a new POS Parser is necessary hit the choose the POS Parser file to upload. button that will show the - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 47
independent. It is only applied to the POS Menu Routing option. 2.5.1.2. Time Settings Figure 70: Site Wide Time Settings subsection. Time Zone: The system supports time zone settings. Choose your time zone and click "Set Time & Time Zone setting" in the Main Menu. This will update the master device - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 48
is some special processing done that allows non-ASCII characters to be added to the text. The following sequences are all supported: • \n - line feed • \t - tab • \v - vertical tab • \xnn - hexadecimal code • \0nnn - octal code • \\ - backslash • Any other character after the '\' will just be itself - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 49
Tile Header, Tile Footer: If not empty, this text will be printed on the printout for each order. Follow explanation above if ESC/POS commands need to be inserted to customize the look and feel of the text. Item Header, Item Footer: If not empty, this text will be printed on the printout for each of - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 50
2.5.2. Wizard When the Epson TrueOrder KDS Config web app is used for the first time a Wizard can help guide the user to do an initial discovery and setup of the KDS. The Wizard is available under the Application Settings tab. To find the devices, - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 51
devices. If your POS does not appear in the list, you will need to contact your Epson representative for information on how to get it supported. Form: F-730-028 v1.00 Figure 75: Wizard Load Configuration: Load configuration for the first time. Epson TrueOrder KDS KDS Configurator Page 51 of 67 - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 52
issues with POS's sending data to the right destination. Figure 76: Wizard Auto-detect when "Assign IP address automatically using DHCP service" is selected. Assign IP to my devices manually Use this option if you have a list of IPs that you wish to assign to each device. This option will take you - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 53
Figure 77: Wizard Auto detect page when "Assign IP address to my device manually" is selected. Do not configure IP settings for my devices Choose this option if you know your devices already have their correct IP addresses and - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 54
later. The operation of the wizard will then be complete. The starting point it has created can then be further tweaked and adapted manually. 2.5.2.2. From Other: Load configuration from the device on my local network This wizard option allows you to load a previously saved configuration file or - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 55
importing grid settings, menu items, and ticket designs from another system. In this case, only devices will need to be rediscovered and configured manually. 2.2.4.2.2.2. Device: Load configuration from the device on my local network This option is good for when your system is configured and working - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 56
Figure 82: Wizard Load configuration when the "Device: Load configuration from the device on my local network" option is selected. Figure 83: Wizard Load configuration when the "Device: Load configuration from the device on my local network" option is selected after searching for devices on the - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 57
Figure 84: Logos listing screen. 2.5.3.1. Add New Logo This option allows you to add a new logo image or store name to the system. After clicking the 'Add New Logo' card, you will be redirected to the registration screen. Figure 85: Logo register screen. Select Logo: Option that will open the file - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 58
Store Name: Name that will be used as the friendly name of the image, and if no image is selected, it will replace the logo. Kitchen/Expeditor Checkbox: Enables logo for kitchen/expeditor type of displays. Customer Facing Checkbox: Enables logo for customer facing type of displays. 2.5.3.2. Logo - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 59
below. This view can be accessed through Preferences -> Email Configuration. Figure 87: Form for basic email setup to receive by email system trouble and available update notification. When the Send Test Email button is clicked, a modal to insert a destination email is displayed. Form: F-730-028 - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 60
Figure 88: Modal to insert a destination email (by clicking the highlighted button). 2.6.1.2. Users For security reasons, only registered or admin users can log in to KDS Configuration Tool. The users can have passwords and access privileges assigned to them. This section explains how to create and - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 61
Figure 90: Export and import buttons, respectively. The left button is used to export. The right button is used to import. Add User: Use this command to add a new user to the user list. The name you add must be unique and can be changed later. Figure 91: Button to add a new user to the system. User - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 62
Password: The password can only be set if the user's email address was set. This is necessary if the user would want to recover the password later. Set Role: Add user role (each role has specific permissions to run on the system, previously defined by the master user of the system). Figure 93: Role - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 63
Figure 95: Displaying a specific user's configuration form. Edit User: When the Edit User button is clicked, the image below is going to be presented to edit an existent user with the required fields. Figure 96: Action button to edit user. Figure 97: Edit form for a specific user. Disable User: The - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 64
Figure 98: Confirmation modal to disable a user. 2.6.1.3. Role Roles allow you to specify access privileges to certain sections of the KDS Configuration Utility. By default, the application will have an "All Access" role that allows the default "admin" account to access the application. This role - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 65
Add Role Figure 101: Add Role Button. Use this command to create a new role by specifying the role name in the dialog box. The name of the new role must be unique. Once the role has been created it can be configured, and later applied to the users as needed. If all requirements are satisfied, the - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 66
ACTION: View Role: When the View Role button is clicked, the image below is going to be presented to display an existent user in the system. Figure 103: View Role button (highlighted). Figure 104: "View Role" page. Edit Role: When the Edit role button is clicked, the image below is going to be - Epson TrueOrder KDS | Epson TrueOrder KDS Configurator User Manual - Page 67
Delete Role: When the Delete Role button is clicked, a confirmation modal will be displayed. Figure 107: Delete Role button (highlighted). Figure 109: Delete Role modal. If the role is already associated with a user, an error message is displayed, making it impossible to delete that role. If the
Epson TrueOrder KDS
KDS Configurator
Page 1 of 67
111-56-URM-007
R4.34
Form: F-730-028 v1.00
About this Guide
This guide is a user manual for the KDS Configuration Utility AKA Configurator. The Configurator is
a web-based application that can be accessed by any device running a browser, such as a PC or a
tablet.
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-007
Epson TrueOrder KDS
KDS Configurator