Installation Guides

Installation Guide Preamble

Welcome to our guide. This document is intended for BarTrack customers as well as their POS technicians. It specifies setup instructions for on-boarding a new customer with an existing POS integration we support. Please use the URL to this guide, it is always being updated.

About Integrations

The BarTrack system will work without point-of-sale integration, but in order to take full advantage of BarTrack, we have to build ways to collect reports and configuration data from the point-of-sale software. Integrating the POS allows us to check pour data against what was actually input into the POS, which provides our reporting with its pour vs sales analytics. This guide contains everything you need to know before setup of a BarTrack POS integration. It should answer most of the questions and any concerns you may have about the process, as well as provide your POS support tech with the details of our needs in the event we don’t have access to complete the setup.

Collected Data

We export and use the following pieces of information from POS reports for each Item:

  • Order ID

  • Location ID (identification of terminal or handheld, or employee ID/name)

  • Timestamp sold

  • Name

  • Price
  • Tax
  • Modifiers
    • name, tax, price, quantity

  • Quantity

  • Category (Report Group)

  • Subcategory

  • Adjusted price or discounted amount

  • Void

Supported Integrations

Here is our current list of supported integrations. Click any one of the links below to jump to the specific section for that integration.

Aloha
Arryved
Bbot
Brink
Cloud Connect
Clover
Digital Dining
Dinerware
Focus
Foodtronix
Future
GoTab
Harbour Touch
Heartland
Lavu
Lightspeed
Matre’D
Micros
MSSQL
Northstar
Omnivore
Positouch
Restaurant Manager
Revel
SmartTab
SpotOn
Square
Squirril
Toast
Touch Bistro
Upserve
Xpient

Integration Types

Local

Local integrations are those which run on legacy type POS systems which typically have a central back-office server where a manager would obtain reports. There is often no online access to these reports.

Cloud

Cloud integrations always have a some form of reporting online, usually through a web portal.

Omnivore

Omnivore is a 3rd party data provider that makes local data cloud-based for some local/legacy systems. It requires Windows 7 or higher and supports the following POS systems:

Further details can be found here upon logging in to the Omnivore portal:
https://panel.omnivore.io/docs/guides/features/compatibility

General Requirements

Local Integrations

This integration type requires the BarTrack software to be installed on the POS server. Some anti-virus and/or firewalls may need to be set up to allow the service to run in the background. Please allow a BarTrack support engineer access to the server for initial assessment.

Download our remote access software to get started.
Click Here to Download

Windows username/password with Administration security level (we prefer having an account made for BarTrack).

Cloud Integrations

Cloud integrations may have one of the following types of authorization credentials.

Omnivore Integrations

Best Practices

Caveats

Timestamps Not Available

When we are not able to obtain timestamps from your system, these are the things that will be affected:


MSSQL Customer Setup

This requires the BarTrack Software to be installed on the POS server. Some anti-virus and/or firewalls may need to be set up to allow the service to run in the background. Please allow a BarTrack support engineer access to the server for initial assessment or have your IT department reach out to us if you prefer to oversee the setup.

Download our remote access software to get started.
Click Here to Download

Installation

Setup requirements

Setup Instructions

    1. Open Microsoft Server Configuration Manager

      image-1648694832352.png

    2. Enable Named Pipes and TCP/IP

      image-1648694854000.png


    3. Double-click TCP/IP. Under the Protocol tab, make sure that Enabled = Yes and Listen All = Yes

      image-1648694892242.png


    4. Click the IP Addresses tab, and then…
      • Find the IP entry that matches your IP address, or change the one closest to fit yours.

      • To find your IP address, open a command prompt by clicking the start menu and typing “cmd”. See the two screenshots below.

      • Active = Yes

      • Enabled = Yes

      • TCP Port = 1433 (usually the default port)

      • Click “Apply” and then “OK” a couple of times until you’re back to the SQL Manager screen, which you can then close.

        image-1648694971697.png

        image-1648694991886.png

    5.  Check to make sure the service is LISTENING.
      • In your command prompt type: netstat -na | find “1433”


        image-1648695149165.png

      • If it is not listening, make sure the service is started.
        Click Start, click run, type services and start/restart the SQL Server (SQLEXPRESS) service.

        image-1648695257859.png



    6. Open SMMS

      image-1648695294128.png



    7. Connect with Windows Authentication (no password needed).
      • You must be logged into Windows as the administrator user that created the DB.

        image-1648695321334.png


    8. Right click on the Database object, select Properties.

      image-1648695348065.png



    9. Click the security page, and make sure Server Authentication is set to “SQL Server and Windows Authentication mode”. Press OK.

      image-1648695374483.png



    10. Right click on Logins and create a new user.

      image-1648695399609.png


    11. Create the user with the following details, DON’T CLICK OK YET.

      image-1648695422156.png

      DO NOT ENFORCE PASSWORD POLICY.




    12. Select the Server Roles page.
      • Select sysadmin or a read-only role. Don’t click OK yet.

        image-1648695529904.png



    13. Select User Mapping page.
      • Select the Foodtronix database.
      • Select the dd_datareader role.
      • Click OK.

        image-1648695577255.png



    14. Enable the user
      • Grant - Permission to connect to DB engine.
      • Grant - Permission to login.

        image-1648695605825.png



    15. Test the user is able to login, and you can select from a table to read it’s contents.
      • Disconnect from the current server under File -> Disconnect object explorer.
      • Attempt to reconnect and log in again, but this time select SQL Authentication.

        image-1648695664282.png


        image-1648695680357.png


Setup Summary

  • This integration reads data from the local MSSQL database. BarTrack needs access to the MSSQL database with read permission, mapped to the Foodtronix database. This must be done with the admin user who created the Foodtronix database originally. Usually this would be a Windows administrator user.
  • Alternatively, you may have your IT person create a BarTrack user & password in the MSSQL database with read only access to the Foodtronix db,mapped to the Foodtronix database. SQL and Windows authorization mode must be enabled in the database security properties. Follow the MSSQL Integration for further instruction.

Omnivore

Supported POS Software: https://www.olo.com/omnivoreapi

Omnivore

Omnivore Micros Symphony

Required Info

If your Simphony version is 2.x or if your Enterprise is on-premise, please skip this section and move to the next. To proceed with our integration into your Simphony system, we request login information for EMC. If you are using a hosted version of Simphony, could you help us get a read-only user set up with permission to view settings from the enterprise level? In order to log in we will need:

We also require Transaction Services. Please use the following information to reach out to Oracle or your re-seller to request they install, configure, and test Transaction Services for your system if you haven't already:

Arryved

Arryved

Arryved Customer Setup

Cloud Integration

This integration requires that you create a user in the Arryved portal with “portal admin” enabled and “reporting” permissions using our specified email address.

Setup Instructions

  1. Click Employees on the right navigation menu.
  2. Click View Employees in the sub-menu of Employees.
  3. Add a new employee with portal admin privileges of “REPORTING” to the profile.
  4. Create the user with this email address: btverify@gmail.com
  5. Enable Portal Admin check box and save the user.

image-1648667874767.png

Bbot Customer Setup

Cloud Integration

This integration requires access to their API which is granted by the Bbot team.

Setup Instructions

Please contact Bbot to inform them that you will be allowing BarTrack access to your data.

Clover Customer Setup

Cloud Integration

This integration requires two string keys you may get by following the steps below. Please provide these two keys to BarTrack once obtained.

Setup Instructions

Part 1 - API Key Creation

  1. Click API Tokens in the navigation menu.
    image-1648694222656.png

  2. Enable two-factor authentication (requirement of creating a token).

  3. Click the green Create New Token button.

  4. Name the token BarTrack and select the following “READ” roles:

    • Inventory
    • Merchant
    • Orders
    • Payments
      image-1648694235438.png
  5. Click Save.
  6. The dialog will close. Then click the eyeball icon to show the hidden token. Copy the key and save it somewhere safe.

Part 2 - Obtaining Merchant ID

  1. Click Account & Setup on the navigation menu.

    image-1648694363076.png

  2. Obtain and copy the Merchant ID below the location name (not the MID).

    image-1648694372811.png

Digital Dining Customer Setup

Local Integration

This requires the BarTrack Software to be installed on the POS server. Some anti-virus and/or firewalls may need to be set up to allow the service to run in the background. Please allow a BarTrack support engineer access to the server for initial assessment.

Download our remote access software to get started.
Click Here to Download

Focus Customer Setup

Cloud Integration

This integration is setup by Focus. 

Setup Instructions

Please have the customer contact their Focus reseller to have this set up, and give permission for BarTrack to access your data.

Subscription to FocusCloud and Installation of FocusLink agent is required.

Foodtronix Customer Setup

Local Integration

Setup Summary

Please see MSSQL Customer Setup for further setup details.

Future Customer Setup

Local Integration

Setup Summary

Please see MSSQL Customer Setup for further setup details.

GoTab Customer Setup

Cloud Integration

This integration requires access to their API which is granted by the GoTab team.

Setup Instructions

Please contact GoTab to inform them that you want the BarTrack integration.
We will need your location ID.

Harbour Touch / Skytab Customer Setup

  1. Click "Profile & Settings" on the left navigation menu toward the bottom.

    image-1648696466689.png


  2. Create the bartrack user with the following email:

    technology+yourbusinessnameherewithoutspaces@bartrack.beer

    Do not use spaces or special characters


    image-1648696525677.png



  3. Click “User Permissions” tab and remove all check marks except for reports.

    image-1648696552182.png



  4. Click the “Locations” tab and select your location(s), and then “Create User” button.

    image-1648696720418.png


Heartland Customer Setup

Cloud Integration

  1. Create a new permission

    Once logged into your Heartland portal as an admin, click the "permissions" link in the left navigation menu. 

    image-1648959216178.png


  2. Save new permission

    Create a new permission that looks like the following, and click the save icon.

    image-1648959288956.png


  3. Create a new user

    Click the “Users” link on the left navigation menu and then click the NEW button.

    image-1648959343715.png




  4. Save user details

    Fill out the user details. 

    image-1648959366674.png

     

  5. Make sure you set a location, and the permission you just defined by selecting Choose or Select a Permission.

image-1697814135758.png

Add the following user and click the save icon.

image-1648959407594.png

  1. Await verification

    An email will be sent to BarTrack for verification, please make sure we get this as soon as it’s sent.

Northstar Customer Setup

Cloud Integration

This integration requires access to their API which is granted by the Northstar team.

Setup Instructions

Please contact Northstar to inform them that you will be allowing BarTrack access to your data.

Restaurant Manager Customer Setup

Local Integration

This requires the BarTrack Software to be installed on the POS server. Some anti-virus and/or firewalls may need to be set up to allow the service to run in the background. Please allow a BarTrack support engineer access to the server for initial assessment.

Download our remote access software to get started.
Click Here to Download

Installation Requirements

This password should give us access to creating report groups and custom reports and assigning a security level to BarTrack custom group

Best Practices

Technical Caveats (POS Dealer/Support Info)

SmartTab

SmartTab

SmartTab Customer Setup

Cloud Integration

  1. Open the staff area.
    Once logged into your SmartTab portal as an admin, click the “staff” link in the left navigation menu.

    image-1649256384141.png



  2. Create a Bartrack role
    Create the “Roles” tab at the top of the main window. Create a “Bartrack” role by typing the name on the left input and then clicking the “Add Role” button.

    image-1649256415435.png



    Click the edit pencil icon on your new BarTrack role.

    image-1649256790785.png



    Select the following reports: Sales, Products, Inventory, Tabs. Save the settings by clicking the check mark.

    Screenshot from 2024-05-21 12-00-41.png


  3. Create a new user.
    Click the “Users” tab at the top left of the main window. Fill out the details as shown.

    Screenshot from 2024-05-21 11-56-13.png

    Screenshot from 2024-05-21 11-53-05.png




    Save the user.

SpotOn

SpotOn

SpotOn Customer Setup

Official Integration

Direct customer to this link to fill out a form that gets sent to SpotOn:
https://docs.google.com/forms/d/e/1FAIpQLScFIq2G1q753bJD-ckXfTB5Ifo0ftM1TZJIqptBF2KiI92_uw/viewform

POS Integrations team will receive an email from SpotOn. At this point, allow up to 24 business hours for data to start being available.


Unofficial Integration (not supported)

Invite our user to SpotOn via SpotOn Support.

  • Have the customer use the following template below to request access from SpotOn.

  • SpotOn Support Email: restaurantpos@spoton.com

Hi Neighborhood Tap House Team,

In order to connect with Spot-On with BarTrack and gain access to your beverage reporting, we require a very small task from you. All we need is for you to send an email to Spot-On so they can give us the proper access we need to provide you with your BarTrack reporting. Failure to do this or changing the message can result in BarTrack having issues connecting with your point of sale system, so it is important that you copy and paste exactly what we say.

Please copy the following message and send it to SpotOn Support, and cc "xmlathropx@gmail.com":
--
Hello,

I need to add a new manager to my Restaurant Reporting. I will need you to give [xmlathropx@gmail.com] full access to my locations' restaurantreporting.spoton.com -  please let me know when this is complete.

Thank you!

Square Customer Setup

The account owner needs to perform the steps outlined to generate an Access Token and Application ID. Make sure that production is toggled.

  1. Open the Developer Dashboard (https://developer.squareup.com/apps) and select an existing application (or create one - call it "BarTrack")
  2. Set the dashboard mode to Production for a production access token
  3. Copy the Access Token and Application ID in the Credentials section of the page

Documentation Reference link: https://developer.squareup.com/docs/build-basics/access-tokens

image-1666205204885.png

Toast

Toast

Toast Customer Setup

Cloud Integration

ToastConfigPt1.jpg

ToastConfigPt2.jpg


Touchbistro Customer Setup

 

  1. Click on the Staff link in the left-hand navigation menu upon logging in with an administrator account.
    image-1686258026462.png

  2. Invite us to your account with an Analyst role. Select the Venus dropdown and check all the boxes next to locations to enable our access to these.image-1686258224803.png

  3. Click save. That's it, we'll get an invite email saying you've set us up, so we can complete the integration setup on our end.