Skip to main content
  Sign in

Quick Steps

Labels

Article

Secure Suite 4 Micros

Enable Settings

Still Have Questions? Submit a Request

Or Call (888) 857-9751.

Or Call (888) 276-2108.

MICROS RES 3700 Setup Guide for Shift4 Bridge

Catherine Harper
  • Updated
  1. Shift4 Payments
  2. Self Help Product Categories
  3. ...
  4. Oracle MICROS
  5. MICROS RES 3700
  6. Shift4 Bridge
  7. Setup & Configuration

Description: This guide is designed to assist with a new setup of Shift4 Bridge driver for use with MICROS RES 3700 systems.

Pre-Install Considerations

 Product Version  Solution .Net Version EMV SkyTab

 

RES 3700

 

4.0-5.5+

Shift4 Bridge 

4.6.2

✓

✓

Note: The Shift4 Universal Transaction Gateway (UTG) Service will need to be installed on a machine with Windows 7 or higher.

 

Validating .NETFramework Requirements

  1. See, Validate or Update .NETFramework Version.

Validating MICROS RES 3700 Licences

To verify Micros licensing, you can check the License Manager app to get there you go to Start > MICROS Applications > License Manager on the micros server, then select the POS 3700 tab.

  • Alternatively, you can access the License Manager by going to Start > Run and typing licmanager.

There are two licenses that are required, the PMS/SIM and Transaction Services.

The license will have a red 'x’  or a green checkmark  next to it, which identifies if a license is present. You can re-verify this by double-clicking on the license in question to trigger a status check.

If any of the required licenses are not valid then the merchant will need to obtain a valid license before installing the Shift4 Bridge.

image-6__6_.png

 

Backing Up the MICROS RES 3700 Database

It is recommended that before any changes are made that a backup of the MICROS Database is created.
This operation should only be performed if a scheduled backup has not occurred within the last 24 hours. You can validate the date and time of the last backup in ...\micros\database\data\backup\MICROS_year_month_day_hour_minutes.mbz5
  1. On the MICROS server navigate to Start > MICROS Applications > Utilities > Database > MICROS Database Manager.
    • You can also locate this in the install directory of ...\MICROS\common\BIN\DM
    • This can also be searched using the keyword of "Database" within windows search.

mceclip0_-_2022-06-07T111042.368.png

  1.  The MICROS user will need to log into their MICROS Database Administrator at this time.
    • If the options on the screen when logged in are greyed out, then another user with higher privileges will be needed.
  2. On this screen select "Backup Database" on the right side and ensure the following:
    • Enable: Backup Database
    • Enable: Validate Database
    • Enable: Backup Passwords - Keys
  3. Once the above is configured select Run Backup at the bottom left.
    • The file will begin to backup the database, this is complete when the line of "Rotating Micros backup files complete." appears on the text field above these options.
Closing this screen without seeing the "Rotating Micros backup files complete message " will stop the backup process. Do not close this window until complete.

mceclip2__49_.png

 

Configuring Ingenico Hardware

Modern devices come pre-configured from the key injection facility. You will need to validate that the device(s) are configured to the desired communication method of Ethernet. The current device configuration can be validated during the device reboot process on the Ingenico Copyright screen.

 

Model Type

Reset Procedure

 iSC 250/480:

Press and Hold the Clear (Yellow) and the Minus (-) keys until the device chirps.

iPP 320/350:

Press and Hold the Clear (Yellow) and the Period (.) keys until the device chirps.
If you are using a device with a black and white screen you will need to scroll down to view this detail.

image-7__3_.png  image-8__5_.png

This detail should show as “HOST: Ethernet: Server: Static:”

  • If the device shows anything other than the message above on the HOST line, you will need to reconfigure the device for the proper settings. Re-configuring for Ethernet: Server: Static:
  • If the device is configured properly, you only need to assign a unique network IP address to the device, continue to Configuring IP Address Only.

Configuring IP Address Only

  1. Begin by rebooting the device
  2. When on the Ingenico Copyright screen press 2, 6, 3, 4, and Enter. Shortly after this, the device will ask you to either press (+) Plus or (F) Function for menu.
    • If your device is requesting to press (F) for Menu but your unit doesn't have a function key simply press (+) Plus instead.
  3. Scroll to the TDA Menu and select this:
    • For iSC 250/480 use the [+] and [-] keys to navigate and select [Enter].
    • For iPP 320/350 use the [F2] and [F3] keys to navigate and select [Enter].
  4. Press [0] for Configuration.
  5. Press [0] again for communication.
  6. Press [2] for Ethernet Settings.
  7. Press [3] to set the IP address.
    • This is determined by property IT. Three digits must be entered for each octet so an IP address of 10.0.1.193 would be entered as 010.000.001.193.
  8. Press [Cancel] when complete to return to the Ethernet Settings menu.
  9. Press [4] to enter the Subnet Mask.
    • This is determined by property IT. Three digits must be entered for each octet so an IP address of 255.255.255.0 would be entered as 255.255.255.000
  10. Press [Cancel] when complete to return to the Ethernet Settings menu.
  11. Press [5] to set the Default Gateway.
    • This is determined by property IT. Three digits must be entered for each octet so a Default Gateway IP address of 10.0.1.1 would be entered as 010.000.001.001.
  12. Press [Cancel] Until the device will ask you to Save Settings and Reboot? Select Yes.
  13. The device will reboot and it can be left alone for now.

 

Re-configuring for Ethernet: Server: Static:

  1. Begin by rebooting the device
  2. When on the Ingenico Copyright screen press 2, 6, 3, 4, and Enter. Shortly after this, the device will ask you to either press (+) Plus or (F) Function for menu.
    • If your device is requesting to press (F) for Menu but your unit doesn't have a function key simply press (+) Plus instead.
  3. Scroll to the TDA Menu and select this:
    • For iSC 250/480 use the [+] and [-] keys to navigate and select [Enter].
    • For iPP 320/350 use the [F2] and [F3] keys to navigate and select [Enter].
  4. Press [0] for Configuration.
  5. Press [0] again for communication.
  6. Press [0] again for Comm. Type.
  7. Press [1] for Ethernet. (Sometimes this option can be listed as [2] depending on your RBA build.)
  8. Press [Cancel] when complete to return to the TDA menu.
  9. Press [0] for Configuration.
  10. Press [0] again for communication.
  11. Press [2] for Ethernet Settings.
  12. Press [0] for the Connection Method and then select [1] for Server.
  13. Press [Cancel] when complete to return to the Ethernet Settings menu.
  14. Press [1] for DHCP to choose whether the IP address will be static or assigned by a DHCP Server.
  15. Press [1] to set a Static IP (Preferred)
  16. Press [0] if the IP is handled via a router with DHCP enabled (Dynamic Host Configuration Protocol)
  17. Press [Cancel] when complete to return to the Ethernet Settings menu.
  18. Press [3] to set the IP address.
    • This is determined by property IT. Three digits must be entered for each octet so an IP address of 10.0.1.193 would be entered as 010.000.001.193.
  19. Press [Cancel] when complete to return to the Ethernet Settings menu.
  20. Press [4] to enter the Subnet Mask.
    • This is determined by property IT. Three digits must be entered for each octet so an IP address of 255.255.255.0 would be entered as 255.255.255.000
  21. Press [Cancel] when complete to return to the Ethernet Settings menu.
  22. Press [5] to set the Default Gateway.
    • This is determined by property IT. Three digits must be entered for each octet so a Default Gateway IP address of 10.0.1.1 would be entered as 010.000.001.001.
  23. Press [Cancel] when complete to return to the Ethernet Settings menu.
  24. Press [9] to set the IP Port.
    • The default port setting is 12000 though the property IT could choose to change this under rare circumstances. 
  25. Press [11] to set the SSL settings. (RBA 21+ only) This setting was added in RBA 21 and should always be set to no.
  26. Press [Cancel] Until the device will ask you to Save Settings and Reboot? Select Yes.
  27. The device will reboot and it can be left alone for now.

 

The Universal Transaction Gateway (UTG)

1. Go to Start > All Programs > Shift4 Payments > Universal Transaction Gateway > UTG (v2) TuneUp.

 

The Express Tab

  1. Station Name = REST
  2. Serial = This will be supplied by Shift4 on the UTG Config Sheet under Serial Number:
  3. Host Address = MICROS server IP address (example: 192.168.100.250)
  4. Location = ZIP Code
  5. API Serial Number and Password = Leave these blank

 

The API Interfaces Tab

  1. Select Add, then REST
  2.  Host Address = MICROS server IP address (example: 192.168.100.250)
  3. Port = This must be 277
  4. Select Generate Certificate and fill in the appropriate information
    • Common Name = MICROS Bridge
    • Friendly Name = This entry is not critical for functionality.
    • Organization = Merchant's name with location if multiples
    • Email Address = Site's main contact email (owner, GM, etc…)
    • Locality = City
    • State/Province = State (Abbreviation will work, as long as no special characters are included.)
    • Country = US
    • DNS Tab – In the DNS box, you need to add two things:
      • MICROS Server IP Address (on the first line)
      • localhost (on the second line) Please be aware that you are typing the WORD ‘localhost’ not using the actual localhost I.P on this line.
    • CA SelfSigned / Intermediate – Select the following items:
      • SelfSigned
      • CRT
      • Server Authentication
      • Client Authentication
      • 4096 bit
      • **MAKE SURE Embed Key in unchecked**
      • Enter a password and make sure you keep this somewhere safe for your records (you will also need this for the next couple of steps after the certificate is generated)
    • Click on Generate – This will prompt you for the folder where the certificate and key will be saved. Save it to C:\Shift4\. After about 30 seconds, you should see SUCCESS at the bottom, then Exit
  5. Certificate File – Browse to C:\Shift4\ and select the *.crt file within (you will need to change to see All Files, as it defaults to *.cer)
  6. Certificate Password – Enter the password that you created above
  7. Private Key File – Browse C:\Shift4\ and select the *.key file within (you will need to change to see All Files, as it defaults to *.cer)
  8. Private Key Password – Enter the password that you created above
  9. Select OK

Devices Tab

  1. Select Add, then fill in the appropriate PIN pad info:
    • Device Name = PinPad-101 (where 101 matches the Workstation name - WS6-101, etc…)
    • Device Type = Select the appropriate type (we normally use Ingenico iPP 320 RBA)
    • API Terminal ID = This will be supplied by Shift4 on the UTG Config Sheet.
    • Connection = This will normally be Direct TCP/IP
    • IP Address = PIN pad IP address (example: 192.168.100.1) – If the workstation is 192.168.100.101,
    • Port = 12000 if you are using the default on the iPP 320
    • Manual Card Entry = Enable MCE
    • Select Disabled for CVV Code, Street Number, and Zip Code
    • Source Serial = This will be supplied by Shift4 on the UTG Config Sheet as Serial Number:
    • Select Contactless Enabled and Bypass Amount OK
  2. Select OK and repeat as many times as necessary for each PIN Pad

[Option] Advanced Tab 

(If the D:\ drive was used for installation)

  1. Select Trace Configuration and make sure the directory within is D:\Shift4\UTG2\Trace\, then OK.
  2. Select Splunk Configuration and make sure the directory within is D:\Shift4\Splunk\, then OK.

Finish

  1. Once you have verified all the data is accurate across all of the above tabs, select the Save button, and TuneUp will close.

 

 

Configuring MICROS RES 3700 POS Configurator

 

It is important to know that any time a Record Number or Record Name is spoken of, these details should be written down for later use during the setup. These values are found in the “Record View” tab on each of the configuration pages. These values will be needed throughout the setup of the POS Configurator and the Shift4 Bridge. Ex: (# Record Name)

 

image-9__4_.png

 

To start navigate to ...\MICROS\Res\Pos\Bin on the Micros Server and open poscfg. This opens the POS Configurator.

Merchant will need to enter their MICROS username and password at this time.

 

Network Node

image-10__4_.png

  1. Once logged in, select the Devices Tab, and then Network Node.
    • Click on each Record listed here to identify the Workstation Type.
      1. Anything listed as "Server" Record the Record Number and Record name.
      2. Anything listed as "Workstation" Record the Record Number and Record name.

image-11__3_.png

 

Interfaces

image-12__3_.png

  1. Now return to the POS Configurator then select Interfaces.
    • Add an interface record image-13__3_.png and configure the following,
    • Outgoing Message Name: Shift4
    • Timeout: 120 (Can be lower for testing, but this must be 120 for live setup.)
    • Network Node: Set to MICROS RES 3700 Server Name
    • Number ID Digits: 9
    • Interface Type: TCP
    • SIM Interface: Enabled
  2. Now select the Interface Tab on this screen and configure the following,
    • TCP Server Name: 127.0.0.1
    • TCP Port Number: 5008
  3. Save the Config when done by pressing the green checkmark. image-14__4_.png

RVC Interfaces

image-15__2_.png

  1. Now return to the POS Configurator and select the Revenue Center, and then RVC Interfaces.
    • Record the Record Number and Record Names associated with each Revenue Center listed.

 

Tender/Media

image-16__2_.png

  1. Now return to the POS Configurator and select the Sales tab, and then Tender/Media.
    • Find the "Auth" Type Record, and configure with the following settings,
      • (Any Tabs, Sub Tabs, or Setting Values not listed below should be disabled, unassigned, or blank.)
      • General Tab > Type: Payment
      • General Tab > SLU: [BLANK]
      • General Tab > Print Class: Journal and Reports
      • General Tab > Menu Level Class: All Levels
      • General Tab > Privilege: 0
      • General Tab > Category: 1
      • Tender Tab > Charged Tip: [BLANK]
      • PMS Tab > Post 0.00 Amounts To PMS: Enabled
      • PMS Tab > Allow 19 reference characters: Enabled
      • PMS Tab > Property Management Interface: (# Shift4)
      • Service TTL Tab > Send Order: Enabled
      • Service TTL Tab > Keep Held Status: Enabled
      • Printing Tab > Print Summary Totals: Enabled
      • Printing Tab > Print Check Trailer: Enabled
      • Printing Tab > Print-Multiple Checks/Receipts: Enabled
      • Printing Tab > Print Check: Enabled
      • Printing Tab > Print Memo Check: Enabled
      • Printing Tab > Reprint Check: Enabled
      • Save the Config when done by pressing the green checkmark. image-14__4_.png 
  2. Now Find the following “Card” Type Record and click on it to edit,
    • Visa
    • MC
    • Amex
    • Discover
    • JCB (Japanese Credit Bureau)
      • Configure the above with the following settings,
        • (Any Tabs, Sub Tabs, or Setting Values not listed below should be disabled, unassigned, or blank.)
        • General Tab > Type: Payment
        • General Tab > SLU: [BLANK]
        • General Tab > Print Class: Guest Check
        • General Tab > Menu Level Class: All Levels
        • General Tab > Privilege: 0
        • General Tab > Category: 1
        • Tender Tab > Charged Tip: Charged Tips
        • Tender Tab > Post To Gross Receipts: Enabled
        • Tender Tab > Post To Charged Receipts: Enabled
        • PMS Tab > Post 0.00 Amounts To PMS: Enabled
        • PMS Tab > Allow 19 reference characters: Enabled
        • PMS Tab > Property Management Interface: (# Shift4)
        • Service TTL Tab > Fire Order: Enabled
        • Printing Tab > Print Summary Totals: Enabled
        • Printing Tab > Print Check Trailer: Enabled
        • Printing Tab > Print-Multiple Checks/Receipts: Enabled
        • Printing Tab > Print Check: Enabled
        • Printing Tab > Print Memo Check: Enabled
        • Printing Tab > Reprint Check: Enabled
        • (Repeat for each needed Tender Type.)
        • Save the Config when done by pressing the green checkmark. image-14__4_.png
When configuring the Shift4 Bridge, there are three additional tenders that need to be configured within the Tender Media setting within the POS Configurator. If these tenders are not configured, the Shift4 UTG Bridge will not work.
  1. Print: 
    • General Tab > Type: Service Total
    • General Tab > Print Class: Guest Check
    • General Tab > Menu Level Class: All levels/All-day
    • Service TTL Tab > Fire Order: Enabled
    • Printing Tab > Print Summary Totals: Enabled
    • Printing Tab > Print Check Trailer: Enabled
    • Printing Tab > Print on receipt printer: Enabled
    • Printing Tab > Print endorsement: Enabled
    • Printing Tab > Print Check: Enabled
    • Printing Tab > Reprint Check: Enabled
    • Save the Config when done by pressing the green checkmark. image-14__4_.png
  2. Send & Exit: (Menu items are sent to the order device (ex. kitchen) and the check is exited out of)
    • General Tab > Type: Service Total
    • General Tab > Print Class: Guest Check
    • General Tab > Menu Level Class: All levels/All-day
    • Service TTL Tab > Fire Order: Enabled
    • Printing Tab > Print Summary Totals: Enabled
    • Printing Tab > Print Check Trailer: Enabled
    • Printing Tab > Print on receipt printer: Enabled
    • Printing Tab > Print endorsement: Enabled
    • Printing Tab > Print Check: Enabled
    • Printing Tab > Reprint Check: Enabled
    • Save the Config when done by pressing the green checkmark. image-14__4_.png
  3. Send & Stay: (Menu items are sent to the order device (ex. kitchen) but the open check stays on the screen).
    • General Tab > Type: Service Total
    • General Tab > Print Class: Guest Check
    • General Tab > Menu Level Class: All levels/All-day
    • Service TTL Tab > Send Order: Enabled
    • Service TTL Tab > Fire Order: Enabled
    • Printing Tab > Print Summary Totals: Enabled
    • Printing Tab > Print Check Trailer: Enabled
    • Printing Tab > Print on receipt printer: Enabled
    • Printing Tab > Print endorsement: Enabled
    • Printing Tab > Print Check: Enabled
    • Printing Tab > Reprint Check: Enabled
    • Save the Config when done by pressing the green checkmark. image-14__4_.png
Don't forget the Tender Type, Send & Stay, Send & Exit, and Print Record Numbers and Record Names! You will need this later during setup!

Now return to the POS Configurator and select the  Devices Tab and then Touchscreen Designer.

 

Touchscreen Designer

image-17__2_.png

Configure Each Individual Button With The Following:

  1. Button: Auth (CC Auth)
    • Category = SIM/PMS Inquire.
    • Interface = (# Shift4)
    • Inquire # 1
    • This function performs the basic credit card authorization.
  2. Button: Manual Auth (Offline Auth)
    • Category = SIM/PMS Inquire.
    • Interface = (# Shift4)
    • Inquire # 2
    • This function performs the basic credit card authorization when a voice auth has been obtained from Shift4.
  3. Button: Final (CC Close)
    • Category = SIM/PMS Inquire.
    • Interface = (# Shift4)
    • Inquire # 4
    • This function performs the basic Capture to complete the payment based on an existing authorization.
  4. Button: Sale (CC Auth & Close)
    • Category = SIM/PMS Inquire.
    • Interface = (# Shift4)
    • Inquire # 5
    • This function performs the basic Auth/Capture/tip in one function to complete the payment. This would be used in a quick-service environment or other similar situations.
  5. Button: Sale (No Tip)
    • Category = SIM/PMS Inquire.
    • Interface = (# Shift4)
    • Inquire # 15
    • This function performs the basic Auth/Capture in one function to complete the payment. This would be used in a quick-service environment or other similar situations.
  6. Button: Manual Sale (Offline Auth & Close)
    • Category = SIM/PMS Inquire.
    • Interface = (# Shift4)
    • Inquire # 6
    • This function performs the basic Auth/Capture in one function to complete the payment when a voice auth has been obtained from Shift4. This would be used in a quick-service environment or other similar situations.
  7. Button: Refund (CC Refund)
    • Category = SIM/PMS Inquire.
    • Interface = (# Shift4)
    • Inquire # 7
    • This function performs a refund onto the card.
      • Note: The Refund Key MUST be placed on a screen that is only accessible to a Manager who can perform the following:
      • Ring Negative Checks
      • Direct Void
      • Pay Negative Checks
  8. Button: Reprint Chits (CC Reprint)
    • Category = SIM/PMS Inquire.
    • Interface = (# Shift4)
    • Inquire # 8
    • This function attempts to reprint the last chits that were printed for a specific transaction.
  9. Button: Void
    • Voids do not have a separate key. When a Sale or Capture is voided, the interface will process the void.
  10. Equal Split Pay Mode Toggle
    • Category = SIM/PMS Inquire.
    • Interface = (# Shift4)
    • Inquire # 9

    • This function Toggles on/off Equal Split Pay mode.  When it is off, pressing this key will prompt for the number of cards to use, and will enter Split Mode.  When it is on, pressing this key will cancel Split Pay Mode.

  11. Save the Config when done by pressing the green checkmark. image-14__4_.png

 

[OPTION] SkyTab Devices

At this time, if you are not using SkyTab and you have been provided with a Shift4 Appliance server, see Configuring The Shift4 Appliance; otherwise, see Installing and Configuring the Shift4 Interface.

  1. Access the MICROS POS Configurator.
  2. Click on the Devices Tab.
  3. Select Devices. This opens the Device screen.
  4. Add a new Device Record press the Blue Plus Sign. [image-13__3_.png]
    • You can name this record SKY TAB API.
  5. In the General tab ensure the following:
    1. Device Type = PosAPI WEB Service.
    2. Network Node = The MICROS Server Node.
  6. Press the Green Checkmark [image-14__4_.png] at the top when finished to save this setting.

 

[OPTION] SkyTab User Workstations

  1. Access the MICROS POS Configurator.
  2. Click on the Devices Tab.
  3. Select User Workstations. This opens the User Workstations Screen.
  4. Add a new User Workstation Record press the Blue Plus. image-13__3_.png
    1. Name this SKY TAB INTERFACE.
    2. Select the SKY TAB API you set up in the previous step.
  5. Ensure the following settings are set up on the General Tab:
    1. Revenue Center: The revenue center that will be processing the payments.
    2. Default Order Type: The order type.
  6. Press the Green Checkmark [image-14__4_.png] at the top when finished to save this setting.

 

[OPTION] SkyTab Menu Item

image-18__2_.png

  1. Now return to the POS Configurator and select the Sales tab and Select Menu Item Classes.
    • Add a Class image-13__3_.png This should be named $0.00 / REF and configured as follows.
    • Description Tab > Sales Itemizer: Food
    • Description Tab > Tax Class: No Tax
    • Description Tab > Discount Itemizer: 1
    • Description Tab > Print Group: 3-
    • Description Tab > Service Itemizer: 1
    • General Options Tab > Retail Items: Enabled
    • General Options Tab > Reference Required: Enabled
    • Price/Totals Tab > Preset Prices: Enabled
    • Save the Config when done by pressing the green checkmark. 
  2. Now return to the POS Configurator on the Sales Tab and Select Menu Item.

image-19__1_.png

  • Add an Item image-13__3_.png This should be named SkyTab TrID and configured as follows.
  • Description Tab > Name1: SkyTab TrID
  • Description Tab > Menu Item Class: (# $0.00 / REF)
  • Description Tab > Menu Level Class: All Levels
  • Description Tab > Print Class: Guest Check
  • Description Tab > SLU: [BLANK]
  • Reporting Tab > Major Group: Misc & Llaneous
  • General Options Tab > Family Group: Appetizers
  • Prices Tab > Fixed Pricing: Set All Price(s) to 0.00
  • Save the Config when done by pressing the green check mark. image-14__4_.png

 

Configuring The Shift4 Appliance

If you are using a Shift4 Provided External Mini-PC to host the Shift4 Bridge and UTG Service application alongside your MICROS RES 3700 solution perform the following; Otherwise, continue with the next section, Installing and Configuring the Shift4 Interface.

Appliance SQL/ODBC Configuration

The Shift4 Bridge Interface Appliance requires the ability to connect the server database located on a
different POS on the network. The steps below outline setup of SQL Anywhere 17. This version is
backward compatible with previous version of Sybase ODBC driver used in early versions of RES 3700.

ODBC Config

  1. Open ODBC Data Sources (32-bit)
    • This program can be easily found by opening the start menu and typing “ODBC”
    • You can also open this program by selecting this icon on the desktop (see below):

mceclip0_-_2022-06-07T111553.325.png

mceclip1__57_.png

  1. Once the application is open switch to the “System DSN” tab
  2. Click “Add...”
    Note: Micros is only compatible with the 32-bit version of ODBC

mceclip2__50_.png

  1. Scroll down the list of Data Sources until you see ‘SQL Anywhere 17’.
  2. Select SQL Anywhere 17 and select ‘Finish’

mceclip4__27_.png

  1. Configure the ODBC Tab as below.
    • Data source name: Micros
    • Description: A brief description of the Micros Server type
    • Microsoft applications: Checked
    • Delphi applications: Checked
    • Describe Cursor Behavior: If Required

mceclip5__16_.png

  1. Configure the Login tab:
    • Authentication: Database
    • User ID: database username (usually custom)
    • Password: database password (usually custom)
    • Encrypt password: None
    • Action: Connect to a running database on another computer
    • Host: IP Address of the Server station
      • Open up the Command Prompt via your Windows Start menu Type in “ipconfig” and hit Enter Look for the line that reads “IPv4 Address” The number across from that text is your local IP address of the Server
    • Port: Leave blank
    • Server name: sql + Name of the Server station
      • In this example, the server station’s name is “OPIPCRES54”
      • Server name requires sql to be added before the name of the station, in this case it will be “sqlOPICRES54”
    • Database name: Name of the database on the Server station.

mceclip6__9_.png

  1. When finished, return to the ODBC tab and click ‘Test Connection’

• If successful: move to the next section Installing and Configuring the Shift4 Interface.

mceclip7__11_.png

• If unsuccessful:

mceclip8__9_.png

  • Be sure the IP address of the server is correct in the Login tab
  • If so, try pinging the IP address from the Windows command prompt to make sure the appliance is able to communicate with the server.
  • Verify the User ID/Password is correct in the Login tab - in rare cases custom/custom may not work if a new one was created
  • Port should be blank, you will receive this error if a port is entered
  • Double check that the Server name is correct, and that sql has been added before the name
  • Double check that the Database name is correct

 

Installing and Configuring the Shift4 Interface

Note: When installing, if you encounter a windows installer error message to the effect of “A newer version of this application is already installed on this computer”, check to see if they have the Skytab Interface installed. If they do, uninstall the Skytab interface, then install the Bridge/Shift4interface, and then reinstall SkyTab.

You need to enter the configuration settings that will be used by the Shift4 Interface. This is done through the Shift4Config program, which is located in the ...\Shift4Interface folder.

Do not use a Database Administrator Login for this access. Use the Custom user or another user log-in with read only privileges to the SQL Anywhere Database.
  1. Run the Shift4Config.exe program.
  2. Log in using the “Custom” Database User. 
  • Username: custom
  • Password: custom

image-20__1_.png

General Tab

Enter all configuration settings on the General Tab once logged in.

  • Postal Code (ZIP Code)
    • The site’s postal code.
  • Log Verbosity (4)
    • 1 = low, 9 = Very High
  • Interface Link (# Shift4)
    • The Interface Link you selected for this interface in POS Configurator.
    • Rename ISL - Pressing this button will create the pmsNNN.isl file. This button will also select either the standard Shift4.isl file, or the Shift4_noinclude.isl file, depending on the configuration. The Installer will still need to copy that file to the appropriate CAL folders.
  • Include File Not Supported
    • On older versions of RES, include files are not supported.  If you have one of those versions, check this box. (RES 5.0 and below)
  • Interface Port (5008)
    • The tcp port you selected for this Interface in POS Configurator.
  • Micros Interface Timeout (118)
    • The timeout you selected for this Interface in POS Configurator configure 2 fewer seconds for this value.
  • UTG Timeout (116)
    • The timeout that the interface will wait for a response once a request has been sent to UTG. Generally, set this to be 2 seconds less than the Micros Interface Timeout.
  • Invoice Wait time after Timeout: (1)
    • In Production, set this to 1 or 2 seconds. On a test platform, use 3, 4, or 5 seconds.
  • Do not print Capture chit (Enabled)
    • This will suppress printing of the Capture chit after a Capture. However, it will still be available for reprint functions.
  • OPI Style Auth chit (Enabled)
    • Checking these will use the UTG generated print receipt.
  • OPI Style Capture chit (Enabled)
    • UTG 3013 or above is required.
  • OPI Style Sale chit (Enabled)
  • OPI Style Void chit (Disabled)
  • OPI Style Refund chit (Enabled)

Tenders and Service Charges:

  • Send & Stay Tender (# Send & Stay)
    • The record number of the Send and Stay service total defined in POS Configurator. Use one that preserves hold status.
  • Send and Exit Tender (# Send and Exit)
    • The record number of the Send and Exit service total defined in POS Configurator. Use one that preserves hold status.
  • Print Tender (# Print)
    • The object number of the Print service total defined in POS Configurator.
  • [Option] SkyTab Invoice Number Menu Item (# SkyTab TrID)
    • The record number of the Menu Item to hold the SkyTab payment Invoice Number.
  • Authorization Tender (# Auth)
    • The record number of the Authorization Tender you created in POS Configurator.
  • Visa Tender (# Visa)
    • The record number of the Shift4 Visa Tender you created in POS Configurator.
  • Other Tenders
    • (# MC)(# Amex)(# Disco)(# JCB)(# GC)(# Shift4 IYC)

UTG Tab

Enter in each UTG URL installed at the site that is used with this 3700 System on the UTG Tab.

image-21__1_.png

UTG Number: 1 - X - Now allows unlimited amount

The URL and port will be in <URL>:<Port>” format.

Example: If the URL = https://192.168.2.1 and port is 277. This would be entered as https://192.168.2.1:277

 

Revenue Centers Tab

Enter the settings for each Revenue Center that this 3700 system will use, and its assigned UTG Number.

mceclip1__58_.png

Revenue Center Selections

  • Number (# Revenue Center Name)
    • The Revenue Center Record Number.
  • Name (# Revenue Center Name)
    • The Revenue Center Record Name.
  • UTG Number
    • 1 – 5, depending on the UTG Tab Screen

Tokens Sub Tab

  • Access Token
    • This will be filled in automatically when you use the Token Exchange function.
  • Token Exchange
    • Press this to do a token exchange for the selected revenue center. You will need the site’s Auth Token to run this. (Repeat for each revenue center as needed.)

image-23__1_.png

Header/Footer Sub Tab

  • Header
    • Enter any custom header lines you want on the Shift4 chits.
  • Trailer
    • Enter any custom trailer lines you want on the Shift4 chits. This may conflict with custom print trailers, particularly tip suggestion SIM trailers that are included.

Chit Fields Sub Tab

mceclip3__37_.png

  • This section determines how the list of receipt options shows on this page. This is broken up into three options.
    • All Fields: Check this radio button to show all possible fields.
    • UTG Receipt Options: Check this radio button to show only UTG Receipt fields.
    • Other Fields: Check this radio button to show only Non-UTG Receipt fields. Some of these are POS
      values, and others are from UTG but are not part of the “Receipt” data.
    • Load Defaults: This will reset the names and print checkboxes for ALL fields, but only for the selected revenue center.
  • Up/Dn Buttons: These only work on the UTG Receipt Fields. Use these to move rows up or down to alter
    the order that these items appear on the chit.
  • Print Key: This is the system name of the data that is generated. 
  • Print Field Name: If you edit this column, then the Chit will show that name, not the value from UTG.
    For the “Other Fields,” the value in this form is always used as the printed name.
  • Print?: Check this to cause the field to show on the chits. Unchecked to suppress printing of this
    field.
  • Save Button: Saves the settings for the current revenue center.
  • Delete Button: This DELETES the entire revenue center and its settings.
  • Copy To All Rvcs Button - this will copy the selected tab field from the selected revenue center to all other revenue centers.  If the “selected” row in the Revenue Center Selection grid is in row 1, then the revenue center in Row 1 will be copied.
    • On the right side of the screen, if the Header/Footer tab is visible, then the Header and Footer will be copied.  If the Chit Fields tab is visible, then the Chit Fields will be copied.  If the Print Options tab is visible, the those options will be copied.
    • Note that after copying, the destination revenue centers data will NOT have been saved to disk.  You will need to do File->Save for that to happen.
  • Printed Field Name - If you edit this column then the Chit will show that name, not the value from UTG.  For the “Other Fields”, the value in this form is always used as the printed name.
  • Up/Dn buttons - These only work on the UTG Receipt Fields.  Use these to move rows up or down to alter the order that these items appear on the chit.

Print Options Sub Tab

mceclip4__28_.png

  • Receipt Width – 32 or 40 to match the POS.
  • Signature on Device – Check this if you are using Signature Capture UTG Devices.
  • Do not print Title on Auth Chit – This will suppress printing of the “Authorization” line on the auth chit.
  • Do not print Title on Capture Chit – This will suppress printing of the “Capture” line on the capture chit.
  • Do not print Title on Sale Chit – This will suppress printing of the “Sale” line on the sale chit.
  • Do not print Tip line on Auth/Capture/Sale Chit – This will suppress printing of the tip line on the chit.
  • Do not print Signature line on Auth/Capture/Sale/Refund/Void chit – This will suppress printing of the signature line on the chit.
  • Print Merchant Capture/Auth/Sale/Refund/Void/Declined chit – Print the Merchant Copy of the chit.
  • Print Customer Capture/Auth/Sale/Refund/Void/Declined chit – Print the Customer Copy of the chit.
If OPI Style Chits are selected, this will override all other customizations made via the Chit Fields tab and the Miscellaneous options under the Print Options tab. 
  • OPI Style Auth Chits – Checking these will use the UTG generated print receipt.
  • OPI Style Capture Chits – UTG 3013 or above is required.
  • OPI Style Sale Chits
  • OPI Style Void Chits – Recommended to always check this.
  • OPI Style Refund Chits

Devices Tab 

Enter each Ingenico device and its assigned workstation and UTG that this interface will use.

  • Device ID (API TID)
    • The API Terminal ID value provided on your Shift4 Configuration Sheet. This number will be entered with no leading 0's.
    • The Device ID in the bridge interface has to match what the API TID is showing as in LTM and UTG.
  • Workstation Number (# Workstation Name)
    • The Workstation Record Number.
  • Workstation Name (# Workstation Name)
    • The Workstation Record Name.
  • UTG Number
    • 1 – 5, depending on the UTG Tab Screen.

This completes the Shift4 Interface setup you should now go to, File > Save.

 

mceclip0_-_2022-06-07T111852.619.png

SIM File Distribution

  • This Version 1.0.2.4:
    • The Configuration program has a “Name ISL” button.  Pressing this button will create the pmsNNN.isl file discussed below. This button will also select either the standard Shift4.isl file, or the Shift4_noinclude.isl file, depending on the configuration. The Installer will still need to copy that file to the appropriate CAL folders.
  • Older versions:
    • The interface includes a SIM file in the Shift4Interface folder (Shift4.isl).
    • On the 3700 Server,  you will need to rename this file to the correct pmsNNN.isl name, and place the renamed file in various locations to be copied to the workstations.   In the pmsNNN.isl file name, NNN is the Interface Number you selected above.  If you used interface 37, you would rename Shift4.isl to be “pms37.isl”.  Similarly, if you used interface 2, you would rename Shift4.isl to pms2.isl.  It is a good idea to save the Shift4.isl file before you rename it.

 

The interface includes SIM files in the …\Shift4Interface folder, the Shift4.isl and Shift4Include.isl).

On the RES 3700 Server, you will need to rename the Shift4.isl to the correct pms###.isl name, and place the renamed file in various locations to be copied to the workstations. You only need to copy the renamed Shift4.ISL to the folder for their workstation models.

In the pms###.isl file name, ### is the Shift4 Interface Number you recorded earlier at the start of the micros setup. If you used (2 Shift4) you would rename Shift4.isl to pms2.isl. It is a good idea to save a copy of the Shift4.isl file before you rename the file.

For OPS on Server copy the renamed “shift4.isl” and “Shift4Include.isl” to:

  • ...\MICROS\Res\Pos\Etc\...
  • ...\MICROS\Res\CAL\WS5A\Files\CF\Micros\Etc\...
  • ...\MICROS\Res\CAL\WS5\Files\CF\Micros\Etc\...
  • ...\MICROS\Res\CAL\WS4LX\Files\CF\Micros\Etc\...
  • ...\MICROS\Res\CAL\WS4\Files\CF\Micros\Etc\...
  • ...\MICROS\Res\CAL\Win32\Files\Micros\Res\Pos\Etc\...
Above are common examples of CAL Workstations. But, the site may have different workstations and these files may be needed in another folder location.

Once all files are in place, start the service: “Shift4 3700 Interface” and test a transaction.

 

Equal Split Pay Mode - New feature

Start a check, and ring up some items. Do NOT do this with a $0 balance check.

1. Press the Equal Pay key.


mceclip0_-_2022-06-07T111909.536.png


You will be prompted for how many ways to split the check.

After pressing Enter, you will see a pop-up confirming the number of cards and the amount per card (before any tip).

mceclip1__59_.png


2. After pressing OK, the Bridge will be in Equal Split Pay mode.
3. To cancel this mode, just press the Equal Pay key again.


Authorizations:
1. When you press the Auth key, the Bridge will begin processing each card. The BOB prompt will show which card is in progress and the amount:

 

mceclip2__51_.png


2. Process each card on the PIN pad. The auth will be added to the check. Continue processing each card on the PIN Pad as prompted.

mceclip3__38_.png



3. If a card is declined or fails, you can press the Auth Key again and it should pick up where it left off.
4. Or, you can just press the Equal Pay key to cancel Equal Split Pay mode.
5. When all cards have been processed, Equal Split Pay Mode will end.

 

Capture
In order to complete the equal pay process select Equal pay button before CC Final once you enter Equal Split Pay mode with a Capture, the flow will be much like Authorizations. However, if there are multiple Auths on the check, you will be prompted to select the Auth for each card. If there is only 1 unused Auth remaining on a check, you will NOT be prompted for the auth (just like a standard Capture).

You will also be prompted for the tip amount for each card. This tip amount will be Added to the base amount calculated for Equal Split Pay mode. So, the full tender may be different for each card.


2. When you press the Capture key, the Bridge will begin processing each card.
3. For each card, Select the Auth to use.

mceclip4__29_.png

4. Enter the tip amount for the card.

mceclip5__17_.png


5. The auth will be Finalized (captured).
6. Note that on the last Auth, you may NOT be prompted to select the auth, but will be taken directly to the tip prompt.

Sale / Sale No Tip
1. If you enter Equal Split Pay mode with a Sale-No-Tip, the flow will be just like the Auth. If you are using the
If you are using it with a Sale, then it will be like the Auth, but you will be prompted for a tip before each card can be swiped on the PIN Pad.

Top