Skip to main content
  Sign in

Quick Steps

Labels

Article

Shift4 Interface (Bridge)

Secure Suite 4 Micros

Enable Settings

Still Have Questions? Submit a Request

Or Call (888) 857-9751.

Or Call (888) 276-2108.

Shift4 Bridge with Micros 9700 HMS Setup Guide

Timothy Hughes
  • Updated
  1. Shift4 Payments
  2. Self Help Product Categories
  3. ...
  4. Oracle MICROS
  5. MICROS 9700 HMS
  6. Shift4 Bridge
  7. Setup & Configuration

Description: This article covers how to set up Shift4 Bridge with Micros 9700. 

Pre-Install Considerations

 Product Version  Solution .Net Version EMV SkyTab

 

HMS 9700

 

3.0 - 4.0+

2.5 - 2.8  

Shift4 Bridge 

4.6.2

✓

X

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

Configuring Ingenico Hardware

Modern Devices come preconfigured from the injection facility. You will need to validate the device(s) are configured to the desired communication method of Ethernet. You can validate the current device configuration during the device reboot process on the Ingenico Copyright Screen.

 

Model Type

Reset Procedure

 iSC250/480:

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

iPP320/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.

Micros-9700-HMS_Setup_3__1_.png    Micros-9700-HMS_Setup_4__1_.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 press the (+) Plus or (F) Function for the 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 iSC250/480, use the [+] and [-] keys to navigate and select [Enter]
    • For iPP320/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. You must enter three digits for each octet so you would enter an IP address of 10.0.1.193 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. You must enter three digits for each octet so you would enter an IP address of 255.255.255.0 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. You must enter three digits for each octet so you would enter a Default Gateway IP address of 10.0.1.1 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 press the (+) Plus or (F) Function for the menu.
    • If your device requests to press (F) for Menu, your unit doesn't have a function key simply press (+) Plus instead.
  3. Scroll to the TDA Menu and select this.
    • For iSC250/480, use the [+] and [-] keys to navigate and select [Enter]
    • For iPP320/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. You must enter three digits for each octet so that you would enter an IP address of 10.0.1.193 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. You must enter three digits for each octet so you would enter an IP address of 255.255.255.0 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. You must enter three digits for each octet so that you would enter a Default Gateway IP address of 10.0.1.1 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 = Shift4 will supply this 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 = Restaurant name with location if multiples
    • Email Address = Sites 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 to save the certificate and key for the folder. 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 PinPad info:
    • Device Name = PinPad-101 (where 101 matches the Workstation name - WS6-101, etc…)
    • Device Type = Select the appropriate type (we normally use Ingenico iPP320 RBA)
    • API Terminal ID = Shift4 on the UTG Config Sheet will supply this.
    • Connection = This will normally be Direct TCP/IP
    • IP Address = PinPad 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 iPP320
    • Manual Card Entry = Enable MCE
    • Select Disabled for CVV Code, Street Number, and Zip Code
    • Source Serial = Shift4 will supply this 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 PinPad

[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.

Accessing the Micros Enterprise Management Console (EMC)

  1. From the Windows Desktop, locate the Shortcut titled "EMC" and open this.
    • This will open the Enterprise Management Console (EMC).

Micros-9700-HMS_Setup_5.png

 

Configuring HMS 9700 EMC for use with Shift4 Bridge

It is important to know that any time a Number or Name is spoken of, these details should be written down for later use during the setup. These values will be needed throughout the setup of the HMS 9700 EMC Configuration and the Shift4 Bridge. Ex: (# Record Name).

Interfaces

  1. In the left navigation panel, select Configurator.
  2. Then select System Hardware, then Interfaces.
  3. Add a new Interface and configure the following:
    • Number: Assign the next available number if one is not populated.
    • System Name: Shift4 
    • Service Type: 0-PMS/SIM
    • Type: TCP
    • PC Number: This should be the 9700 server node.
    • Timeout: 30
    • TCP Communications:
      • TCP Host Name: The IP address of the PC on which the Bridge interface is running.
        • Do Not use 127.0.0.1 unless the Bridge Interface is running directly on the 9700 Server.
      • Port Number: Assign an unused TCP port for network communications.
    • Options:
      • ISL Script Name: Shift4 
      • Enable: Use 19 digit reference entries for PMS inquiries.
      • Enable: Allow Inquire without Sign-In MUST be checked.
      • Enable: Use 9 digits for terminal IDs MUST be checked.
  4. Save the configuration at the top by pressing the save [Micros-9700-HMS_Setup_9.png ] icon.

Micros-9700-HMS_Setup_6.png

 

RVC Parameters

  1. In the left navigation panel, select Configurator.
  2. Then select RVC Information, then RVC Parameters.
  3. Select the Interfaces tab on this screen.
  4. Assign the Shift4 interface you created in the previous step to the next available interfaces assignment.
    • This will be typically be marked as [ 0-None ].
    • The [ X-Shift4 ] Interface will be assigned with the number of the interface you configured in the previous step. (in the example below, this is [ 6-Shift4 ])- But, we have assigned it to Interface Link number 2. This link number you will need in touchscreen programming and the Interface Configuration later in this document.
  5. Save the configuration at the top by pressing the save [Micros-9700-HMS_Setup_9.png] icon.

Micros-9700-HMS_Setup_7.png

 

Tender/Media

You will need to add Tender/Media for each payment type you accept. This includes an Authorization Tender and one for each card brand your location accepts. (Visa, MasterCard, American Express, Discover, etc.)

  1. In the left navigation panel, select Configurator.
  2. Then select System Information, then Tender/Media.
  3. Add a new Tender and configure the following for your Authorization Tender:
    • General Tab:
      • Number: Assign the next available number if one is not populated. 
      • Name: S4 Auth
      • Privilege Group: 0
      • Key Type: 1-Payment
      • NLU: 0
      • SLU: 0-None
      • MMH-SLU: 0-None
    • Options Tab:
      • Printing Options:
        • (You must enable the options listed below, all other options are at your discretion.) 
        • Print Customer Receipt [Enabled]
        • Print Check Trailer [Enabled]
        • Print Check on Demand [Enabled]
        • Print Multiple Guest Checks/Receipts [Enabled]
      • Interface Options:
        • Interface Link: Assign the Shift4 interface from the previous two sections.
        • ON=Post Amount Tendered to PMS [Enabled]
        • ON=Post 0.00 Transactions to PMS; [Enabled]
        • Use ISL Timed Procedures Instead of PMS Interface [Enabled]
        • Reverse PMS Itemizers On VOID Postings [Enabled]
        • View Interface Names for RVC: 0-None
      • Credit Card Options:
        • All options here should be disabled, and all amounts should show as 0.00.
      • Taxing Options:
        • All options here should be disabled.
      • POS Behavior:
        • All options here should be disabled.
      • Charge Tip Options:
        • Service Charge: 0-None
        • All other options here should be disabled.
      • Miscellaneous Options:
        • All options here should be disabled, and all amounts should show as 0.
    • Menu Levels Tab:
      • Active on Main Levels: All options should be enabled.
      • Active on Sub Levels:  All options should be enabled.
      • Transaction Defaults should be disabled and set to 0- Stay Down
      • View Menu Level Names for RVC: 0-None
    • Output Tab:
      • Set the printing options as needed for your site.
  4. Save the configuration at the top by pressing the save [Micros-9700-HMS_Setup_9.png] icon.

Micros-9700-HMS_Setup_8.png

 

Now you will need to configure your branded tender types.

  1. Add a new Tender and configure the following for your Branded Tender:
    • General Tab:
      • Number: Assign the next available number if one is not populated. 
      • Name: S4  "Brand" (Visa, MasterCard, American Express, Discover, etc.)
      • Privilege Group: 0
      • Key Type: 1-Payment
      • NLU: 0
      • SLU: 0-None
      • MMH-SLU: 0-None
    • Options Tab:
      • Printing Options:
        • (You must enable the options listed below, all other options are at your discretion.) 
        • Print Customer Receipt [Enabled]
        • Print Check Trailer [Enabled]
        • Print Check on Demand [Enabled]
        • Print Multiple Guest Checks/Receipts [Enabled]
      • Interface Options:
        • Interface Link: Assign the Shift4 interface from the previous two sections.
        • ON=Post Amount Tendered to PMS [Enabled]
        • ON=Post 0.00 Transactions to PMS; [Enabled]
        • Use ISL Timed Procedures Instead of PMS Interface [Enabled]
        • Reverse PMS Itemizers On VOID Postings [Enabled]
        • View Interface Names for RVC: 0-None
      • Credit Card Options:
        • All options here should be disabled, and all amounts should show as 0.00.
      • Taxing Options:
        • All options here should be disabled.
      • POS Behavior:
        • Amount Required [Enabled] 
        • All other options here should be disabled.
      • Charge Tip Options:
        • Service Charge: 1- $CHARGE TIP
        • Charge Tip Required [Enabled]
        • Post Amounts to Gross Receipts on Tip Records [Enabled]
        • Post Amounts to Charged Receipts on Tip Reports [Enabled]
        • All other options here should be disabled.
      • Miscellaneous Options:
        • All options here should be disabled, and all amounts should show as 0.
    • Menu Levels Tab:
      • Active on Main Levels: All options should be enabled.
      • Active on Sub Levels:  All options should be enabled.
      • Transaction Defaults should be disabled and set to 0- Stay Down
      • View Menu Level Names for RVC: 0-None
    • Output Tab:
      • Set the printing options as needed for your site.
  2. Save the configuration at the top by pressing the save [Micros-9700-HMS_Setup_9.png] icon.
  3. Repeat the steps above for each branded tender needed.

Micros-9700-HMS_Setup_10.png

 

Touchscreen Design

Micros-9700-HMS_Setup_11.png

Note: When Selecting the Key Number option for any of these buttons, this screen will appear.

Micros-9700-HMS_Setup_12.png

  1. In the left navigation panel, select Configurator.
  2. Then select Touchscreens, Keyboards, and KDS.
  3. Now select Workstations, then Design.
  4. Configure Each Individual Button With The Following:
    1. Legend: Auth (CC Auth)
      • This function performs the basic credit card authorization. 
        • KeyType:  11- Function
        • Key Number:
          • Key Function: SIM
          • SIM # - Shift4 - Inq 1
            • (SIM # is the Interface number you assigned in the RVC Parameters)
    2. Legend: Manual Auth (Offline Auth)
      • This function performs the basic credit card authorization when a voice auth has been obtained from Shift4. 
        • KeyType:  11- Function 
        • Key Number:
          • Key Function: SIM
          • SIM # - Shift4 - Inq 2 
            • (SIM # is the Interface number you assigned in the RVC Parameters)
    3. Legend: Final (CC Close)
      • This function performs the basic Capture to complete the payment based on an existing authorization. 
        • KeyType:  11- Function  
        • Key Number:
          • Key Function: SIM
          • SIM # - Shift4 - Inq 4
            • (SIM # is the Interface number you assigned in the RVC Parameters)
    4. Legend: Sale (CC Auth & Close)
      • This function performs the basic Auth/Capture in one function to complete the payment. You would use this in a quick-service environment or other similar situations. 
        • KeyType:  11- Function 
        • Key Number:
          • Key Function: SIM
          • SIM # - Shift4 - Inq 5
            • (SIM # is the Interface number you assigned in the RVC Parameters)
  5. Button: Refund (CC Refund)
    • This function performs a refund onto the card. 
      • KeyType:  11- Function  
      • Key Number:
        • Key Function: SIM
        • SIM # - Shift4 - Inq 7
          • (SIM # is the Interface number you assigned in the RVC Parameters)
          • Note: You MUST place the Refund Key on a screen that is only accessible to a Manager who can perform the following:
            • Ring Negative Checks
            • Direct Void
            • Pay Negative Checks
  6. Legend: Reprint Chits (CC Reprint)
    • This function attempts to reprint the last chits that were printed for a specific transaction.
      • KeyType:  11- Function  
      • Key Number:
        • Key Function: SIM
        • SIM # - Shift4 - Inq 8
          • (SIM # is the Interface number you assigned in the RVC Parameters)
  7. Legend: Void
    • Voids do not have a separate key. When a Sale or Capture is voided, the interface will process the void.
  8. Save the configuration at the top by pressing the save [Micros-9700-HMS_Setup_9.png ] icon.

 

Configuring the Shift4 Bridge Interface

General Tab

Micros-9700-HMS_Setup_13.png

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 the Shift4 Interface in EMC. 
  • Interface Port (5008)
    • The TCP port you selected for this Interface in EMC.
  • Micros Interface Timeout (118)
    • The timeout you selected for this Interface in EMC 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.
  • UTG Invoice Wait Delay: (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 the 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)
  • Signature on Device (Disabled)
    • If you are using a Signature Capture Device and want to capture the signature on the device instead of the receipt, enable this.

Tenders and Service Charges:

  • Send and Exit Tender (# Send and Exit)
    • The record number of the Send and Exit service total defined in EMC. Use one that preserves hold status.
  • Print Tender (# Print)
    • The object number of the Print service total defined in EMC.
  • Authorization Tender (# Auth)
    • The record number of the Authorization Tender you created in EMC.
  • Visa Tender (# Visa)
    • The record number of the Shift4 Visa Tender you created in EMC.
  • Other Tenders
    • (# MC)(# Amex)(# Disco)(# JCB)(# GC)(# Shift4 IYC)

 

UTG Tab

Enter each UTG URL installed at the site used with this HMS 9700 System on the UTG Tab.

Micros-9700-HMS_Setup_14.png

UTG Number: 1 – 5 Read Only

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

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

 

Revenue Centers Tab

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

Micros-9700-HMS_Setup_15.png

  • 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
  • Access Token
    • This will be filled in automatically when you use the Token Exchange function.
  • 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.
  • 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.)

Micros-9700-HMS_Setup_16.png 

 

Devices Tab

Micros-9700-HMS_Setup_17.png

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

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

Now click on the Admin option at the top and select "Install Services" This completes the Shift4Interface setup you should now go to, File->Save.

 

SIM File Setup

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

On the 9700 Server, you will need to copy this file to the “etc.” and “SAR” folders for the workstations to access it.

  • For Winstation workstations, copy “shift4.isl” to MICROS\LES\POS\9700\Etc\shift4.isl.
  • For SAR workstations, copy “shift4.isl” to C:\MICROS\LES\POS\9700\Scripts\SAR\shift4.isl.

When you are done and all saved, use Windows Service Manager to start the service:
Shift4 Postec SimFE/9700 Interface. See, Starting/Stopping a Service in Windows.

 

Non-Revenue Service Charges

The Sale function (Inquire 5 or 15) will work with a Non-Revenue Service Charge.  As with all checks, the NRSVC must be the only thing on the check, and tips are not allowed.

 

Tip-Only Sales

If you need to make a tip-only sale, the process here will work.  Other methods may also work, and if so, that is fine.

Create an Open Amount Tip service charge in Configurator.  You may be able to use the existing Charge Tips service charge, depending on the configuration. For example, in the steps below, the term “Tip Key” is just the button on the touchscreen that will ring up this tip.  It could be available in an SLU or a key just for the Tip Service Charge, etc.

  1. Create a check in the POS.
  2. Enter the tip amount, then press the Tip key.
  3. You may see the prompt “Enter charge payment” or not, depending on the configuration.  That is fine.
  4. Press the Shift 4 Sale key (inquire 5 or 15). If you are asked to confirm that the tip amount is 0, press Enter.  From the Shift4 point of view, there will be no tip.  It will be all sale.  That is fine.  The tip is already on the POS check.
  5. Process the sale as normal.
  6. If successful, the check will close.