- POS Prerequisites/Requirements
- Primary Server (Site Controller or manager pc)
- Configure Firewall/AV
- POS Setup
- Installation Instructions
Primary Server (Site Controller or manager pc)
RLM 2.6 or higher
.NET 4.5 or higher
Network Data Flow
Configure firewall/internet router
The computer that host the Punchh service will require outbound access to the following endpoints to the Punchh service APIs
The PC running the Punchh service
TCP Port 443
Please confirm with your Punchh account manager to identify other Punchh endpoints used for testing/staging or if your brand has it’s own Punchh assigned endpoints
RPOS Back Office Software Firewall/AV and Application Whitelisting Configuration
The Punchh RPOS POS integration requires the ability for the Punch service applications to access the RPOS POS server database. The NCR RPOS RLM application on the RPOS Back Office PC will also require to access the Punchh Service running on the RPOS Back Office computer
Software Firewall Setup
tcp port 443
RPOS RLM Process
tcp port (customer choice)
Application Whitelist Control - Organizational Whitelisting
If your AV/Application whitelisting system provides the ability to approve applications that are cryptographically signed by specific organizations add:
PUNCHH INC (http://punchh.com )
as a trusted application provider to ensure updates downloaded to the site are not blocked by your Application Whitelist Control system
Otherwise manually whitelist:
C:\Program files (x86)\bin\Punchh.exe
C:\Program files (x86)\PunchhMonitor.exe
C:\Program files (x86)\PunchhConf.exe
Network Firewall Validation
From the POS BOH PC open a web browser and navigate to the following web pages:
Each web page should return a plain white page with OK. If any page doesn't return OK, the firewall needs to be reviewed to ensure the correct FW rules are in place
Configure RPOS/RLM for Punchh
Step 1: Verify RLM is installed on the site controller by looking for the RadViewer application.
Step 2: Launch RadViewer
Step 3: Select “Window → Registry View”
Step 4: Configure the IP Address and Port Number.
Navigate to “SigmaServer → RadiantSystems → Sigma → Host Manager → ChannelRLM → Configs → TCPIP → Connection 1 → LineDriver → TCPIP” and set the IP and port number where the Punchh application will be running.
HostName= Leave Blank
IPAddress1= Internal IP Address of the machine you are installing the Punchh application on
IPAddress2= Leave Blank
IPAddress3= Leave Blank
PortNumber= Port Number of where the Punchh application is listening on
Step 5: Configure a Loyalty card used for User Lookup.
Navigate to “SigmaServer → RadiantSystems → Sigma → CardManager → ChannelRLM → Cards → _dynamic → LoyaltyCard1” and configure the Loyalty Card.
Barcode Format= a + card length (eg. a19 , this indicates that the card number is 19 in length)
CardCategory= L (L=Loyalty)
CardDescription= Customer Choice (This Is the name that will appear on the check and card reader when a user is assigned to the check)
CardNumberLengthAlternativeID= 10 (This is an alternate id for phone numbers with 10 digit length)
CardNumberLengthBarcode= Loyalty card length
CardNumberLengthManual= Loyalty card length that is expected when manually entered
CardNumberLengthSwipe= Loyalty card length that is expected when swiped
InclusionRangesAlternativeID= 2-9 (phone number as alternative id )
InclusionRangesBarcode= Loyalty card prefix
InclusionRangesManual= Loyalty card prefix
InclusionRangesSwipe= Loyalty card prefix
ShortCardDescription= Customer Choice (Short description of the loyalty card)
Track1Format= bt%tBat^nt^eYYMMt ?
Step 6: Restart SigmaServer. In Rad viewer, navigate to Window → Service View.
Step 6: From the navigation panel on the left, under SigmaServer, look for InActive Services, and right click, then choose “Reboot”
Step 7: Provide Punchh with the following during the Implementations pre-launch phase :
Port Number created in Step 4= _______
The name of the discount you want to show on the receipts, pos and card reader when a redemption is applied to the transaction= ___________
The Loyalty user display message that appears on the pump and card reader after a user lookup is successful (max 18 characters including spaces)= _____________
Loyalty card prefix (If applicable) = _____________
Zipline card prefix (If applicable) = _____________
Redemption Promoting option (only one can be selected) = _______________
notrans- No offers or rewards will be prompted to redeem
fuelonly- Prompt to redeem Fuel rewards at Pump
posonly- Prompt to redeem rewards and offers in-store card reader
bothfuelandpos- Prompt to redeem rewards and offers both in-store card readers and at the Pump.
Auto apply applicable offers (only one can be selected) = ___________
notrans- Disable auto apply discounts
fuelonly- Auto apply applicable offers at the pump
posonly- Auto apply applicable offers in-store
bothfuelandpos- Auto apply applicable offers in-store and at the pump
Before you install Punchh for the first time, you need to:
Ensure you have the Business UID provided by the Punchh POS Engineering Team
Ensure RPOS/RLM is configured for Punchh
Ensure the configured Port Number in RLM has been provided to Punchh
Ensure the Firewall/AV setup is complete
Verify that your location store number are correct and setup in the Punchh Platform
If the install is for a new site post launch, please submit a New Site Setup ticket to Punchh Support including the Store Number and Location API key from the locations settings in Punchh
Punchh will provide PunchhRposSetup.exe file for installation. This .exe must run silently via command line using the .bat file and the command line arguments detailed below.
Command Line Install:
Step 1: Create a .bat file with the content below.
Step 2: Place the PunchhRposSetup.exe and the .bat file above on the site controller in the same folder.
Step 3: Open an Admin Command Line (Start → type CMD → enter)
Step 4: From the command line, go to the directory where you placed the .bat file and the PunchhRposSetup.exe file.
Step 5: Type [Name of .bat file] space [store number here] space [Business UID here]
(eg. RPOSinst.bat 101 e5818bd1-3asdasb-456437-a3459-248bacasdas546)
The alternative installation method is to add the Store number and Business UID Directly to the batch file as seen below. With this method, you can run the batch file as an admin or from an admin command line.
If User Account Control is enabled, you will have to select YES to allow to continue to install
Step 6: When the installation is completed, the command line window will close.
Step 7: To verify install and check the logs in the directory where you have the .bat and PunchhRposSetup.exe file, and there will be a log present “punchhinst_computername.log”
Scroll to the bottom of the log and verify here you have a successful install.
Listed here are the installed executables and their functions
A windows service that communicates on TCP port identified when setting up RLM.
A windows service that checks throughout the day for program and settings updates.