Micros RES 3700 integration procedure for Foodhub agent

From the client's dashboard, go to:

Burger Menu (≡)  >> Features >> Integrations , Select Micros 3700

A new window will open called "MICROS Provisioning"

Hit "ENABLE"

1. Agent Setup

Click "EXE" button to download agent files (Archive.zip)


2. Configuration File Download


Setup and download configuration file, hit "CONFIG" button. 

Enter the client's Micros Database credentials in this format: DSN=Micros;UID=[userID];PWD=[password]
Some of the commonly used database credentials we use
Standard DSN=Micros;UID=custom;PWD=custom
Microsan: DSN=Micros;UID=custom;PWD=Kuhstom1!

Configuration file should be named "appsettings.json"

3. Install and Configuration

On the client's Micros server, go to system directory (C:\) and create a folder called "Foodhub" (need to be in correct casing).

On, C:\Foodhub directory transfer downloaded files:
 - Archive.zip 
 - appsettings.json

Extract "Archive.zip" to Foodhub folder

For re-integration or RES 3700 migrated to a new server, download and unzip the attached to system directory.
FoodHub.zip

Open "README.md" file for agent installation instructions


Right-click `install_python.bat` and select "Run as administrator"

If you encounter any issues installing Python, please follow the steps outlined below:
Download Python manually by clicking this link :  https://www.python.org/ftp/python/3.7.4/python-3.7.4.exe


Make sure Python installer is included in the "Foodhub" directory

Right click > Run as Administrator
Make sure to check "Add Python 3.7 to PATH"
Click "Install Now"

Close

Open Command Prompt / Terminal as an administrator

Navigate to "C:\Foodhub" path.

Run the command: `python install_packages.py`

Install the agent by executing: `python C:\Foodhub\agent.py --startup auto install`

Test your credentials by running: `python C:\Foodhub\agent.py debug` . You should see "Polling for operations" with no errors.

 

Start the agent in the background by running: `python C:\Foodhub\agent.py --startup auto start`

This will start the agent as a Windows Service and keep it running in the background.

4. Data Synchronization

Back to MICROS Provisioning, agent pulse will appear on the upper right corner of the page.

Hit "SYNC" to pull the updated database from the client's POS.

Once Synchronization is done, proceed with "TYPE MAPPING".

NOTE !!!
POS Configuration setup will still be the same as previous Micros 3700 integration as stated below:
 

Prerequisites

The MICROS system must be licensed for the Transaction Services API in order for the integration to work. You check if you're already licensed following these steps.

If the system is not licensed, the customer will need to contact their MICROS dealer to obtain a license. These usually cost around $800-1,000, but we can't guarantee pricing, as the rates are set by their dealers.

MICROS Configuration Steps
The following steps should be performed within POS Configurator. Clicking "SYNC" will update MICROS Provisioning page with updated data.

Setting Up Transaction Services API
 

(These steps may be done by a MICROS dealer, or may already have been completed by another API solution. If these devices/settings are already present, you can skip them and move on.)

Devices: PosAPI Web Service

• Select the Devices tab
• Select the Devices button

• One device on the list should be configured with the ​PosAPI Web Service​ device type
• If a device is not configured with that type, add it
  
  • Click the blue plus icon to add a new device
    
  • Enter a name in the left pane, like: RES API Device
    
  • Select the PosAPI Web Service device type
    
  • Select the main MICROS server under Network Node
    
• Click the folder icon if you are unsure which device to select. The main server is usually numbered either 99 or 100 and is called something like
  “MICROS,” “MICROS1,” or “SERVER”
  

• Click the green check icon to save your changes
  
• Note the number of the API device (in the screenshot above, the number is 98
  

User Workstations

• Select the Devices tab
  
• Select the User Workstations button
  

• Find the User Workstation entry that corresponds to the number from Devices, above. If an entry is not present, you may need to add it.
  
• General Tab
  
  • Set the Revenue Center to the desired revenue center (usually the main dining area, if there are multiple)
    
  • Select a Default Transaction Screen (does not matter which)
    
  • Select a Default Order Type (does not matter which)
    
• Options Tab
  
  • Check Allow Multiple RVCs
    
  • Check Suppress Print Error
    
• Order Devices Tab
  • The exact order devices will vary depending on the restaurant’s configuration
    
  • We recommend checking all devices with text configured to begin with
    
  • If the restaurant wants you to modify where ​kitchen checks ​print, you can adjust these settings, but generally speaking, they should always be enabled. This will allow the integration to route food orders to the appropriate kitchen station/printer
    

• Printers Tab
  • Note: These settings will vary considerably from installation to installation and depend on the restaurant’s configuration and desired printing output. You may need to adjust these depending on the restaurant’s printing preferences. We recommend starting with this configuration and adjusting based on feedback from test orders.
  • Usually, there are three general types of printers:
    • Front of house printers (next to registers/workstations, where cashiers are). Usually used to print guest checks, credit card slips, etc.
      
    • Kitchen printers, located where food is made/prepared/expedited. Used to print tickets for the kitchen to prep food.
      
    • Journal printers, which are usually local to each workstation and may not even be “real” printers (these may just “print” to a text file on the workstation, for example). Journaling is used to log activity on the workstations for auditing purposes
  • Set Customer Receipt Printer and Guest Check Printer to a front-of-house printer to print a guest receipt with all the order details
    
  • Local Order Printer - Usually best to leave these blank so they use the Micros defaults for the different print groups
    
  • Set Journal Printer to a printer labeled as a Journal printer (e.g. JOURNAL), if one exists
    
  • Set Backup Journal Printer to a printer labeled as a Backup Journal printer (e.g. BUP JRNL), if one exists
    
• If printing still does not work right with Local Order Printer not set, there are a couple other options. There is a Print at POS only option under the 'Options' tab or manually setting the printer for Local Order Printer
  

Employee Setup

Unless a location has already been set up with some form of online ordering, we need to set up an “Online Ordering” employee to log checks under. 

Employee Classes

• Under the Employees tab, select Employee Classes
  
• If an entry on the left pane does not exist that seems online ordering related (from a previous installation), create a new employee class using the blue plus button
  
  • Name it on the left pane with a descriptive name like Online Orders
    
  • Assign privileges as follows below
• If an employee class already exists that seems online ordering related, ensure that the privileges below are assigned
  
• Under the Guest Checks tab, there are 3 sub-tabs: Guest Check Control, Editing Checks, Other Employee’s Checks
  • Check every checkbox under these 3 tabs
    
• Under the Printing tab:
  
  • Check every checkbox ​except​ Print line-by-line receipt
    
  • Select “On Demand” for the Print Guest Check option
    

 Employees

• Under the Employees tab, select Employees
  
• Create a new employee for Online Ordering using the blue plus button
  
• Give the new employee a name like Online Orders
  
• Under the Security tab, set the Employee Class to the employee class that was created/updated in the previous section
  
• Click the green check button to save changes
  
• Different Micros setups might have different requirements like hire date, date of birth, etc. Just make these up
  

Configuring Order Types

The restaurant ​may​ wish to log online orders under special “online” order types, for reporting / organization purposes

Note: ​MICROS only offers 6 order types. If they are all in use, then it may not be possible to set up dedicated online order types. 

If the restaurant does both online pick-up and delivery, then it may be ideal to set up two new order types, one for Online Pick-up, and one for Online Delivery.

This is all technically optional for the restaurant. Online orders can simply be filed under the existing order types, but we do recommend checking to see if order types are available for use.

Configuring an Online Order Type

• Under the System tab, select Order Types
  
• Select a blank order type entry on the left pane and name it appropriately
  

• Example names: Online Pick-Up, Online Delivery, etc.
  
• The name is up to you - it is not important to our system what the type is named
  
• **Make sure "Future/Delayed Order Offset Time" is left blank or zeroed out for ONLINE-SPECIFIC ORDER TYPES. O2M handles time offsets already. If you must use an existing Order Type, leave as-is if there is something configured.
  
• Refer to an existing order type for configuration options.
  
  • Copy the configuration options from the relevant existing order type. For example, if you are configuring an Online Delivery order type, look at the existing Delivery order type for configuration
    
  • This is important because these settings vary by restaurant -- there is no one-size-fits-all configuration, and copying their existing settings is the safest way to make sure that the system behaves how they currently expect
    
  • Click the green check button to save your changes (some instances will save automatically. If the green checkmark is greyed out, it is okay)
    

Tender/Media Types 

When orders paid online with a credit card, this presents a challenge - how should the cashier close the order?

• If they close it to cash, their drawnline orders come into MICROS, by default we leave the check open. This makes it more visible within the MICROS system. When the order is completed (picked up / delivered), a cashier can retrieve the open check and close it.
  
• They cannot close it to the normal credit types (Visa, etc.) because those are configured to work with a credit card machine, and there is no actual credit card being swiped
  

The solution is to create a new payment type for Online Payments. When the cashier closes the check, they select the Online Payments type. Then, no cash is being reported, and the cash and credit totals will be correct. The reports will show a separate total for Online Payments with the reported totals, which is good.

Configuring an Online Payment Type

• Under the Sales tab, select Tender / Media
  

• General tab
  • Use the blue plus button to add a new tender/media type
    
    • In the left pane, give it a name like Online Payment
      

• Type: Payment
• SLU: PAYMENTS (or a similar type, these vary by restaurant configuration)
  
• Print Class: These vary by restaurant. Usually something like “Guest Check Only” is the best
  option, if available
  
• Menu Level Class: ALL LEVELS (if available; if not, select the highest option)
  
• Category: this should probably be set to match the same category as Visa, MC, etc. It can also be blank but make sure it is​ *not* ​set to be the same as Cash.

• Tender tab
  • Check Assume paid in full
    
  • Check Post to gross receipts
    
  • We recommend unchecking Open Drawer (if it is checked), as there should be no reason to exchange cash when using online payments
    
• Printing tab
  • Under the Printing Column
    • Check Print summary totals
      
    • Check Print sales itemizer totals
      
    • Check Print check trailer
      
  • Under the Checks column
    
    • Check Print check
      
    • Check Print memo check
      
    • Note:​ The restaurant owner/manager may request that these settings be adjusted if they do not need these check print-outs. On our initial configuration, we err on the side of over-printing, and we can turn it off if not desired

• Click the green check button to save your changes
  

RVC Interfaces

The integration sends check info lines in. To ensure that they’re available and printed, the following settings should be configured.

• Under the Revenue Center tab, select RVC Interfaces
• For the relevant Revenue Center, under the System Interface Module (SIM) tab, configure:
  
  • Print Format: Either “Before Header” or “After Header” (depending on printing preferences)
  • Number of Info Lines: 16
  • Do not display check info lines: Unchecked
• Click the green checkmark button to save your changes and exit the RVC Interfaces screen

Discount/Service Charges

Micros uses Discount/Service Charges to add line items that modify the check amount, like service fees, tips, coupons, discounts, etc.

For online ordering, we need to know about several charges and discounts:

• An “open” discount for coupons
  
• A service charge for pick-up order tips
  
• A service charge for delivery order tips (this can be the same as pick-up tips)
  
• A service charge for delivery fees
  

Usually you will not need to create new entries for these items, as restaurants already charge these fees and provide these discounts. However, they may wish to create separate entries for “online” charges/discounts vs. “normal” ones.

In that case, we recommend simply copying the existing settings, as these can vary slightly. General settings guidance is provided below.

Tips (this may already exist in their POS, if so skip this step)

Usually named something like "Charge Tip"

• General tab
  • Type: Service Charge
  • Print Class: "Guest Check Only" or similar, as the kitchen does not need to see these items
  • Menu Level Class: "All Levels"

• Options Tab
  • Amount must be checked. If Amount is unchecked, this will not work properly . 
    
    • If Amount is checked, the value is treated like a dollar amount, otherwise it is a percentage, e.g. “2.00” becomes $2.00 instead of 2%
      

• Service Charge Tab
  • Type: Standard
  • We recommend checking Post to charged tips total
    
  • Reference their existing tip configuration, as this varies by installation
    

Delivery Fees

Usually named something like “$DELIVERY” or “DELIVERY” or “DELIV FEE”

• General tab
  • Type: Service Charge
    
  • Tax Class: Usually set to the standard restaurant tax class, as delivery fees are often taxed as revenue
    
  • SLU: Usually “SERVICE CHARGES” or similar
    
  • Print Class: Usually “GUEST CHECK ONLY” or similar, as the kitchen does not need to see these fees
    
  • Menu Level Class: Usually “ALL LEVELS”
    
• Options tab
  • Amount must be checked or this will not work properly
    
• Service Charge tab
  • Type: Standard
    
  • “Post to svc charges total” is checked
    
  • “Post to charged tips total” ​is not checked
    
  • “Post to tips paid total” ​is not checked
    

Coupons

Usually named something like “$DISCOUNT” or “$ DISCOUNT”

• General tab
  • Type: Discount
    
    • When discounts and service charges are separated, this is man, auto or manually enabled auto
  • Tax Class: May be empty, or a special “DISCOUNT” tax class may be defined
  • SLU: should be empty
  • Print Class: Usually “GUEST CHECK ONLY” or similar, as the kitchen does not need to
    see these fees
    
  • Menu Level Class: Usually “ALL LEVELS
    
• Options tab
  • Amount must be checked or this will not work properly
• Discount tab
  • No selections here are strictly necessary for our integration to work, although they may have settings checked like Item Discount
• Itemizers tab
  • ​Check all the itemizers options on this new coupon created for online orders.