Maitre'D POS Integration Guide

Prerequisites

1. Run SetupPunchh.msi installer and follow the prompts.
2. Verify that you have the valid Maitre’D Back Office user name and password, which provide edit access to: Interfaces, Screen Designer, Print Designer, and Discounts
3. Verify that your Maitre’D configuration includes the Discount Manager license add-on:
   1. Navigate to Maitre’D Application > Server Control > View > Options.
   2. Verify that the Discount Manager configuration option is present in the list on the Options applet.

Punchh Configurator Utility

1. Launch the provided Punchh Configurator utility: C:\Program Files (x86)\Punchh\PunchhConfigurator.exe
2. The Punchh Configurator screen pops up, and by default, you should be navigated to the punchh.cfg screen.
3. Update the parameters shown in the image below with appropriate data using drop-down menu options or direct typing.
   IMPORTANT: The API parameter must be changed from the default value of pos to isl.

4. Log in to the Punchh platform and find the API key specific to your location.

4. 1. On the punchh.cfg tab, select the API_Key parameter.
   2. Add the API key to the Enter the API key for your store location field.
5. Select POS_Type item, navigate to the Generic field, and open the drop-down list.
6. Select the Maitre'D item from the list.
7. Click the Apply button.
8. On the Punchh Configurator screen, select the Maitre'D.cfg tab.
9. Update the parameters shown in the image below with appropriate data using drop-down menu options or direct typing.

10. Verify and update the navigation path for the PathToMaitreD parameter.
    1. The value for the PathToMaitreD parameter must point to the actual directory where the Maitre'D software is installed.
    2. The default value is C:\POSERA\MaitreD.
    3. If you have installed the Maitre'D software in any other location (for instance, in the C:\Program Files\MaitreD location), then you need to update the value with the path to your actual location.
11. Verify where the Maitre'D software is installed, and edit this parameter according to the actual location if needed. For instance: C:\POSERA\MaitreD\DATA\Punchh
12. The default value, such as 8001, must match the port specified in the External Discount Manager settings.
13. On the Punchh Configurator screen, click the Apply button. This step will restart the Punchh service.
14. Click the Exit button to close the Punchh Configurator screen.

Punchh Service Setup

1. Verify that the Punchh Configurator started the Punchh Service automatically.

2. After applying changes you completed on the Punchh Configurator screen and restarting the Punchh Service, the Punchh Service automatically generates the Punchh survey.xml file and adds it to the C:\POSERA\MaitreD\DATA folder.
3. Verify that the Punchh Service generated and added the xml file to the C:\POSERA\MaitreD\DATA folder. For instance, C:\POSERA\MaitreD\DATA\survey.xml
4. Verify the latest log file (for instance, in the C:\Program Files (x86)\Punchh\Logs directory).
   1. If there are no issues, then the Punchh Service reports this kind of information in the log file for each location shown below:

5. If the xml file already exists in this directory, then the Punchh Service does NOT overwrite the existing survey.xml file and reports such issues into a log file. For instance:

1. 1. In this case, complete the following steps:
      1. Rename or delete the existing xml file.
      2. Restart the Punchh Service.
      3. Make sure that the Punchh Service added the xml file to the C:\POSERA\MaitreD\DATA folder. For instance, C:\POSERA\MaitreD\DATA\survey.xml
         NOTE: The Punchh Service must be restarted manually every time after you manually edit the config files.  If you have NOT changed any values in the config files, then there is no need to restart the Punchh Service.
         The Punchh Configurator restarts the Punchh Service after you click the Apply button.

Punchh Integration Setup

Start the Maitre'D Back Office

1. Verify that the Maitre’D Back Office can be connected.
2. Launch Maitre’D Back Office and enter valid <UserID>/<Password>. For instance, C:\POSERA\MaitreD\PRG\bo.exe /FC:\POSERA\MaitreD\DATA\BO.INI

       

Configuration on the Server Control Screen

1. On the main screen, select Server Control.

2. On the Server Control screen, select View > Options.

Discount Manager > Communication Option

1. On the Configuration screen > Application Map, select Discount Manager > Communication.

2. Validate that port 8001 matches the port set in the Punchh Configurator setup.
3. Enter the following values:
   1. Local Host URL
   2. Time Out: 5
   3. Retry Delay: 5
   4. User Name: none
   5. Password: <leave blank>
4. Click the Applybutton.
5. Test the connection.

Table Management

1. On the Configuration Screen > Application Map, select Table Management.

2. Enter the following values:
   1. Interface: Generic Xml
   2. Directory: <path to the Data Directory> (for instance, C:\POSERA\MAITRED\DATA\Checks)
      IMPORTANT: Maitre’D only supports a SINGLE third-party integration vendor. If another application, such as Table Seating Manager integration, modifies this path or reads from this same directory, it will break Punchh functionality.
3. Click the Applybutton.
4. Close the Configuration screen.

Promotion Setup

1. Navigate to the main screen and select Point of Sale Control.
2. Select Promotion Setupon the left applet.

3. On the Promotion screen, click the Add button. The new Promotion applet pops up.
4. Create a new discount named Punchh Discount, and enter the values as shown in the image below.

5. Select Schedule and enable the promotion for all days.

6. On the Point of Sale Control screen, select View > Options and then check Items without Quantity.

7. Navigate to Employees > Configuration and enable the Punchh discount for all configurations.

   

**NOTE:**The Punchh discount is called VIF Discount in the image above.

8. Under pos control\revenue center\options\kitchen, Order Number must be enabled.

Enabling the Survey Mode Function

1. By default, Maitre’D can produce the evaluation sheet. To replace the evaluation sheet with the survey, update the BO.INI file:
2. Verify that the BO.INI file exists. For instance, C:\POSERA\MaitreD\DATA\BO.INI
3. Update the BO.INI file by adding the SurveyMode=True parameter to the Miscellaneous section.
4. Save your changes and close the BO.INI file.
5. Stop the Maitre’D Back Office server (for instance, C:\POSERA\MaitreD\PRG\exe), and close all back-office modules as follows:
   
   1. Navigate to the Server Control screen.
   2. Select File > Stop Server.
6. Start the Maitre'D Back Office and enter <UserID>/<Password>. For instance, C:\POSERA\MaitreD\PRG\bo.exe /FC:\POSERA\MaitreD\DATA\BO.INI
7. Navigate to the Server Control screen.
8. Select Make Workstation Dataon the Menu applet.

9. Start the Maitre’D Back Office server (exe):
   1. On the Server Control screen, select File > Start Server.
   2. Close the Server Control screen.

Configure Survey Printing

1. Navigate to the Maitre’D Back Office main screen and select Point Of Sale Control.
2. Select the Revenue Center > Options. The Revenue Center Selection screen pops up.

3. Update values for the Modes and the Workstation parameters for every revenue item available in the list as shown in the image below, or update just some of the items as needed. For instance, Dining

   1. Modes

      1. Double-click the Dining revenue item. The Configuration by Revenue Center #... – Dining screen pops up.
      2. Navigate to the Menu applet and select Modes. The Modes applet appears.
      3. Edit every mode and put the value 00 into the % Customer field as shown in the image below. It means that 100% of checks will have a survey printed.

   2. Workstation

      1. On the Configuration by Revenue Center #... – Dining screen, navigate to the Menu applet and select Workstation. The Workstation applet appears.
      2. Select the Normal evaluation sheet.
         

Troubleshooting

If you are getting errors when applying redemptions or trying to scan a QR code to earn points, check the Punchh logs for errors. Logs are located under: C:\Program Files (x86)\Punchh\Logsor C:\Program Files\Punchh\Logs

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

Additional Resources

Maitre'D Online User Manual