Skip to main content

POSitouch Install Handbook.

  • Updated

Introduction to Omnivore's POSitouch POS Integration

Please refer to this link to fill out the Agent configuration submission form:
POSitouch Integration Form

 

Omnivore’s integration to POSitouch allows Omnivore to use POSitouch's integration methods to perform many functions in a live environment. The Omnivore API also allows for multiple application partners to “plug in” to the Omnivore API platform to perform functions such as payroll management, sales reporting, inventory control, online ordering and payments, and more. This allows above-store, centralized management of the online ordering experience.

Omnivore integrates to POSitouch using POSitouch's XML module for order injection and pricing data. Omnivore will pull pricing for items and modifiers based on this mapping every 30 minutes. 

Omnivore can also pull various other files in POSitouch to function in payroll management, inventory control, sales reporting, etc. 

 

Connecting Locations

POSitouch POS requires an agent to be installed at the location level. Once the services are installed, the location will appear "online" in the Omnivore Dashboard. To get a detailed walkthrough of how to install the Omnivore agent, please refer to the Omnivore installation guide.

 

 

Determining Menu

  • In Command Prompt, use the C:/SC directory to run “MenuW”, and then “Edit An Order Screen".
  • If you get menu screens, you are using MenuW
  • If you get a message that says “Please Use QuickMenu,” you are using QuickMenu
  • If QuickMenu, determine QM version. Go to C:\SC directory in file explorer, right click on QM.exe, and go to Details tab to find the Product Version (QuickMenu MUST be version 2.6.7.12 or higher)
  • Once you determine QM or MenuW, set UseQuickMenu  = True (True if you ARE using QuickMenu)/False (False if you are NOT using QuickMenu) in the [Positouch] of the general.ini.

 

If you need more details, please click here.

POSitouch XML Configuration

Omnivore requires the XML setup in POSitouch be completed for full integration. If you would like to inject orders and payments, the XML must be setup. Please follow the instructions on how to configure the XMLs in POSitouch for Omnivore order injection. 

 

Navigate to Backoffice setup>Rest Misc Data> XML I/O

  • Make sure the “Close Check”, “Open Checks”, “XML Ordering”, and “Open Checks Request” all have printers assigned. “Time Clock” and “Out of Stock” can be done based on merchant needs.
  • Select “Configure” on the XML Ordering Device
    • The inpath should be C:\SC\XML\OMNIVORE_INORDER, and the outpath should be C:\SC\XML\OMNIVORE. Make sure these match the filepath numbers. If there is a blank filepath above them, create a dummy path, otherwise the path will occupy the blank space and cause errors. 
  • Select “Configure” on the Open Checks Request Device
    • The inpath should be C:\SC\XML\OMNIVORE_IN, and the outpath should be C:\SC\XML\OMNIVORE. Follow the same rules as above.
  • Select “Virtual Printer Path”
    • Make sure the other virtual printers assigned have the correct outpath C:\SC\XML\OMNIVORE_IN
  • Select “More Flags”
    • Set the “XML Order detect interval (secs)” value to 1

    • Check “Allow updating open checks via XML?” or “Never delay processing”

If you need more details, please click here.



POSitouch Employee Configuration

A singular Employee must be created in order to utilize the price check feature of the Omnivore Agent. Additional employees can be created for people who will be utilizing the order injection function.

  • Open the Time and Attendance software and create an employee
    • Make sure “POS User” is  turned on with the appropriate job code to perform check functions such as payments
    • Assign a department and job
    • Wage Type: Salary, not on reports
    • Pay Period: Always pay base salary
    • Flag on “Use POS w/out Punchin” and “Pay Salary

If you need more details, please click here.



Optional Setups

Payment Tenders

Omnivore has the ability to run two different payment types through the API platform. The API is able to pass card not present payments and also third party payments, that close out to a pre-programmed tender for reporting and journaling purposes. 

If doing a 3rd party payment, follow the below steps

  • Open Forms of Payment in Backoffice Setup
  • Select “Add” on the list of payments
    • Select an empty slot
    • Press Select
    • Enter Payment Name
    • Ensure payout type is 1-No change
    • Turn on Automatic reprint of check
    • Turn on Payment type allows tip (if merchant is accepting tips)
    • Turn on Credit Card Payment
  • Navigate to Backoffice Setup>Credit Card>User Defined CC
    • Select an Empty Slot
    • Set the name to match the above payment
    • Set the start and end number to 999999 (if this is not available, make up a number that does not fall within the ranges of any other payment)
    • Set Digits to 6
    • Check “No Chk Exp Date”
    • Set Media Type to 10-Gift Cards
    • Ensure no other flags are selected, or everything is set to 0
    • Save
  • Navigate to Backoffice Setup>Credit Card>Forms of Payment
    • Find above payment and turn on both flags
  • Navigate to Backoffice Setup>Credit Card>Credit Card Types
    • Find the payment created and match the “Payment Type” box to it
    • Ensure everything else is “0” or STNDRD
    • Save

If you need more details, please click here.

Discounts/Coupons

Omnivore has the ability to run coupons down through the API into the POSitouch system. POSitouch has the capability to create discounts in 2 ways: on the POSitouch menu, or in the native POSitouch backoffice environment. 

The Omnivore/POSitouch integration supports all possible Coupon types that are available within the Omnivore Coupon Manager. The Omnivore recommendation is that the Discount, set up within POSitouch, should be an Open Dollar Discount placed on a menu screen, so that Omnivore can calculate the amount to be discounted, then sent down to the POS.

Here is an article on the recommended setup, and how to link Discounts for the Omnivore/POSitouch integration:

Testing

Use the Basic Menu Testing for POS Integrations article that outlines recommended testing steps to verify orders are flowing through successfully to POS.

Troubleshooting

Omnivore team members have taken time and effort to document errors and issues and how to resolve them in the articles below. These are the main issues that have been seen and resolved in the past. 

After Immediate System Change

If you ever get a “Fatal Error 1000” after doing an Immediate System Change, revert the changes you made and do another Immediate System Change before starting SPCWin again. This would most likely occur when adding the XML Printers, so reverting the changes in XML I/O and removing those printers may be all that’s needed. Remember to also revert the changes made to spcwin.ini.

3rd Party Payment

If you get “Authorization not found in ticket” on a 3rd party payment, check for the “PayAtTable” module in security.exe. Originally it was a separate license, but it was added to the XML Ordering module many years ago.

The merchant would like to use the 3rd Party Tender(s) from POS terminals

  • This is no longer possible in current releases of POSitouch
    • The functionality that allowed it was changed after an unknown date for all versions, so we do not support it at all
  • If the app partner is not live yet and the 3rd Party Tender(s) must be accessible until it is
    • Leave the following options unchecked until the app partner goes live:
      • Payment > Forms of Payment - Credit Card payment?
      • Credit Card > Forms Of Payment - Authorization Required and Draft Capture

There are no empty slots available in Payment > Forms of Payment

  • The merchant must approve repurposing an existing entry

There are no empty slots available in Credit Card > User Defined CC

  • Consult Omnivore Tier 3 Support for assistance if the merchant cannot identify an unused entry

 

 

 

XML Setup 

  1. Navigate to “Restaurant Misc Data” then “XML I/O” in POSitouch Backoffice setup

  1. Ensure the following printers are created as the above picture by using the “Add Virtual Printer” button. 







  1. On the right hand side, select “Configure” next to “XML Ordering”
    • In here, add the following Input and Output Folders, making sure they have the same number:




  1. Repeat the same thing for the “Configure button” next to “Open Checks Request”, using the following paths:
    • Input should be C:\SC\XML\OMNIVORE_IN
    • Output should be C:\SC\XML\OMNIVORE
  2. Once that is completed, use the “Virtual Printer Path” button on the previous page. Make sure all printers associated with Omnivore (that would be Close Checks, Open Checks, Out of Stock, Time Clock, and Open Checks Request) have the following outpath:
    • C:\SC\XML\OMNIVORE (if this is already in place, it does NOT need to be repeated. 
  3. The final step is to navigate to the “More Flags” section of the previous page, and make 2 changes:
    •  “XML Order detect interval (sec)” is set to 1
    • Check “Allow updating open checks via XML?” or “Never delay processing”
  4. In newer versions of POSitouch, the filepaths will be created for you. However, sometimes these files need to be added to the SPCWIN.INI file, and the folders created manually. If you have to manually add these to your SPCWIN.INI, please continue below.




(OPTIONAL)

  1. To manually add to the SPCWIN.INI file, open the file and add a few items:
    • Under the [XML] header, ensure the following are set:
      1. XMLInPath=C:\SC\XML\OMNIVORE_IN
      2. XMLInPath=C:\SC\XML\OMNIVORE_INORDER
      3. If there is something already set there, simply place a semicolon after what is already set and add the filepath (no spaces)
    • Under the [Virtual] header, ensure the following are set:
      1. VirtualPath##=C:\SC\XML\OMNIVORE 
      2. The ## will be the DEVICE NUMBER of the printers in Backoffice Setup>Hardware>Prep Printers>Locations and Types
      3. You may need to add this line multiple times to represent each printer

 

Employee Creation

A note on employee creation. By setting the user type to “Manager”, there is only one employee that needs to be used. This employee can be logged in to multiple places at once. However, there could be fringe cases where multiple app partners are attached, or a large brand will have this turned off. If so, a second employee will need to be created. 

  1. Run C:/SC/Taw.exe
  2. Select “Employees”
  3. Click Add Empl on the bottom.
    1. Enter First and Last Name for Emp
    2. Select available Employee Number or Enter a custom number
  4. Select Quick Setup
    1. Check POS User
      1. User Type - Manager if the merchant will allow
    2. Use employee type Regular
    3. Select a department and job from dropdown list at the bottom
  5. Select Empl. Status
    1. Check Use POS w/out PunchIn
    2. Wage Type - Salary, not on reports
    3. Pay Period - Always Pay Base Salary
    4. Select “Pay Salary”
  6. Select Save Status, Quick Setup, Save Employee
























































Creating a 3rd Party Payment

  1. Run C:\SC\bosetupw and navigate to Payment > Forms of Payment
  2. Press the “Add” button (if the tender is already present, select “Edit” and make sure the tender is configured correctly by following the steps below)
    1. Select an empty slot
    2. Press Select
    3. Enter the applicable Payment Name: (e.g. 3rd Party)
    4. Set Payout type: to 1-No change
    5. Check the following options on the General tab:
      1. Automatic reprint of check?
      2. Payment type allows tip?
      3. Credit Card payment?
    6. Verify that all other options on all tabs are either unchecked or set to 0
    7. Press the Ok button to save
  3. Press the Exit button twice to close the dialog

Credit Card > User Defined CC

  1. Navigate to C:\SC\bosetupw > Credit Card > User Defined CC
  2. Select an empty slot
  3. Set the following:
    1. Name: Use the same name as entered above (e.g. 3rd Party)
    2. Start Number: 999999
    3. End Number: 999999
      • Note: Start and End Numbers should be the same value, but should not fall into the same range as any other entry with Digits set to 6. If more than one tender is needed, both Start and End Numbers should decrease by 1 for each additional tender.
      • e.g. 999998
    4. Digits: 6
    5. No Chk Exp Date: Checked
    6. Media Type: 10-Gift Cards
  4. Verify there are NO FLAGS CHECKED or are set to ZERO in More Flags and More Flags 2 
  5. Press the Save button to save and close the dialog

Credit Card > Forms Of Payment

  1. Navigate to C:\SC\bosetupw > Credit Card > Forms Of Payment
  2. Check both options on the Form of Payment entry with the name used above (e.g. 3rd Party):
    1. Authorization Required
    2. Draft Capture
  3. Press the Ok button to save and

close the dialog

Credit Card > Credit Card Types

  1. Navigate to C:\SC\bosetupw > Credit Card > Credit Card Types
  2. Set the following for the CC Type entry with the name used above (e.g. 3rd Party):
    1. Payment Type: The selection that matches the name entered above (e.g. 3rd Party)
    2. Channel: STNDRD
  3. Verify this entry’s other options are either empty, unchecked, or set to 0
  4. Press the Save button to save and close the dialog

Immediate System Change

  • An Immediate System Change (C:\SC\bow 70) is required for changes to be available for use through the API






QuickMenu or MenuW?

 

  1. In Command Prompt, use the C:/SC directory to run “MenuW”, and then “Edit An Order Screen".
  2. If you get menu screens, you are using MenuW:



















  1. If you get a message that says “Please Use QuickMenu,” you are using QuickMenu:














  1. If QuickMenu, determine QM version. Go to C:\SC directory in file explorer, right click on QM.exe, and go to Details tab to find the Product Version

 

Once you determine QM or MenuW, set UseQuickMenu  = True (True if you ARE using QuickMenu)/False (False if you are NOT using QuickMenu) in the [Positouch] of the general.ini.

 

 

 

Related articles