This document provides installation and setup instructions for the integration of Zuppler Online Ordering with Pixelpoint.
Minimum Requirements
- .Net 4
- PixelPoint Version 12+
- PixelPoint WebToGo License
- PixelSQL engine needs to be running as the default PixelSqlBase name
- Run EOI Station on System 1 or the system with the database on it
- Zuppler POS Integrator Executable installed and running on the system. (Installation and setup instructions provided here: All about the Zuppler <> Pixelpoint Integration)
Pixelpoint Backoffice
There are two policies that are required to create an EOI station for the API module to communicate with PixelPoint POS. You will be required to open \PixelPOS\Pixel32.ini and add “ActiveServer=Y” and “InternetServer=Y” under the section that is acting as the EOI Station on the customer’s site.
Another policy required is “ShowProductCustomFields=Y” under the section that is acting for ALLSTATIONS:
[DLLS]
CALCTAX=DLLS/CALCTRANS.DLL
ONORDER=DLLS/ONORDERDLL.DLL
POLEDISP=DLLSPOLESHOW.DLL
DRAWER=DLLS/DRAWER.DLL
SCALE=DLLS/SCALE.DLL
[ALLSTATIONS]
SyncServerTime=Y
EmployeeTills=Y
ShowProductCustomFields=Y
[STATION1]
[STATION2]
[STATION20]
ActiveServer=Y
InternetServer=Y
Setup User Definable Fields
The PixelPoint integration with Zuppler relies on the 'User Definable’ fields concept to enable/disable product items and set an item name/desc/etc. If the 'User Definable' option does not show up in the product tab, make sure it is enabled in the System Setup Options. Navigate to Point of Sale> System Setup Options> Policies> Find ShowProductCustomFields> Uncheck 'Use Default'.
Once you are able to see the option in the product tab. Add the following fields:
- Add 'Zuppler_Active' field with value = Yes/No (boolean)
- Add 'Zuppler_Name' text field and specify the name as value field
- Add 'Zuppler_Desc' text field and specify the description as value
- Add 'Zuppler_Priority' integer field
Once these User definable fields are created, share their IDs with the Zuppler team. To find the IDs, you must log into FixPixelBase. Then in the top left go to “UserDefFlds”. Then the below items will pop up with their “UserDefID”#’s.
EOI Employee
You will need to create and assign a new EOI Employee in BackOffice:
- Open BackOffice and select 'Employees' tab from the Employees pull down menu
- Click on the "New" button to create a new Employee to be associated with Online Orders
- Enter the Employee Name, Last Name, and P.O.S. Name (i.e. "EOIEmp")
- Set POS function to be “Visible”
- Assign a swipe # to the employee
- Assign a job position to the EOI Employee by going to the 'Job Positions' section. It is recommended that you use the ‘Manager’ job position to avoid possible security credential issues
- Close and save changes
- Now open System Setup Options from the Point of Sale pull down menu
- Switch to the Advanced tab
- In the Default Internet Employee section, click on Change/Set and apply the EOI employee (i.e. "EOIEmp")
- Close and save changes
Configuring an EOI Station
An EOI Station runs the API to communicate between the POS and your online ordering. It also runs the PixWinSockServer (Listener) when a TCP connection is needed.
- From BackOffice, open 'Stations' from Point of Sale pull down menu
- In the Station Options tab, select the station # that will be hosting the EOI communication, such as Station 1 as shown in the following image. It won't be Station 1 for every client. We need to configure the station # which will be used for online ordering
- Make sure to apply the Menu and Default Sales Type
Payment Method Setup
In BackOffice you will need to access Payment Method Setup in the Administrator menu to create a new payment method.
- From BackOffice, open 'Methods of Payment' from Payments pull down menu
- Create a new payment method named 'Zuppler Online'. By creating this Payment Method, Zuppler orders will be mapped to this Payment Method with PixelPoint. Zuppler team will map this tender in POSaaS application.
- Ensure the 'External Authorization', 'Disable Cash Drawer Opening' are checked.
Sales Type Setup
In BackOffice you will need to access Sales Type Setup in the Administrator menu to create sales type for the following:
- Zuppler Pickup
- Zuppler Delivery
By creating the above Sales Types, Zuppler orders will be mapped to these Sales Type Method with PixelPoint. Zuppler team will map these order types in POSaaS.
Coupon Setup for Online Discounts
We need to create a coupon in Pixelpoint, Zuppler online discounts will be mapped to this coupon with PixelPoint. Zuppler team will map this discount in POSaaS.
- From BackOffice, open 'Coupons' from Coupons pull down menu
- Add a new record in Coupon Setup
- Add 'Description' text
- Set Type of Coupon to Manual by Amount
- Set Coupon to Applies to all categories
Create Open Product – Used to pass through Special Instructions
- In PixelPoint BackOffice software, go to Product Setup
- Set the Description and the printed Description to be “Special Instructions”
- Under pricing, set all the price levels to be 0.00
- Under Report Cat, select the report category you want to associate the Open product to, or create a new report category just for the Open Product
- Set the Type of Product to “Manual Keyboard”
- Switch to the “More info” tab and under the “Manually Entered” section, click on the “Price -Mode” and “Description” check boxes and make sure they both are checked
- Save the new Open Product
- You do not need to setup the User Definable for the Special Instructions product
- Share the product ID with the Zuppler team, which they will use as discount id in POSaaS
Create “Delivery” Product – Used to pass through Delivery Charges
- In PixelPoint BackOffice software, go to Product Setup
- Set the Description and the printed Description to be “Delivery”
- Under pricing, set all the price levels to be 0.01
- Under Report Cat, select the report category you want to associate the Delivery product to, or create a new report category just for the Delivery Product
- Set the Type of Product to “Ordering Product”
- Switch to the “Advanced” tab, under the “Manually Entered” section, click on the “Price -Mode” and “Description” check boxes and make sure they both are checked
- Save the new Delivery Product
- You do not need to setup the User Definable for the Delivery product
Some points to note while updating menu for Zuppler
Product Config
- Description - This is the name of the item which will be displayed for online ordering unless overridden by Zuppler_Name custom field. When a product has a forced question, this name is displayed online as the modifier name
- Price A - This is the default price level used for a menu product when it is the lead item. Price levels B to H can be used but you'll need to contact Zuppler team for that so they can update that in POSaaS
- Modify Price - This is the default price level used for a modifier/Answer to a Forced Question
- Report Cat - This is the category tab that a product will appear in on the online ordering menu
- Type of Product - A lead product must be an Ordering Product. Answers to Forced Questions or modifiers can be categorised differently
- Forced Questions - These are Zuppler Modifiers. One thing to note is that the Zuppler/PixelPoint integration supports Product / Question / Answer. Answer level Forced Questions or nested modifiers are not currently supported e.g. Product / Question / Answer / Question / Answer
Forced Question/Modifier Setup
- Answer List - The answer name you configure in the answer list is the modifier item name that is displayed on the online ordering menu
- Price Mode - Only Modify Price is supported. Fixed Price and other price levels are not currently supported
- Question Description - If ‘What type of meat would you like’ is setup as the question forced question description, then that will be the modifier group name that will be displayed online:
User Definable Field Setup
- Zuppler_ Active - Set as ‘Yes’ to activate a product or ‘No’ to deactivate a product. If this field is not set, product will be treated as deactivated as default. Please note, ISACTIVE will not override Zuppler_Active Yes. To deactivate a product online, Zuppler_Active must be set to ‘No’
- Zuppler_Name - Please retype the Product Name as you wish it to appear online (optional)
- Zuppler_Description - Please retype the Product Description as you wish it to appear online (optional)
- Sort_Order - Set the order in which you would like products to appear online within their Report Category (optional)
For any questions, please reach out to techsupport@zuppler.com
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article