The KDS uses ODataV4 to connect to the KDS Web Service in LS Central when it is not running as SaaS (on-premises).
Use the KDS Utility to configure the connection:
- Start the KDS Utility by double-clicking the desktop shortcut, or locate it in the Start Menu, or, as a third option, locate the application file C:\Program Files\LS Retail\Kitchen Service\LS KDS Utility.exe and double-click it.
- Start by setting the KDS Data Provider field to S2S OData OnPrem. Only the necessary fields for connecting to the Web Service are then shown.
If you are configuring for the first time, the window will look like this:
If not, the fields are populated with the data from the Kitchen Service configuration file.
There are two ways to populate the fields:
- Fill in the fields with the correct data and the URL will be built up from that information.
- Copy the JSON string from LS Central, and paste it into the WS Info field. The other fields will be filled with the information from the URL string.
The correct URL can be located in the Kitchen Service configuration in LS Central.
Fields to be set are:
Server Computer name This is the host name of the server where the LS Central service tier runs. Company Name The name of the Company in LS Central. Service Tier The name of the BC service tier. Usually the value is BC. WebService Name The name of the KDS Web Service in the Web Services list. The default value is KDSodataAPI. Port No This is the port number which the Web Service listens on. This is usually 7048 for OData, but can be different depending on how the BC service tier is configured. Client/Protocol Type The method to access the KDS WebService. ODataV4 (REST) is default. Domain name If applicable, set the user's domain name here. Username User which logs on to the Web Service Password Password for the Web Service user if a user name is set. Restaurants filter Use this to specify from which restaurant the Kitchen Service should fetch KOTs (orders). If nothing is specified, the KOTs from all KDS-enabled restaurants are retrieved when they are created. If only one restaurant is in use, you can leave the field empty.
This setting is useful in the Cloud/SaaS environment. If there are more than one restaurant in use per company and they are in different locations, the Kitchen Service, in each location, can filter on the corresponding restaurant. This is also applicable if LS Central is on one central server and more than one restaurant are connecting to it.Note: This setting is stored locally per Kitchen Service and not in the Kitchen Service Configuration page in the Business Central.
WS info The information from the JSON field in the Kitchen Service configuration page in the Hospitality system. Copy the string from BC and paste it into this field and the rest of the fields will be populated. Except for the password field and the port number, which you will have to set manually. - If changes have been made, click Get Config in the top menu to save the Kitchen Service configuration.
The configuration will be saved in the file C:\ProgramData\LS Retail\Kitchen\KitchenServiceConfig.config.
The utility then tries to connect to the KDS Web Service, and if it is successful, it will show a dialog window with some of the information from the web service. - Restart the Kitchen Service, either by selecting Restart Service from the Manage Service menu item, or by starting Windows Services (Services.msc) and restarting it there.
- There are two other options in the Manage Service menu item:
- Refresh Service tells the Kitchen Service to fetch the configuration from the web service without restarting the Kitchen Service. This is useful when the configuration of the KDS is changed in the back office.
- Restart all Displays tells the Kitchen Service to turn off all connected Display Stations and restart them.
Note: If there are errors, you can examine the KDS Utility Log by clicking Logs in the top menu and then Show Utility Log. The log file opens in Notepad.
Tip: You can also open the last Kitchen Service log file by clicking Logs in the top menu and then Show KS Log. This will open the log file in Notepad.