skyward web based food service skyserial install …...02.27.2020 page 7 of 23 installing skyserial...

Skyward Web Based Food Service

SkySerial Install Guide

_________________________________________________________________________________________________________

_________________________________________________________________________________________________________

02.27.2020 www.skyward.com of 23

Table of Contents

GENERAL INFORMATION ........................................................................................................................................................... 3

WHAT IS SKYSERIAL? ...................................................................................................................................................................... 3 WHAT IS NEEDED TO USE SKYSERIAL? ............................................................................................................................................. 3 WHAT IS INCLUDED IN SKYSERIAL? ................................................................................................................................................. 3 HOW DOES SKYSERIAL PROCESS? ................................................................................................................................................... 3 HOW DO YOU UPGRADE TO SKYSERIAL V3? ..................................................................................................................................... 3

UNINSTALL OLDER VERSION OF SKYSERIAL PRIOR TO INSTALLING NEWER VERSION .................................... 4

INSTALLING SKYSERIAL V3 ....................................................................................................................................................... 7

SUPPORTED WEB BROWSERS .................................................................................................................................................. 12

REQUIRED WEB BROWSER CONFIGURATION ................................................................................................................... 12

INTERNET EXPLORER SECURITY SETTINGS .................................................................................................................................... 12 FIREFOX SECURITY EXCEPTION SETTINGS ..................................................................................................................................... 13 MICROSOFT EDGE ENABLE INTRANET SETTING TO ALLOW USE OF LOCALHOST ............................................................................. 15 CHROME 58 OR HIGHER SET PRIVACY SETTING FOR LOCALHOST .................................................................................................... 16

TESTING THE FOOD SERVICE KEYPAD(S) ........................................................................................................................... 17

SMS 2.0 ......................................................................................................................................................................................... 17

ADDING A CASH DRAWER. ....................................................................................................................................................... 21

SMS 2.0 ......................................................................................................................................................................................... 21

http://www.skyward.com/

_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


General Information What is SkySerial?

• SkySerial allows the Skyward Web Food Service to communicate with the local workstation’s

COM Port(s).

• SkySerial is not required when a single keypad is connected to the workstation as a Human

Interface Device (HID, aka keyboard or mouse) and queuing is not used.

• SkySerial Version History

o SkySerial v2 was introduced with the February 2012 Release Addendum 8.

o SkySerial v3 is available with October 2016 Release and supports the Chrome,

Microsoft Edge, Firefox, and Internet Explorer Web browsers.

o SkySerial v3.x includes several updates to support TLS 1.2 and to correct some port

issues found with specific workstations.

What is needed to use SkySerial?

• A USB Virtual COM or Serial device(s) connected to the workstation.

• Includes Microsoft Full Versions of .NET Framework 4 or 4.5+

• Windows Only Plug-in and is supported on Windows 7 or newer (32-bit and 64-bit)

What is included in SkySerial?

• Includes a Workstation Client named SkySerial.exe and a Windows Service named

SkySerial.Service.exe

How Does SkySerial Process?

• SkySerial will run a small web service on the User’s computer at the port specified by the

configuration option, SkySerial.Proxy.WIAProxy.

• When the web service receives specific requests from the Skyward Web Food Service purchase it

reads the input on the keypad and delivers the result of that read back to the Skyward Web product.

How do you upgrade to SkySerial v3?

1. Uninstall the SkySerial older clients on all Food Service POS workstations.

2. Install the SkySerial current Client on all Food Service POS workstations.

3. Test the Keypads


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Uninstall Older version of SkySerial prior to installing newer version

Notes:

• The local administrator of the workstation needs to be logged in to the workstation for a successful

uninstall.

1. Navigate to Control Panel on the local workstation

2. Click Programs and Features

3. Highlight Skyward SkySerial Food Service Client in the Program list. Click Uninstall at the top of

the listing.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


4. Choose Next.

5. If you receive the following Notice choose Ignore (after waiting a moment). The uninstall process is

stopping the Client and the Services and in some situations that takes longer than expected.

6. Choose Finish.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


7. Delete the C:\skyward\skyserial folder if it still exists after the uninstall process completes.

8. Reboot the workstation.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Installing SkySerial v3

Notes:

• Log into workstation as the local administrator of the workstation for a successful install process.

1. Navigate to SMS 2.0 Web Student\Food Service\Product Setup\Configuration\Keypads

(WS\FS\PS\CF\KP) – Test Key Pads and choose the Download HTTPS SkySerial button.

2. Save the ‘SkySerial v3 Workstation Install.exe’ to the workstation where the device(s) is/are

connected.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


3. Double click SkySerial v3 Workstation Install.exe. → Next.

4. The Installation Drive window displays → Choose the local drive letter of the workstation → The

Browse button will indicate what drive letters are available on this workstation → Next.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


5. The Ready to Install window will display → Next.

6. An Installing SkySerial status screen will display. → The Install will detect 32-bit or 64-bit OS.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


7. If .Net Framework 4.0 needs to be installed, that status screen will display.

8. Once the SkySerial Client software has been installed the Installation Successful screen will display

→ Click Finish.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


9. A setup log file has been created in the ?:\skyward\SkySerial folder on each workstation that the

Skyward SkySerial Install.exe is run on. The log file name is SkySerial Setup.Log. → SkySerial.exe is

started and will be displayed in the Task Bar.

10. The install automatically adds the SkySerial.exe application to the Run registry key so it will start at

Startup of the workstation.

Note:

• HKML\Software\Microsoft\Windows\Current Version\Run or

HKLM\Software\Wow6432Node\Microsoft\Windows\CurrentVersion\Run keys are adjusted.

11. The install creates a Windows Service named SkySerial.Service.exe and sets it to automatically start

using Local System as the Log On account.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Supported Web Browsers

• Google Chrome, Mozilla Firefox, Internet Explorer, Microsoft Edge are compatible with

SkySerial v3 when properly configured using the required web browser configuration.

• Please contact Skyward IT Services at 1.800.236.0001 to ask for assistance, if needed.

Required Web Browser Configuration

Internet Explorer Security Settings

1. Open Internet Explorer and go to Tools → Internet Options → Security tab → Trusted sites →

Sites button


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


2. In Add this website to the zone: field, type https://localhost → Add button → Close.

Note: You can remove http://localhost if this is an upgrade to SkySerial Client v3.

Firefox Security Exception Settings

1. Open Firefox → In Address bar add https://localhost:3001/test → This should return a “Test

Successful” message. If the Test is successful you are done with this section.

2. If the test was NOT successful, a page like the one below will display.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


3. Add the site as a permanent exception → Choose Advanced → Add Exception.

4. Add security exception → Edit Location field to https://localhost:3001 → Click Get Certificate →

Check box labeled Permanently store this exception → Choose Confirm Security Exception → Test

successful should now display.

5. Test successful should now display.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Microsoft Edge enable Intranet setting to allow use of localhost

1. Open a command window as a local administrator. → Search for Command on local workstation →

Right click and Run as Administrator.

2. Type CheckNetIsolation LoopbackExempt -a -n=”Microsoft.MicrosoftEdge_8wekyb3d8bbwe” at the

command prompt → Enter

3. An ‘OK’ result will display. Edge browser does not need to be restarted and now allows use of

https://localhost


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Chrome 58 or higher set Privacy setting for localhost

1. Start Chrome → Type https://localhost:3002/test in address bar → Enter

2. A page will display stating the connection is not private. → Click Advanced on bottom left corner of

page.

3. Choose Proceed to localhost (unsafe) link at bottom left corner of page.

4. A Test Successful message will display once localhost has been updated to trusted sites in Chrome.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Testing the Food Service Keypad(s)

SMS 2.0

• Verify SkySerial v3 is started. It will be running in the System Tray on the workstation.

• There will also be a Windows Service named SkySerial. It should be in Started status.

• Verify that the physical COM port keypads(s) is/are properly installed on the workstation.

1. Log into SMS 2.0 Web URL and navigate to WS\FS\PS\CF\KP – Test Keypad.

2. Configure Entry Method → Edit the Host: field to display https://localhost:3001 → Save.

3. Configure Entry Method → Check Use customer queue if using queuing for single keypad or dual

keypad → Check Use dual keypads if two keypads are installed on workstation → Check both checkboxes

if two keypads are installed on workstation and using queuing.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


4. If one keypad is installed and customer queue is enabled, you will Configure Key Pad 1 → Key Pad

Type: Other or Genovation → COM Port: Check Device Manager to see what COM Port is assigned and

choose it→ Click Connect button to test communication to the device → Successful communication will

display 200: Connected to Device → Choose Save once Connected to Device is displayed

5. If Use dual keypads checkbox is checked, the screen below will display → Choose the settings for the

two keypads → Click Connect button to test communication to each keypad → When keypads display

Connected to Device, choose Save.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


6. Once one/two keypads has status of being connected, key in numbers and press Enter on device to

view that the software is reading entries from the installed device.

7. If Use Customer Queue was checked, the screen will display as below.


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


8. To further test, choose Connect and Read button → This will verify that the Save button was chosen

on the previous screen and that you are now able to use keypad(s) and/or Customer Queue in Web Food

Service → Once Connected and Ready to Read, enter numbers from keypad(s).


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


Adding a Cash Drawer.

SMS 2.0

NOTE: This set of instructions are based on having the Cash Drawer connected to workstation and setup as

a virtual serial device.

1. Open Device Manager → Right Click My Computer → Choose Manage → Click + by System

Tools → Click Device Manager → + by Ports (COM & LPT) → Note the COM port number (COMn) for

the MMF Virtual COM Port

2. Navigate to WS\FS\PU\PO → Choose the Configure button


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


3. Check the Use Cash Drawer checkbox found in the lower section of page.

• Note: Accept Payments checkbox needs to be checked prior to being able to see Use Cash Drawer.

• Payment Options section as shown below is available February 2017 Add 12 / June 2017 Add 3.

4. Edit the Host: field to display https://localhost:3001

5. Select the correct COM Port number as noted from Device Manager. → Click OK


_________________________________________________________________________________________________________

_________________________________________________________________________________________________________


6. Choose the Configure button to reopen the screen → the Status will have changed from Not

Connected to READY → Once in READY mode, choose the Open Drawer link to test communication

between the Cash Drawer and Skyward software.


skyward web based food service skyserial install …...02.27.2020 page 7 of 23 installing skyserial...

Documents