Description: Install this software and license the QRExtension Extension to add one feature to a RES 3700 system.
Prerequisites
- Access to the Lighthouse Business Manager portal (LHBMS)
- SkyTab Interface (See Skytab interface requirement) - Section 6
- Compatible IP / Serial Printer
- RES 3700
Compatibility
IP printing - Section 2
Software:
- RES 3700 5.4 and below
Validated Hardware:
- Epson TM88 V5 - IP
- EpsonTM88 V4 - IP
- Epson M30 -IP
- Epson T-20 - IP
SIM Printing - Section 3
Software:
- RES 3700 5.5+
Validated Hardware:
- Epson TM88 V5 - IP / Serial
- EpsonTM88 V4 - IP / Serial
- Epson M30 -IP / Serial
- Epson T-20 - IP / Serial
Overview
https://myportal.shift4.com/downloads/resqrextension.zip
- Installation of this QR Code Extension adds a new feature to the RES 3700 system.
- It allows the ability to print QR Codes to Printers.
- The configuration settings are in JSON format that will be modifiable in a central location on the interface server.
- A QRCodeIntermediary service is installed onto the system.
1. Retrieving the QR Code URL from Lighthouse Business Management System (LHBMS)
- Login to LH BMS.
- Select Marketplace on the left sidebar menu.
- Navigate to the QR Pay application.
- Select the View Details button.
- This brings up the QR Pay Application screen.
- Select Install.
- Select Allow.
- Once completed, the QR Code and Payment URL will display on the QR Pay App page.
Note: These two items are specific to the MID they are created on |
- Select Copy URL, save this in a notepad, it will be used in step 2 of the installation.
2. Installation for IP printing RES 5.4 and below
1 Zip file folder will be provided for installation
- QRPay_3700v3.0.0.1
Creating the QR Extension Folder
- Use the Windows start menu to access the C: drive of the PC.
- Navigate to C:\ (or D:\ If the D:\ drive was used).
- Select the Micros folder.
- Within the Micros folder, create a folder called ‘ProfessionalServices’.
- In that folder create a second folder named ‘QRCodeIntermediary’.
- Unzip the provided released version into.
- C:\MICROS\ProfessionalServices\QRCodeIntermediary.
POS Configurator Setup
- Open POS Configurator.
- Navigate to the Devices tab, select Interfaces.
- Create a new Interface.
- General Tab:
- Name: QRIntermediary
- Network Node: IP address of the Server
- Number ID Digits: 9
- Log Transactions: Select yes
- SIM Interface: Select yes
- Interface Type: TCP
- Timeout: 30
- Interface Tab:
- TCP Server Name: IP of the Server, 127.0.0.1 (This NEEDS to match the IP set in the Settings.param file).
- TCP Port Number: Hosting port of the interface, use 5009 if not in use (This NEEDS to match the port set in the Settings.param file).
- Select the green checkmark to save.
- General Tab:
- Navigate to the System tab > Macros.
- Create a new Macro named QRHeader.
- Create two Macro keys.
- SIM/PMS Inquiremediary
- Interface: QRInter
- Inquire number: 1
- Tender/Media Number
- Select the Print Tender media record number.
- Select the green checkmark to save.
- SIM/PMS Inquiremediary
- Navigate to Devices > TouchScreen Designer.
- Select the Manager screen
- Add a button
- Name: DefineQRMacro
- Category: SIM/PMS Inquire
- Interface: QRIntermediary
- Inquire #: 8
NOTE: While the QR Macro will be defined on OPS startup, if the printer stops printing the QR code for any reason or you update the QR value in the settings, you can use this button to reconfigure it on the printer without having to restart ops on the workstation. |
- If needed, you can print the QRCode chit on demand using the following button
definition.- Create a new button
- Name: Print QR
- Category: SIM/PMS Inquire
- Interface: QRIntermediary
- Inquire Number: 9
- Create a new button
- To demo on-demand printing using SIM, for potential trailer use, add the following button.
- Operator is currently required to press the feed button after using this Touchscreen button.
- Name: SIM QR Code
- Category: SIM/PMS Inquire
- Interface: QRIntermediary
- Inquire Number: 11
- Operator is currently required to press the feed button after using this Touchscreen button.
- Replace the POS Print buttons with the macro button previously defined on touchscreens as needed.
- Once completed, save and reload the database.
NOTE: Amount Due must be greater than 0 to print a QR Code, otherwise these buttons will act identically to the print buttons. |
Transferring the SIM file
- Navigate to C:\MICROS\ProfessionalServices\QRIntermediaryV2.2.0.Release\
- Copy the ‘pms.isl.QRIntermediaryv2.2.encrypted’ and rename pmsX.isl, X = the interface number that’s assigned to QRIntermediary in POS configurator.
- Example: pms6.isl
- Copy the ‘pms.isl.QRIntermediaryv2.2.encrypted’ and rename pmsX.isl, X = the interface number that’s assigned to QRIntermediary in POS configurator.
- Copy the ISL file to the following folders:
- ...\MICROS\Res\Pos\Etc\...
- ...\MICROS\Res\CAL\WS5A\Files\CF\Micros\Etc\...
- ...\MICROS\Res\CAL\WS5\Files\CF\Micros\Etc\...
- ...\MICROS\Res\CAL\WS4LX\Files\CF\Micros\Etc\...
- ...\MICROS\Res\CAL\WS4\Files\CF\Micros\Etc\...
- ...\MICROS\Res\CAL\Win32\Files\Micros\Res\Pos\Etc\...
3. Installation for SIM Printing RES 5.5+
1 Zip file folder will be provided for installation
- QRPay_3700v3.0.0.1
Creating the QR Extension Folder
- Use the windows start menu to access the C: Drive of the PC
- Navigate to C:\ (or D:\ If the D:\ drive was used)
- Select the Micros folder
- Within the Micros folder, create a folder called ‘ProfessionalServices’
- In that folder create a second folder named ‘QRCodeIntermediary’
- Unzip the provided released version into -
- C:\MICROS\ProfessionalServices\QRCodeIntermediary
POS Configurator Setup
- Open POS Configurator
- Navigate to the Devices tab, select Interfaces
- Create a new Interface
- General Tab:
- Name: QRIntermediary
- Network Node: IP address of the Server
- Number ID Digits: 9
- Log Transactions: Select yes
- SIM Interface: Select yes
- Interface Type: TCP
- Timeout: 30
- Interface Tab:
- TCP Server Name: IP of the Server, 127.0.0.1 (This NEEDS to match the IP set in the Settings.param file)
- TCP Port Number: Hosting port of the interface, use 5009 if not in use (This NEEDS to match the port set in the Settings.param file)
- Select the green checkmark to save
- General Tab:
Transferring the SIM file
- Navigate to C:\MICROS\ProfessionalServices\QRIntermediaryV2.2.0.Release\
- Copy the ‘pms.isl.QRIntermediaryv2.2.encrypted’ and rename pmsX.isl, X = the interface number that’s assigned to QRIntermediary in POS configurator.
- Example: pms6.isl
- Copy the ‘pms.isl.QRIntermediaryv2.2.encrypted’ and rename pmsX.isl, X = the interface number that’s assigned to QRIntermediary in POS configurator.
- Copy the ISL file to the following folders:
- ...\MICROS\Res\Pos\Etc\...
- ...\MICROS\Res\CAL\WS5A\Files\CF\Micros\Etc\...
- ...\MICROS\Res\CAL\WS5\Files\CF\Micros\Etc\...
- ...\MICROS\Res\CAL\WS4LX\Files\CF\Micros\Etc\...
- ...\MICROS\Res\CAL\WS4\Files\CF\Micros\Etc\...
- ...\MICROS\Res\CAL\Win32\Files\Micros\Res\Pos\Etc\...
Setting and Creating QR code Trailer:
- Open POS Configurator and select the Revenue Center tab > RVC Print Design.
- Once in RVC Print Design, navigate to the trailers tab
- Click on the yellow folder to open up trailer descriptors
- Enter @@QRCode in the trailer
- Recommend to use line 5 for spacing
NOTE: Make sure that you are adding the @@QRCode to the guest check/customer receipt trailers that are set in the RVC Print Design Trailer tab. See below. |
- Save by selecting the green checkmark.
4. Settings Setup: QRCodeExtensionSettingsManager.exe
- Navigate to the QRCodeIntermediary folder
- Open the QRCodeExtensionSettingsManager Folder
- Select the QRCodeExtensionSettingsManager.exe (Application)
- Once open, enter the following information on the Settings, and Printer tabs
- Save the settings above and then move on to the next step.
5. Installing the QR Extension Service
- Navigate to C:\MICROS\ProfessionalServices\QRIntermediary
- Select the Install QRPay 3700 Service program in the folder
- A window command line will pop up and begin installing the service.
- It will prompt you to confirm the service name, make no changes, and select Ok.
- Once completed you will see the following text displayed at the bottom of the command line.
- Verify the service installed by opening services.msc
- To open services: Type in services.msc into the Windows Start search or open Windows Run tool and type in services.msc
- Find the QRIntermediary service and select Start
- Once started it will show as below
6. Shift4 SkyTab Interface
The Shift4 SkyTab Interface for RES 3700 is REQUIRED for QR Pay to Post transactions to RES.
- You will need the Shift4 SkyTab Interface for RES 3700 in conjunction with the QR Pay Extension.
- For requirements and installation instructions please visit the: RES 3700 Shift4 SkyTab Setup Guide.
7. Usage and Payments
This section will highlight how to use the QR Code for payments, adjust branding and tips.
Payments
- Once the QR Code is implemented into the system it will begin to print on the top of the guest checks.
- When the customer receives their guest check, they will scan the QR Code at the top of the check with their smartphone and follow the link.
Note: While the QR Code is specific to the MID it is not specific to the individual check |
- The customer will be prompted to enter the check number to identify the check.
Tip: You can circle or highlight the check number on the receipt to help the customer identify the check number |
- Once the check is confirmed on the smartphone, the customer can complete the payment by using:
- Apple Pay
- Google Pay
- Entering their card information manually by selecting the Pay with Card button.
- Once the check is finalized, it will be closed and posted on the POS.
8. Lighthouse BMS Settings
Tip Suggest Settings
- Default Tips suggestion on the payment screen can be adjusted through Lighthouse BMS.
- Login to Lighthouse BMS
- Navigate to the Marketplace
- Select QR Pay
- Navigate to the ‘Tip Settings’ section of the page.
- There is an option to enable Tips or disable Tips if you do not want to use the Tip feature.
- Tip percentages can also be adjusted on this page
- A default Tip can be selected
Branding
- Branding on the enter check number screen can be adjusted through Lighthouse BMS.
- Login to Lighthouse BMS.
- Navigate to the Marketplace.
- Select QR Pay.
- Navigate to the ‘Branding’ section of the page.
- Upload a logo to display when the customer is entering their check number.