Squirrel POS v2 Punchh Integration Instructions

Prerequisites

System Requirements for the PC Running the Punchh Service (Punchh.exe)

• Minimum OS: Windows 7 (with SP1) and .NET Framework 4.6.1

Printers

• Check with your Squirrel dealer to ensure that your printers are capable of printing QR codes

Configure Squirrel Back office Settings

Configuring the Loyalty Discount

1. Open the Squirrel Back Office (C:\Squirrel\Program\SqExplor.exe)

2. Go to Advanced Setup >Promos & QSA's >Promo Setup:

   

3. In the promo toolbar, click the "New Record" button:

   

4. Configure the loyalty discount as follows:

   

   1. Promo Name: Brand's preference. This will be the name of the loyalty discount that gets added to checks.

      1. example: "LoyaltyDiscount"

   2. Promo By: SEAT

   3. % Discount: 0.00

   4. $ Discount: 0.01

   5. Max $ Discount: 99999999.00

   6. Promo Per Check Limit: 99999

   7. Promo Per Table Limit: 99999999

   8. Cross Ref: Leave as default value

   9. Apply Use Tax: Unchecked

   10. Min Check $: 0.00

   11. Qualifying Items: Do not select anything
       (Qualifying items will be configured in the Punchh Redeemable on the Punchh Portal)

       

   12. Sort POS Promo Picklist by Cross Ref: Checked

   13. Tax Calculated on Gross Price: Unchecked

   14. Service Charge Calculated on Gross Price: Checked

   15. House Charge Calculated on Gross Price: Checked

   16. Exclude Promo'd Entry from Cover Count: Unchecked

   17. Allow Repetition Factor: Checked

   18. Must Enter Promo ID Number: Unchecked

   19. Require Reason: Unchecked

   20. Make Promo Exclusive: Unchecked

   21. Disallow on Special Price Lists: Unchecked

   22. Departments in which to allow promo: Select the departments that you want the loyalty discount to be applicable to.

       1. Ex: For Doordash orders you do not want to allow Punchh redemptions

   23. Select menu entries or categories for this promo: Select the categories that you want the loyalty discount to be applicable to.

       1. Ex: You may want to exclude the categories that contain only alcohol items.
          Please be aware that if there is a mismatch on the Punchh discount rules and the POS Discount type, the Punchh discount will not be able to be applied

   24. Access Type / Barcode (UPC):

       1. Barcode: No Barcode
       2. Description: On Screen
       3. Access type: SERVER

5. Click the Save button:

   

6. Click the Explorer Window button, then click Yes when prompted to Save:

   

Installing and Configuring the Punchh Service

Install Punchh Service Application

1. Run the Punchh provided SetupPunchh_version.exe on the Squirrel back-office PC.

   1. Note: This PC needs to have internet access, so that check data can be sent to the Punchh server.

   2. Note: This PC must meet these system requirements:

      1. Minimum OS: Windows 7 w/ SP1 and .NET Framework 4.6.1

2. If prompted, allow elevated privileges:

   

3. Click Next

   

4. Leave the path as the default path. Click Next.

   

5. Click Install.

   

6. Click Finish.

   

Configure Punchh Service Application

1. Navigate to the folder C:\Program Files (x86)\Punchh, and run PunchhConfigurator.exe as administrator. Modify the punchh configuration as follows:

2. Enter the Location Key (aka API_Key) and Business Key:

   

3. For LoyaltyButtonName, enter the name of the loyalty button that will appear on the Payment screen at POS terminals.

   1. Note: The actual button will be created in the next section. If you are unsure of what to name it, then you can leave this value as "Punchh" for now and modify it later.

      

4. For POS_Type, set this to Squirrel:

   

5. Click on the Squirrel.cfg tab:

   

6. For PathToSquirrel, enter the path to the Squirrel folder (ex. C:\Squirrel):

   

7. For LoyaltyDiscountName, enter the name of the loyalty discount promo that you previously created:

   

8. Note for Port: The default port is set to 5614. If this port is already in use by another application, then an error will appear in the log files. See the Troubleshooting section for more details.

9. Click the Apply button. The Punchh service will get restarted, and the configuration files will get updated.

   

10. Click the Exit button to close the Punchh Configurator.

11. Open Services.msc and verify if the Punchh service is in the Running state:

    

    1. Note: If the Punchh service is not yet in the "Running" state, wait for 1 minute and then refresh Services.msc. If still not in the "Running" state, then check the log files for errors (see the Troubleshooting section for more details).

12. Once the Punchh service is in the "Running" state, right-click the Punchh service, then go to Properties.

    

13. Go to the Recovery tab and change the settings as follows:

    1. First failure: Restart the Service

    2. Second failure: Restart the Service

    3. Subsequent failures: Restart the Service

    4. Reset fail count after: 0 days

    5. Restart service after: 0 minutes

       

14. Click the Apply button, then click OK.

Finalize Squirrel Back Office Configuration

Set up POS Screens

1. In the Squirrel Back Office, go to Daily Setup >Screen Setup >Point of Sale Screen Setup

   

2. Select the all departments that you want to apply the Punchh functionality to.

   1. Note: If you want multiple departments to have the Punchh functionality, then this section needs to be completed for each of those departments.

      

3. Click the Payment tab

   

4. Double click in an empty area on the grid:

   

5. In the Reference Name dropdown, select <USER FUNCTION>:

   

6. For "P.O.S. Name", enter a name for the loyalty button (ex. "Punchh")

7. For "Executable", enter "PunchhUI":

   

8. Under "Select Image", select any size/color.

9. Click OK

10. The loyalty button will now appear on the Payment screen:

    

11. Double-click the Payment tab

    

12. For "Pre Execute", enter "PunchhUpdateChk" then click OK.

    

13. Click the Edit Popup button:

    

14. Double click the Delete button:

    

15. For "Pre Execute", enter "PunchhDelPre" then click OK.

    

16. Double click the Move button:

    

17. For "Pre Execute", enter "PunchhMovePre" then click OK.

    

18. Close the Edit Popup window.

    

19. Click the Summary tab >Manager >double click REOPEN CHK.

    

20. For "Post Execute", enter "PunchhReopenChk" then click OK.

    

21. Click the Summary tab >Manager >double click CHECK ADJ.

    

22. For "Post Execute", enter "PunchhReopenChk" then click OK.

    

23. Click the Check tab, then double click the PARTIAL button.

    

24. For "Pre Execute", enter "PunchhSplitPre" then click OK.

    

25. Click the Check tab, then double click the SEPARATE button.

    

26. For "Pre Execute", enter "PunchhSplitPre" then click OK.

    

27. Click the Save button:

    

28. Click the Explorer Window button, then click Yes when prompted to Save:

    

Send Settings to POS

1. Go to POS Control:

   

2. Click Send Setup Changes to Terminals:

   

3. Click Yes:

   

4. Wait for the "Send Setup Changes to Terminals" to complete.

5. Reboot all terminals at the location. This is required for the terminals to fetch the Punchh extension files.

Troubleshooting

Log Files

If you are getting errors when applying redemptions or when trying to scan the QR code to earn points please check Punchh logs for errors. Logs are located:

C:\Program Files (x86)\Punchh\Logs
or
C:\Program Files\Punchh\Logs

Log files are named by date, for example:
2017-0223-000050.log
was created on Feb-23, 2017

Port Conflict Error

Identification

If the default port is already in use by another application, a port conflict error will occur. In the log file, please search for the text "Port conflict occurred". If this text was found, then the error occurred.

Resolution

To resolve this error, please use the PunchhConfigurator tool to change the default port to an unused TCP port. Some suggested ports, usually not in use, are: 5619, 7482, 24473, 10123.