Skip to main content

Squirrel POS Install Handbook

  • Updated

Introduction to Omnivore's Squirrel POS Integration

The Omnivore Squirrel integration utilizes the XML Gateway through a locally installed Omnivore Agent services called the POS Agent and POS Agent Updater. This local service also pulls POS information such as menu data, employees, tenders, etc… All the data is pulled from the local SQL database Omnivore automatically caches data every half hour. 

Our integration routes orders from various products, marketplaces, and partners directly into Squirrel. This allows for an above-store, centralized management of the online ordering experience.

 

Connecting Squirrel POS to Omnivore

The Omnivore Squirrel integration is referred to as a Traditional or Push POS. This requires a local agent to be installed on the Squirrel back office machine. An absolute requirement to Omnivore's agent installation is that the XML Gateway is installed and functioning. There are additional POS records that need to be configured in the Squirrel back office program that will then be used in the Omnivore agent. 

XML Gateway Ports

Setting up one interface server and two interface terminals is required. Please follow these instructions as to how to set up the interface server and interface terminals

 

Squirrel POS: XML Gateway Ports

 

Employees

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. Please follow these instructions as to how to set up the Employee

 

Squirrel POS: Employee and Badge creation

 

Item Creation 

Item Creation will need two items and a modifier created. The Open item and Open mod are for commenting and the empty item is for if a ticket is created without an item but items are added in later. The agent will automatically add the empty item to a ticket if it is created with no items. Please follow these instructions on how to set them up.

Squirrel POS: Item creation

 

Payments

These Payment IDs will be set up within the configuration for the POS. Please follow these instructions on how to set them up.

Squirrel POS: Payment creation

 

Send Setup Changes to Terminals

Once the above sections are setup you will need to push the changes out. You can either have them start a new business day, which they will have to do on their own. Or you can send setup changes to terminals. This will take them down for roughly 60 seconds but can take as long as 300 seconds depending on how bogged down everything is.

 

Please follow these instructions on how to push the changes out.

Squirrel POS: Send Setup Changes to Terminals



Testing Functionality Requirements

If you would like us to run a test on your location please create a ticket through the portal.

If you are an app partner you can also reach out to us about the different ways that testing on your own is available.

Troubleshooting

The majority of troubleshooting is not putting the correct SQLIDs for the items, having a badge number that doesn’t have all department access, or the XML Gateway froze up. For troubleshooting you should check your IDs and restart the XML Gateway. If these do not work, please submit a ticket to have it looked at.

Another section of troubleshooting we see often is that the open item and open mod are not being used for comments. The XML Gateway, in Squirrel, requires a open item to be used for commenting on the ticket or an open mod to have a comment on an item.

Upgrades

Upgrading the Agent is something that we do recommend you ask every quarter about as the Agent is always improving. Please use the document “Upgrade the Omnivore Agent on your Own” This will allow you to do this upgrade on your own. Please ask any questions or issues related to upgrades through the portal.

How to install Omnivore form Command Line

Backups

For in cases of emergency failures on the Squirrel back office and server replacements, we recommend backing up two files. These files are located in C:\Program Files(x86)\POS Agent. The files are the General.ini and the Site.ini. If you have these you will be able to successfully reinstall the Agent without any assistance from us. Please refer to the Re-Installing Omnivore guide

 

 

DETAILS

 

Squirrel POS: XML Gateway Ports

  • Find the drive that has squirrel on it go to \Squirrel\PosData
    • Check for a Gateway.ports file and edit it
      • If it's not created then create the file
        • Put in the ports 4998 and 4996 in the created file. These are the ports left open by squirrel
        • If you are having issues with the gateway later on after making thing then you will need to confirm with squirrel support if they are licensed for the XML gateway

  • Add a new line at the end of the list. It needs to be the next lowest number by 2. Save the doc when you are done
    • i.e. If there is 4998 and 4996 in there you will need to put 4994 below them in order
    • Squirrel only puts the even numbers in the document because the even numbers include their odd number counterparts with them naturally. Even numbers are the inputs and odd numbers are the outputs that come back to us. So if you have us using 4994 we will naturally have 4995 as well.

  • Go back to the squirrel main drive and go to \Squirrel\Program\Pos\posGateway.bat. Run the bat file
    • If it fails out that means the ports have already been registered and that is fine

Squirrel POS: Employee and Badge creation

  • On the squirrel back office program go to Daily Setup and then Employee Setup
  • Click on the asterisk to create a new employee

  • Enter in the first name, last name, and employee number
  • Under Badge Functions hit Add

  • Enter in the badge number and badge name
    • You will need the badge number for your general.ini config
  • Make sure they are in the access group for All Departments
    • Put them as a manager in the security group if you can

  • When the employee is finished click the pencil with cylinder button at the top

 

Squirrel POS: Item creation

Open Item

  • On the squirrel back office program under daily setup go to menu entry setup
  • Click on the asterisk and make a new item
    • Record the item number before giving the item a name. This number is the SQL ID you will use for putting into the general.ini
  • Have item selected as the type
  • Make sure the item has open name checked and set the name to be whatever app partner you are working with
  • Have the tax group be set to no tax
  • Click the Pencil to save the item

 

Open Mod Item

  • Make a second item
  • It will be the exact same as above except you will change the type of menu entry from Item to Modifier

Empty Item

  • You will need to make a third item.
  • Creating an empty item is the same as above except a couple things.
    • Do not check open name
    • Make sure the name of the item is blank.
      • To accomplish this, put a space where the name is.

Squirrel POS: Payment creation

  • Launch squirrel back office
    • Click on the advanced setup tab
    • Click payment setup under the payment section

  • Click the asterisk button to create a new payment
  • Enter the payment name
  • Set payment type to Normal or Regular
  • Check Allow Overtender
  • Click the cylinder/pencil button to save the changes

 

 

Squirrel POS: Send Setup Changes to Terminals

  • Go back to the home page of the squirrel back office program
    • Go to POS and service operations
    • Select Send Setup Changes to Terminal
      • This might require the merchant to push it down or finish the push. Majority of the time this will not be the case. We have only seen it a handful of times.

 

Related articles