Description: This article outlines how to install the SkyTab Order At The Table (OATT) Add on for Micros RES 3700.
Prerequisites
- Merchant has a Shift4 processing account and has been assigned to a Merchant ID Number (MID).
- Shift4 has provided SkyTab devices for the merchant. SkyTab devices are pre-configured with encryption.
- The merchant’s Oracle Hospitality RES 3700 POS system has been configured to be used with Shift4 using the same MID that is assigned to SkyTab devices.
- The merchant location has adequate Wi-Fi coverage in all areas of the restaurant/location where SkyTab will be used unless using 4G.
- Transaction Services must be a paid license by Oracle, installed and configured for ordering at the table (OATT).
- At the merchant location, ports 443 and 9080 must be open at all times to allow for secure Internet connectivity.
- A suitable Windows PC installed with .NET 4.5.1 or later in which to install this interface.
- Ordering enabled for the account location in Lighthouse Business Management System.
- For cloud logging to work, amazonaws.com should be added to the firewall rules. If the cloud logging option is turned on, and amazonaws.com is not whitelisted an error log for aws-logging will be created. During install, this should be verified as functioning to prevent the log file from growing too large over time.
Overview
SkyTab is a Shift4 PATT (Pay at the table) / SOATT (Skytab order at the table) solution that runs on a Shift4 PAX A930 payment device (the “SkyTab Device”) that interfaces to the merchant’s Oracle Hospitality RES 3700 POS system to create, fetch open checks and close out tickets.
SkyTab is an extension of Shift4’s PCI-Validated P2PE solution: There is no cardholder data that flows in, out, or stored in the Oracle Hospitality RES 3700 POS system. All payment transactions are handled by the SkyTab Device directly with the Shift4 payment processing platform.
SkyTab also comes with a subscription to Shift4’s Lighthouse Business Management (LH BMS) system which provides many different functionalities such as the customer engagement system that can send emails to customers using email addresses entered into SkyTab by each guest.
Definitions, Acronyms, Abbreviations
Lighthouse BMS or LH BMS |
Shift4’s business management system that is used by the Merchant for configuring default values for SkyTab (e.g. default tip percentages, upload logo, etc.) and includes built-in tools such as an email engagement platform which uses email addresses entered into SkyTab by the guest, social/reputation management and a plethora of reports. |
Merchant |
The Shift4 and Oracle customer (e.g. Joes Bar & Grill) |
MID |
Shift4 assigned merchant ID (uniquely differentiates all Merchants) |
OLO |
Online ordering |
PATT |
Acronym for pay at the table |
PAX A930 |
A Shift4-exclusive payment device manufactured by PAX has a built-in EMV reader, encrypting mag card reader, contactless reader, printer, and cameras. |
SkyTab |
Shift4’s guest-facing pay/order at the table application |
SOATT |
Acronym for SkyTab order at the table |
Titan |
A Shift4 information database tool that hosts merchant account information. |
Software Setup / Installation Overview
- Pre Installation Setup.
- Use the POS Configurator to configure the RES/3700 POS as appropriate.
- Run the installation file on the Interface PC.
- Use the “Manage Shift4 Skytab Service” program to set the parameters as appropriate.
- Start the Shift4_SkyTab_Service and test.
Pre-installation Set Up
1-A) Lighthouse Business Management System (LH BMS)
Before installation, verify that the location has Ordering enabled on Lighthouse BMS. To verify, follow the instructions below.
Shift4 Support:
- Navigate to the merchant’s Lighthouse BMS account.
- You can do this via Titan:
-
Select the
at the top of the Titan toolbar.
- Search for the account by using the MID, DBA, or Shift4 S/N.
- Once the account is found, double click on the account in the merchant search box, this will load the merchant’s account page.
-
- Once on the account’s page in Titan, navigate to the Web tab.
- Within the ‘Web’ tab, select Lighthouse.
- Select an email from the registered email list and select Login.
- You can do this via Titan:
- Now that the Lighthouse BMS web page is open, on the left menu, select Add on Devices.
- Scroll towards the bottom, there’s a section called Ordering.
- Verify that the ‘Enable Order at the Table Feature’ toggle is On.
- If changes were made, please make sure to save changes before exiting.
Dealer/Installer:
You will not have access to the above, please reach out to Shift4 support to confirm that the toggle is turned on for the merchant location.
1-B) Creating the Shift4 SkyTab Service Folder
When installing the SOATT application, it will have a designated folder under:
C:\MICROS\ProfessionalServices, this folder can sometimes be listed under the D:\ drive
If no Professional Services folder exists under the Micros section follow the instructions below to create one.
- Once in C:\MICROS right-click within the folder, navigate to ‘New’, and select Folder
- Rename the new folder to ‘ProfessionalServices’
- This folder will host the Shift4 SkyTab Service folder
- Within the ProfessionalServices folder, create a folder labeled Shift4SkyTabService
1-C) Pos Configurator Setup - SkyTab Tender Types
NOTE: For RES Version 5.1 or lower you will need to configure a second set of tenders for reporting as RES 5.1 and lower do not support PMS tender linking for SkyTab. |
NOTE: When OPI is used you will need to configure a second set of tenders for SkyTab payment reporting. |
NOTE: For RES Version 5.2 or higher You will need to add a Payment Tender for each card type accepted. These tenders will be identical (except for the names) and will be for non-zero payment amounts. If you are using the Shift4 Bridge Interface, then these should already be set. Do not add more and skip this step. |
Now return to the POS Configurator and select the Sales Tab, and then Tender/Media. Any settings not specifically spoken of should be disabled or unconfigured.
Add a new Tender Record by pressing the Blue Plus.
- General Tab > Type: Payment
- General Tab > SLU: [BLANK]
- General Tab > Print Class: Guest Check
- General Tab > Menu Level Class: All Levels
- General Tab > Privilege: 0
- General Tab > Category: 1
- Tender Tab > Charged Tip:
- In NON-OPI mode, link the tender(s) to the charge tips service charge, and set the option “Post to charge
receipts” on. - In OPI mode, DO NOT link the tender(s) to the charge tips service charge, and set the option “Post to charge receipts” off.
- In NON-OPI mode, link the tender(s) to the charge tips service charge, and set the option “Post to charge
- Tender Tab > Post To Gross Receipts: Enabled
- Tender Tab > Post To Charged Receipts: Enabled
- PMS Tab > Post 0.00 Amounts To PMS: Enabled
- PMS Tab > Allow 19 reference characters: Enabled
- PMS Tab > Property Management Interface:
- RES 5.1 or lower
- Do not link a property management system and leave blank
- RES 5.2 or higher
- If you are using the Bridge Adapter set this to (# Shift4)
- Service TTL Tab > Fire Order: Enabled
- Printing Tab > Print Summary Totals: Enabled
- Printing Tab > Print Check Trailer: Enabled
- Printing Tab > Print-Multiple Checks/Receipts: Enabled
- Printing Tab > Print Check: Enabled
- Printing Tab > Print Memo Check: Enabled
- Printing Tab > Reprint Check: Enabled
Save the Config when done by pressing the green checkmark.
Repeat this process for each card type you accept.
1-D) Pos Configurator Setup - API WebService Setup
- Click on the Devices Tab
- Select Devices. This opens the Device Screen
- Any settings not specifically spoken of should be disabled or unconfigured
Add a new Device Record by pressing the Blue Plus.
- You can name this record SKY TAB API
- In the General Tab ensure the following:
- Device Type = PosAPI WEB Service
- Network Node = The Micros Server Node
- In the General Tab ensure the following:
Press the Green Checkmark at the top when finished to save this setting.
- Navigate back to the Devices tab
- Select User Workstations. This opens the User Workstations Screen
- Any settings not specifically spoken of should be disabled or unconfigured
Add a new User Workstation Record by pressing the Blue Plus.
-
- Name this SKY TAB INTERFACE
- Select the SKY TAB API you set up in the previous step
- General Tab:
- Revenue Center: The revenue center that will be processing the payments
- Default Order Type: The order type
- Printers Tab:
- Make sure the printers are set to Journal - unless the merchant is using OLO, then leave the settings as is
Press the Green Checkmark at the top when finished to save this setting.
1-E) SkyTab Tip Service Charge (RES OPI Mode only)
Now return to the POS Configurator and select the Sales tab and select Service Charges. Any settings not specifically spoken of should be disabled or unconfigured.
Add a Service Charge This should be named SkyTabTips and configured as follows:
- General Tab > Tax Class: No Tax
- General Tab > SLU: Blank\Disabled
- General Tab > Print Class: (always print to the Journal, Reports, and guest checks/receipts.)
- General Tab > Menu Level Class: All Levels
- Options Tab > Amount: Enabled
- Options Tab > Reference Required: Enabled
- Service Charge Tab > Type: Standard
- Service Charge Tab > Post to tips paid total: Enabled
Press the Green Checkmark at the top when finished to save this setting.
1-F) SkyTab Menu Item (Only if using the Bridge Adapter)
Now return to the POS Configurator and select the Sales Tab and Select Menu Item Classes.
Add a Class This should be named $0.00 / REF and configured as follows. Any settings not specifically spoken of should be disabled or unconfigured.
- Description Tab > Sales Itemizer: Food
- Description Tab > Tax Class: No Tax
- Description Tab > Discount Itemizer: 1
- Description Tab > Print Group: 3-
- Description Tab > Service Itemizer: 1
- The below Description Tab setup is suggested (but it may vary by location/system)
- General Options Tab > Retail Items: Enabled
- General Options Tab > Reference Required: Enabled
- Price/Totals Tab > Preset Prices: Enabled
Save the Config when done by pressing the green checkmark.
Now return to the POS Configurator on the Sales tab and select Menu Item.
NOTE: SkyTab Transaction ID Number (TrID) - For use when NOT In OPI Mode, the object number of the menu item in Configurator will be used to store the SkyTab Invoice number in reference. If using OPI skip this step. |
Add an Item This should be named SkyTab TrID and configured as follows. Any settings not specifically spoken of should be disabled or unconfigured.
- Description Tab > Name1: SkyTab TrID
- Description Tab > Menu Item Class: (# $0.00 / REF)
- Description Tab > Menu Level Class: All Levels
- Description Tab > Print Class: Guest Check
- Description Tab > SLU: [BLANK]
- Reporting Tab > Major Group: Misc & Llaneous
- General Options Tab > Family Group: Appetizers
- Prices Tab > Fixed Pricing: Set All Price(s) to 0.00
Save the Config when done by pressing the green checkmark.
Installation
2-A) Setting up the SkyTab folder
- Download the Shift4 SkyTab Service file folder, it will appear as:
- Shift4_Skytab_Service_vX.X.X.X
- Once the folder is downloaded onto the interface computer, it will need to be extracted into the ProfessionalServices > Shift4SkyTabService folder created previously
- To extract the folder, right-click on the zip file
- Select Extract All
- On the window pop up, select Browse
Set the destination folder to C:\MICROS\ProfessionalServices\Shift4SkyTabService
- Once set, select Extract
- Verify that the files did extract correctly in the folder, you will see:
- Bin folder
- Install Shift4 Service
- Log4net.config
- Manage Shift4 SkyTab Service
- Shift4_SkyTab_Service.exe
- Shift4_SkyTab_Service.exe.config
- Uninstall Shift4 Service
2-B) Installing the Service
- Navigate to C:\MICROS\ProfessionalServices\Shift4SkyTabService and double-click Install Shift4 Service
- A window will pop and ask to enter the desired service name, do not change it unless installing multiple instances on the same service host, and select OK
- Verify the service installed by opening Services
- Open up the Windows start menu, enter Run
- In the Open: section type in services.msc and select OK
- This will bring up the Services window Shift4SkytabService
- If installed correctly you will see the following:
- If the service did not install correctly there will be a service installation log file with details in the Shift4SkyTabService folder
- Shift4_Skytab_Service.InstallLog
- If system configuration prevents successful install, the installation command can be run in administrator command prompt from working directory “Shift4_Skytab_Service --install”
-
- Open up a command prompt in Windows
- Using the Run dialog box, which you can open using the keyboard shortcut Win + R, allows you to open any Windows program by entering its name. Enter cmd and click OK to open a command prompt. Hold down the Shift and Ctrl keys and click the OK button to run the command prompt as an Administrator. You will need to confirm the prompt from the User Account Control
- Alternatively, you can search command prompt by typing cmd in the Windows search option, right-click and select Run as administrator
- Open up a command prompt in Windows
-
-
- Once the administration command prompt is open in Windows, open the file directory
- To open the file directory, enter cd and the file path
- See example below
- Once the administration command prompt is open in Windows, open the file directory
- Once the file path is open, enter the Shift4_Skytab_Service, install and then enter
-
-
- This will prompt the install to complete via the command line
-
-
- Once installed, do not start the service, move on to the next section
2-C) Setting up the Manage Shift4 SkyTab Service
- In the C:\MICROS\ProfessionalServices\Shift4SkyTabService folder, there’s an exe labeled ‘Manage Shift4 SkyTab Service’ double-click it to open the program
Setting up the POS Product Line
- Navigate to the POS Product Line Tab
- Verify that the software is set to RES_3700, then select Save Settings
Setting up the Azure Relay Configuration
- Once the Manage Shift4 SkyTab Service program is open, navigate to the Azure Relay Configuration Setup tab
- Azure Relay Configuration:
- Client Key - This will be where the Service Key Value is entered from the SkyTab setup sheet
- Client Key Name - This is labeled as the Service Key Name on the SkyTab setup sheet.
- Azure Relay Name - This is labeled as the Azure Service Path on the SkyTab setup sheet.
- Azure Service Namespace - This is labeled as the Azure Service Namespace on the SkyTab setup sheet as well
- Once the information is entered, be sure to save it by selecting the save settings button before moving on to the next section
- Azure Relay Configuration:
Setting up the Logging Options section
- Navigate the Logging Options tab
- Once on the Logging Options tab, be sure to check ✔ Enable Cloud Logging
- Fill out the following:
- Location Identifier: Merchant’s MID
- Region: us-east-1
- logGroup: /skytab/isv/micros
- Cloud Watch Access Key: AKIAZLLOBF24KLQVOOYR
- Cloud Watch Access Secret: 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
- Leave the dropdown as ‘Debug’
- Once the sections are filled out, save settings and move on to the next tab setup
Setting up the RES Database Configuration
- Navigate to the RES Database Configuration tab
- A DBISQL user and password are required with at least read access. Typically custom / custom
- Fill out the following:
- Database User Name: custom
- Database Password: custom
- Database Name: micros
- Once completed, save settings and move on to the next section
Setting up the SkyTab Configuration Setup
- Navigate to the SkyTab Configuration Setup tab
- Verify that the following is checked
- ✔ Enable Skytab Staff Order at the Table
- ✔ Enable Skytab Pay at the Table
- Allow View All Checks is optional
- Allow My Checks view to display paid checks is optional
- Transactions services URL for RES by default set to:
- http://127.0.0.1/ResPosApiWeb/ResPosApiWeb.asmx
- Default RVC - (Required) This option determines which RVC will be used when querying employees or available RVC’s
- Default Employee ID -(Required) This ID will be used when querying other employees or available RVC’s from Transaction Services
- Menu Department Grouping - This value allows different presentations of the menu based on how the menu was originally built. Suggestions based on priority for RES 3700 are FAMILYGROUPS, SLUGROUPS, SLUS. Changing this value requires a service restart, followed by the SkyTab device being rebooted for the menu presentation to be updated
NOTE: Special Prep Menu Item Object Number - Current limitation on RES, do not use this approach. The special prep will be added as a reference to the parent item. |
- Allow View All Checks - This allows all employees access to the ‘all checks’ tab in the application
- Active Main Menu Level - Should all be set to active menu level used on the POS. This is used to limit the menu data that is pulled into SkyTab. If all levels are checked, all items from any level will be available
Only set up the following if using OPI:
- Enable OPI Support - This NEEDS to be enabled to change the transaction services API to send OPI compatible payments
- OPI Service Charge number - In order to apply tips to OPI enabled systems, the service charge must be identified in the transaction services call and provided here. This will be the service charge set up in section 1-E of the guide
- Allow employee sign In via magstripe reader (this needs to be enabled on each A930 device by special request, email IG@shift4.com)
- Hide menu items that are marked Workstation Only - This option allows the menu items in the POS Configurator marked with workstation only option bit to be omitted in the menu provided to the SkyTab device. This requires a restart of the service followed by rebooting the SkyTab for the change to pick up
- Do not present 86’d items on SkyTab Menu - This option allows 86’d items to be omitted in the menu provided to the SkyTab device. This requires a restart of the service followed by rebooting the SkyTab for the change to pick up
- Use Name 2 as priority on SkyTab display - Enable this option but use alternative name as priority on the SkyTab display
- Show Closed checks in view all checks lookup - This is an enhancement to allow tip verification from staffu
- Hide Open Checks on the view all checks lookup -This is a preventive measure to prevent staff from applying payment to other staff checks
Tender Media
- SEND - Send and Stay Tender: (Record number from RES POS Configurator..)
- PRINT - Print Tender: (Record number from RES POS Configurator.)
- SKYTAB_DEFAULT_TMED - This option is used when a tender that was used for payment was not defined in the interface setup under tender media mappings. It’s recommended to make a copy of the Shift4 Visa tender, rename that copy to ‘SkyTab Def’ and set it in the tender media mapping for Skytab default tmed. It does not need to be set up but is highly recommended.
- AMEX - Shift4 Amex: (Record number from RES POS Configurator.)
- VISA - Shift4 Visa: (Record number from RES POS Configurator.)
- JCB - (Record number from RES POS Configurator.)
- MASTERCARD - Shift4 MC: (Record number from RES POS Configurator.)
- DISCOVER - Shift4 DC (Record number from RES POS Configurator.)
- Other Accepted Tender Types: (Record number from RES POS Configurator.)
NOTE: If a value is not defined in the tender media settings for a certain tender, it will default to SkyTab_Default_Tmed. |
Once all required sections are completed, save settings.
Advanced Settings (Optional)
NOTE: All settings on this tab are optional. |
- Enable reorder logic - This will allow the reorder logic to be leveraged. Due to Transaction Services limitations, this is only currently supported for res 3700 when building checks from the database instead of Transaction Services
- 3700 Skytab Payment Reference Object -In order to Support RES 3700 Bridge Voids against SkyTab driven payments, the invoice number needs to be saved to the check in a way that the bridge can identify the invoice number. This would be the SkyTab TrID created in section 1-F of the guide
- Build checks from database - This item will bypass the Transaction Services representation of the check view built from the database transaction view. This setting will not update checks built from transaction services and currently cached. A service total against any check will update the view to the database generated view on the next pull from the SkyTab device
- Enable dynamic Slu Filter
- Enable dynamic Table Filter
- Enable Price definition Validation on Menu/Condiment Items
Printer Overrides - Order Type Filtering Setup (Optional)
This option is mainly used for merchants who share the API Web service with OLO (Online Ordering) + SkyTab. When merchants have OLO set up, the API Web Service is generally set to physical printers. For SkyTab, the printers need to be set to journal to avoid printouts every time the SkyTab device is refreshed to pull checks. The Order Type Filtering allows the SkyTab to filter the checks through the Order Type set up with a journal printer. Please see below for more details.
- RVC Object Number: The number of the RVC
- This can be found in the Revenue Center section in POS Config
- RVC Name: Name of the revenue center
- Change to Order Type: Order type number set up
Order Type Filtering: When the Order Type is set in the Printer Override section of the Shift4 SkyTab Service Settings, for each check to be retrieved, SkyTab will change the order type of the check, then print it, then change the order type back to its original state.
This allows SkyTab to use the settings in the Order Type to override the printer being used in the API Web Service. Normally, SkyTab will generate check details (from printed checks) and apply payments using the Order Type of the check. However, if you want to do these functions using a different order type, then you set that in the Printer Override tab. In that case, SkyTab will do the following:
- Printing checks to get details information:
- For each check to be retrieved, SkyTab will change the order type of the check, then print it, then change the order type back to its original state
- Applying payments:
- SkyTab will change the order type of the check when it applies for the payment
The main reason to do this is to apply an order-type print mask.
Example: If SkyTab causes checks to print when you don’t want it to, or SkyTab causes order chits to print all the time, then you can change or disable printers based on a specific order type. For example, you could set Order Type 4 to use a Workstation with a File Printer (Journal) for all output. Then, set the Change To Order Type to be 4. SkyTab will then change the checks into Order Type 4 whenever it accesses them, and return them to the original order type when done.
To set up the Order Type Override please see: Setting up an Order Type in Micros RES 3700
Save Settings - Pop-ups
When saving settings, a pop up will appear with the following information (above is an example only):
- Breaking:
- Breaking information needs to be filled out by default, if this pops up when saving settings before completion, verify settings are set and then continue
- Warn:
- Warn information is not necessary to be filled out but will send through as a message if not filled out correctly or left blank. If the information under the Warn section is not relevant to what the site needs to have set up, move on to the next section
- Info:
- Info will provide information regarding the SkyTab service application
Start the SkyTab service to begin usage
Start the service by following the steps below:
-
- Open up the Windows start menu, enter Run.
- In the Open: section type in services.msc and select OK. This will bring up the services window.
- Select the Shift4_SkyTab_Service.
- Select Start.
UNINSTALLING
In the event you need to uninstall the Shift4 OATT Skytab application do the following:
With the OATT interface there is an uninstall service file within the "Shift4 SkyTab Interface" that is added during the initial install - if after running this file the "Shift4_Skytab_Service" still exists under local services open command prompt as admin and run the following command
sc delete Shift4_Skytab_Service
After running this command refresh the local services and confirm if the service has been removed. Once its removed you can proceed with rebooting the server and install/reinstall the interface service.