Introduction to Omnivore's Micros3700 POS Integration
Please refer to this link to fill out the Agent configuration submission form:
Micros3700 Integration Form
The Omnivore Micros integration utilizes the Micros Transaction Services to inject orders and retrieve POS data for pricing and menu availability. The communication happens through a locally installed Omnivore Agent service called the POS Agent.
Our integration is able to place orders from various products, marketplaces, and partners directly into Micros. This allows for an above-store, centralized management of the online ordering experience.
The Omnivore Team will often refer to this integration as "Res or 3700".
Connecting Micros POS to Omnivore
The Omnivore Micros integration is referred to as a Traditional or Push POS. This requires a local agent installed on the Micros BOH. Prior to the agent installation, the Micros needs to have an active Transaction Services license and the integration programmed into the Micros database. The integration will also require information out of the database for Omnivore configurations.
Devices
For device setup please use the link below
- Click the blue + button at the top to insert a new device.
- Enter number 975 and enter name “POS API” on the left.
- Choose “PosAPI Web Service” as the Device Type
- Choose the back of house computer as the Network Node
- Click the green ✓ at the top
Need more details? Click Here
Workstation
- Click the blue + button at the top to insert a new workstation
- Click the Device Name on the left
- From the dropdown choose the Web Service Device Name from the previous step
- Select a default revenue center and default order type in the General Tab;
- Select the Order Devices Tab and check all Order Devices that are listed.
- Select Printers tab. Ask the merchant which printers they would like their guest check receipts to print (only for Ordering and Payment App partners) and assign them to the top two printer boxes, and select a journal printer at the bottom for internal audits if possible.
- Click the green ✓ at the top
Need more details? Click Here
Employee Class
- In POS Configurator click the Employees tab at the top
- Click the Employee Classes button
- Click the blue + button at the top to insert a new employee class
- Enter 975 for the number and name, “POS API” on the left
- In the new window click the Transactions tab on the right
- Click the Transaction Control tab below it
- Set POS API Employee on the right, and click Yes in the confirmation window.
- Click the green ✓ at the top
Need more details? Click Here
Employees
- In POS Configurator click the Employees tab at the top
- Click the Employees button
- Click the blue + button at the top to insert a new employee
- Enter 975 for the number and name, “POS API” on the left.
- In the General tab, fill out First and Last name fields.
- In the Security tab, assign the employee to the POS API Employee Class using the dropdown..
- Under the POS tab select a Revenue Center.
- Click the green ✓ at the top
Need more details? Click Here
Service Total
Only need to access the General and Service TTL tabs for this step..
- Click on Sales tab in the top left of POS Configurator window
- Click the Tender / Media button.
- Click the blue + button at the top to insert a new record..
- Enter 975 for the number and name, “API SVC” on the left.
- In General tab, set the “Type” to Service Total, and Menu Level Class to “All”
- Click on the Service TTL tab, and check the boxes for “Send Order” and “Fire Order”.
- Click the green ✓ at the top.
Need more details? Click Here
Optional Configurations:
Tenders
- Click the Sales tab at the top
- Click Tender / Media
- Click the blue plus sign to insert a new tender record
- Enter a short name beside the number on the left
- On the General tab:
- Choose “Payment” from the Type dropdown
- Choose “All Levels” from the Menu Level Class dropdown
- Choose “Guest Check/Receipts” from the Print Class dropdown
- Click on the Tender tab:
- Click on the boxes for:
- Use with currency conversion
- Item is shareable
- Post to gross receipts
- Post to charge receipts
- Assign Charged Tip to the Charge Tip dropdown as directed by the operator.
- Click on the Printing Tab:
- Check the boxes for:
- Print Summary Total
- Print on Receipt Printer
- Print Check
- Click the green ✓ at the top.
Need more details? Click Here
Menu Item Class
- Go to the Sales tab and click Menu Item Classes.
- Click the blue plus sign to insert a new menu item class record.
- Enter a short name beside the number on the left.
- In the Description tab, select Food as Sales Itemizer.
- For $0.0 items, go to the Price/Totals tab and select “Preset”.
- Click the green ✓ at the top.
If a partner needs to have an item to free type information, go to General Options tab and select “Reference Required”.
Need more details? Click Here
Menu Item
- Click the blue plus sign to insert a new menu item record
- on the Definition > General tab
- enter a short name for the item in Name1
- choose the new menu item class from the Menu Item Class dropdown
- choose “All Levels” from the Menu level Class dropdown
- Choose a print class for the new menu item (All new menu items must have a print class associated for the item to show on the terminal and/or print to receipt/kitchen printers)
- On the Reporting tab
- choose a Major Group from the dropdown (Misc or Food)
- choose a Family Group from the dropdown (Misc, Sides or Food)
- Click the green ✓ at the top.
Need more details? Click Here
Details
Micros3700 Device Setup for Omnivore
- In POS Configurator click the Devices tab at the top.
- Click the Devices button.
- In the new window check each device to ensure none have the Device Type “PosAPI Web Service”
- If one does exist, note the name and number and move to next step (User Workstations) to verify config.
- In the new window check each device to ensure none have the Device Type “PosAPI Web Service”
- If one does exist, note the name and number and move to next step (User Workstations) to verify config.
To Create Web Service Device:
- Click the blue + button at the top to insert a new device.
- Enter number 975 and enter name “POS API” on the left.
- Choose “PosAPI Web Service” as the Device Type
- Choose the back of house computer as the Network Node
- Click the green ✓ at the top
Micros3700 Workstation Setup for Omnivore
Create User Workstation
- Click the blue + button at the top to insert a new workstation
- Click the Device Name on the left
- From the dropdown choose the Web Service Device Name from the previous step
- Select a default revenue center and default order type in the General Tab
- Select the Order Devices Tab and check all Order Devices that are listed.
- Select the Printers tab. Ask the merchant which printers they would like their guest check receipts to print (only for Ordering and Payment App partners) and assign them to the top two printer boxes, and select a journal printer at the bottom for internal audits if possible.
Micros3700 Employee Class Setup for Omnivore
- In POS Configurator click the Employees tab at the top
- Click the Employee Classes button
- Enter 975 for the number and name, “POS API” on the left
- In the new window click the Transactions tab on the right
- Click the Transaction Control tab below it
- Set POS API Employee on the right, and click Yes in the confirmation window
- Optional: Second Partner Employee Class (based on Customer Requirements)
Micros3700 Employee Setup for Omnivore
- In POS Configurator click the Employees tab at the top
- Click the Employees button
- Click the blue + button at the top to insert a new employee
- Enter 975 for the number and name, “POS API” on the left.
- In the General tab, fill out First and Last name fields.
- In the Security tab, assign the employee to the POS API Employee Class using the dropdown
- Under the POS tab select a Revenue Center
- You may be required to fill in other fields like hire date, date of birth, etc. It doesn’t matter what you supply for these value
Optional: Partner Employees (Based on Merchant Requirements)
- Repeat the above steps to create an employee that is for your records.
Micros3700 Service Total Setup for Omnivore
- Click on Sales tab in the top left of POS Configurator window
- Click the Tender / Media button.
- Only need to access the General and Service TTL tabs for this step.
- Click the blue + button at the top to insert a new record..
- Enter 975 for the number and name, “API SVC” on the left.
- In General tab, set the “Type” to Service Total, and Menu Level Class to “All”
- Click on the Service TTL tab, and check the boxes for “Send Order” and “Fire Order”.
Micros3700 Item Class Setup for Omnivore
**Some Partners (such as Chowly) require the creation of their own Menu Item Class. Depending on the partner there will be a request for a $0.00 item, and/or a Open Item.
Go to the Sales tab and click Menu Item Classes.
Click the blue plus sign to insert a new menu item class record.
Enter a short name beside the number on the left.
In the Description tab, select Food as Sales Itemizer.
For $0.0 items, go to the Price/Totals tab and select “Preset”.
If a partner needs to have an item to free type information, go to General Options tab and select “Reference Required”.
Click the green ✓ at the top.
Micros3700 Item Setup for Omnivore
- Go to the Sales tab and click on Menu Items.
- on the Definition > General tab
- enter a short name for the item in Name1
- choose the new menu item class from the Menu Item Class dropdown
- choose “All Levels” from the Menu level Class dropdown
- Choose a print class for the new menu item (All new menu items must have a print class associated for the item to show on the terminal and/or print to receipt/kitchen printers)
- On the Reporting tab
- choose a Major Group from the dropdown (Misc or Food)
- choose a Family Group from the dropdown (Misc, Sides or Food)
Micros3700 Employee Class Setup for Omnivore
- Go to the Sales tab and click Menu Item Classes.
- Enter a short name beside the number on the left.
- In the Description tab, select Food as Sales Itemizer
- For $0.0 items, go to the Price/Totals tab and select “Preset”.
- If you need to have an item to free type information, go to the General Options tab and select “Reference Required”.
Micros3700 Troubleshooting for Omnivore
Database access
If your micros database has a custom login that is not the below then you will need to add in the line as such in the general.ini to replace the connection string. General.ini can be located in C:\Program Files (x86)\POS Agent
- This is the line to replace the connection string with. Put in the username and password where it shows.
- sybase+pyodbc://username:password@Micros
- Several defaults include:
- sybase+pyodbc://custom:custom@Micros
- sybase+pyodbc://custom:custom37@Micros
Restart the POSAgent and POSAgent Updater services once this has been replaced the general.ini
Create DB User in Micros 3700
Open “run” and enter “dm”
Click on the Users tab on the right
Uncheck “change users passwords” and check “create new user”
For all three columns (username, password) use “omnivore”
Click “Create New User” and see the confirmation in box above
Close out dm and navigate to general.ini
Update encrypted connection string with “sybase+pyodbc://omnivore:omnivore@Micros”
Save, close, go back to “run” and enter “services.msc”
Stop the “POS Agent” and “POS Agent Updater”
Wait about ten seconds, start them back up again and go refresh the cache
Watch the logs and wait for cache to complete
KDS users on Micros v5.7 need adjustments for printing:
In the API Workstation in the General Tab activate these options;
- Disable error beer
- Suppress Print Error
- Order device printing at POS only
- Guest Check printing at POS only