Description: This guide outlines how to install and configure the Shift4 Interface for use with the MICROS e7 platform.
- Pre-Install Considerations
- Installing the Shift4 Interface
- Configuring the Micros E7 Configurator
- Configuring the Shift4 Interface
Pre-Install Considerations:
Setup Requirements
- Supported Micros e7 Versions: 3.2, 4.1, 4.2 and 4.3
- Supported Windows Versions: 7, 8, or 10.
- Required Minimum .NET Framework Version: 4.6.2
Limitations / Special considerations
- Tips must be added manually before the payment occurs. That is, after an Auth, but before a Capture or Sale. This is due to a limitation of the E7 TIF functionality and cannot be changed.
- The Tip must be a regular Tip, not a charge tip.
- Manual Auth/Sale are not supported.
- At this time, Referrals are not supported.
- Table Numbers are not available in TIF. Therefore, until it is available, no table field will be shown on the chits (receipts).
Validating The e7 Software Version
- On the Micros Server PC, open the drive that Micros is installed on (Ex: C:\Micros..)
- Sometimes this is referred to as Back of House PC (BOH PC) or Back of House Controller (BOC PC).
- Open the drive that Micros is installed on (Ex: C:\Micros..)
- Follow the file path Micros > e7 > Bin
- Once in the bin folder, right-click the e7.exe and select properties.
- Select the Details Tab
- The product version will be listed within these details.
Example: Version 1.42.2.5 represents Micros e7 Version 4.2, and is on patch build 2.5.
Validating Installed .Net Framework Version
Closing All Open Checks
- On the Micros Server PC navigate to:
- (32-Bit Windows) C:\program files\micros\e7\db\openchecks
- (64-Bit Windows) C:\program files (x86)\micros\e7\db\openchecks
- Delete all the listed .chk files in the folder.
- For the workstation(s) navigate to \cf\micros\e7\db\openchecks
- Delete all the listed .chk files in the folder then restart the e7 software.
Close All Pending Batches
- Log into the E7 software with a Manager Pin.
- Once in the e7 operations screen, select Credit Cards (Screen layout is customizable and the button location or look can vary.)
- In the Credit Card Batch Utility, select Settle.
- identify the batch in the dropdown, then select Settle Batch.
- Batch settlement should provide a notification when completed.
- Select the red arrow (exit) to return to the e7 operations screen.
Backing-Up The Micros e7 Database
- Locate the Configurator button within the e7 operations screen. (Screen layout is customizable and the button location or look can vary.)
- You will be asked to enter your Micros Manager username and password after this selection
- Click the drop-down box on the right side, and then select Backup the Database.
- The backup file is copied to …\MICROS\e7\DbBackups.
- The Back-Up should provide a notification when completed
- Press the red arrow (exit) when done.
- You will be asked to enter your Micros Manager username and password after this selection
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. The current device configuration can be validated 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.
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
- Begin by rebooting the device.
- 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.
- 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]
- Press [0] for Configuration.
- Press [0] again for communication.
- Press [2] for Ethernet Settings.
- 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.
- Press [Cancel] when complete to return to the Ethernet Settings menu.
- 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
- Press [Cancel] when complete to return to the Ethernet Settings menu.
- 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.
- Press [Cancel] until the device asks you to Save Settings and Reboot? Select Yes.
- The device will reboot and it can be left alone for now.
Re-configuring for Ethernet: Server: Static:
- Begin by rebooting the device.
- 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.
- 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]
- Press [0] for Configuration.
- Press [0] again for communication.
- Press [0] again for Comm. Type.
- Press [1] for Ethernet. (Sometimes this option can be listed as [2] depending on your RBA build.)
- Press [Cancel] when complete to return to the TDA menu.
- Press [0] for Configuration.
- Press [0] again for communication.
- Press [2] for Ethernet Settings.
- Press [0] for the Connection Method and then select [1] for Server.
- Press [Cancel] when complete to return to the Ethernet Settings menu.
- Press [1] for DHCP to choose whether the IP address will be static or assigned by a DHCP Server.
- Press [1] to set a Static IP (Preferred)
- Press [0] if the IP is handled via a router with DHCP enabled (Dynamic Host Configuration Protocol)
- Press [Cancel] when complete to return to the Ethernet Settings menu.
- 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.
- Press [Cancel] when complete to return to the Ethernet Settings menu.
- 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
- Press [Cancel] when complete to return to the Ethernet Settings menu.
- 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.
- Press [Cancel] when complete to return to the Ethernet Settings menu.
- 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.
- Press [11] to set the SSL settings. (RBA 21+ only) This setting was added in RBA 21 and should always be set to no.
- Press [Cancel] until the device asks you to Save Settings and Reboot? Select Yes.
- 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
- Station Name = REST
- Serial = This will be supplied by Shift4 on the UTG Config Sheet under Serial Number:
- Host Address = The Server IP Address (example: 192.168.100.250)
- Location = Zip Code
- Api Serial Number and Password = Leave these blank
The API Interfaces Tab
- Select Add, then REST
- Host Address = Micros Server IP Address (example: 192.168.100.250)
- Port = This must be 277
- 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 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
- 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)
- Certificate Password – Enter the password that you created above
- 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)
- Private Key Password – Enter the password that you created above
- Select OK.
Devices Tab
- 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 = This will be supplied by Shift4 on the UTG Config Sheet.
- 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 = This will be supplied by Shift4 on the UTG Config Sheet as Serial Number:
- Select Contactless Enabled and Bypass Amount OK
- Select OK and repeat as many times as necessary for each PinPad.
[Option] Advanced Tab
(If the D:\ drive was used for installation)
- Select Trace Configuration and make sure the directory within is D:\Shift4\UTG2\Trace\, then OK.
- Select Splunk Configuration and make sure the directory within is D:\Shift4\Splunk\, then OK.
Finish
- Once you have verified all the data is accurate across all of the above tabs, select the Save button, and TuneUp will close.
Installing the Shift4 Interface
You should have been provided an installation package by your Shift4 Representative for your Micros e7 software version.
Example: Shift4BridgeE7_X.X.msi (X.X should match your Micros e7 software version.)
Validating Client Application File Placement
(Files listed below will be located in ...\Shift4Interface\ for the directory you installed on.)
After running the e7 Bridge installer it will have created the folder “BOCFiles”. It contains these files:
- TIFSHIFT4.dll
- TIFSHIFT4.cfg
Both of these files will need to be moved to the appropriate folders so Micros's Client Application Loader (CAL) and push these files to the workstations and allow processing. (Note that sometimes another directory other than C:\ may be in use.)
Move these to:
- (32-Bit Windows) C:\Program Files\MICROS\e7\Bin
- (64-Bit Windows) C:\Program Files (x86)\MICROS\e7\Bin
- Alternatively, this can also be in C:\Program Files\MICROS\Bin
NOTE: If you are not seeing this folder location attempt to search the e7.exe in windows search.
- Press "Windows Key + S" on your keyboard to bring up Windows search.
- Enter in e7.exe once this program populates in the search results right-click on it and select the option of Open file location.
- In the folder window that opens, drag and drop the needed files.
The install will have also created the folder “CAL”. It contains these files:
- Shift4Interface\
- Setup.dat
- TIFSHIFT4.dll
- TIFSHIFT4.cfg
Copy the Shift4 folder and it's contents to the appropriate E7 “CAL\Packages” folder on the Server PC. Depending on the type of workstation(s) in use you may have to copy this into multiple folders.
Example(s):
- (32-Bit Windows) C:\Program Files\MICROS\CalServer\WS5a\Packages\Shift4
- (64-Bit Windows) C:\Program Files (x86)\MICROS\CalServer\WS5a\Packages\Shift4
If you need help identifying your workstation types see, Identifying Micros & Simphony Workstation Types. If CAL is not transferring files, perfrom this operation manually via Transfering E7 Files w/ File Utility.
Configuring the Micros E7 Configurator
- Log into e7 with a Micros Manager PIN.
- Once logged in locate the Configurator button within the e7 operations screen. (Screen layout is Customizable and the button location can vary.)
- You will be asked to enter your Micros Manager username and password after this selection.
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” on the side of the screen or within the config page for the setting. These values will be needed throughout the setup of the e7 Configurator and the Shift4 Bridge. Ex: (# Record Name)
Interfaces
- Once the e7 Configurator is open, in the top left corner is a file system dropdown.
- Locate the option of Interfaces in this drop-down.
- In the System Tray drop-down select Add Record and configure the following:
- Number should auto-assign to the next available number assignment.
- Set the Name to Shift4 Bridge.
- Set the Interface Code to Shift4.
- Set Node to the Micros Server PC (Commonly Named Micros BOC.)
- Set the TCP Server Name to be the IP Address of the Server PC where the UTG is installed.
- Set the Port Number to be an open TCP port, Default is 5008.
- Set Timeout to 70 (This can be set lower for testing if wanted but live processing must be at 70)
- Press Save to save the config.
Tenders
- Return to the drop-down in the top left corner, and select Tenders.
- In the Center drop-down select Add New Tender.
- You will need to create an authorization tender, and a payment tender for each card type accepted at your location
- All configuration for these tenders will be the same except for the name designation.
- Configure the following settings for each tender you created.
- Any value(s) not spoken to directly here should be blank, disabled, or used at your own discretion.
- General Tab: Number: (Auto Assigned).
- General Tab: Name: (Name of the Tender) (Ex: Shift4 Auth, Shift4 Visa, Shift4 MC, etc..)
- General Tab: Category: (Assign a Tracking Number. Can be any numeric value Ex:2)
- If you do not wish to track or report this detail set this to 0.
- Be sure to assign the same Category Number to all created Shift4 Tenders.
- Options Tab: Reference Required: Disabled.
- Tender Tab: Max-Min Amounts: Disable and Set to $0.00.
- Tender Tab: Charged Tip\Service Charge: Disabled
- Tender Tab: Tender Rounding: Disable
- Presets Tab: Blank\Empty
- Printing Tab: Print Check Enabled
- CC Tender Tab: Blank\Empty
- Credit Auth Tab: CA Driver: Blank\Empty
- Credit Auth Tab: EDC Driver: Blank\Empty
- Credit Auth Tab: Floor Limits: 0.00
- Credit Auth Tab: Initial Auth Amount: 0
- Credit Auth Tab: Preambles: Blank\Empty
- Interfaces Tab: Add
: Shift4 Bridge
- Press Save (
) to save the config, then repeat as needed until all needed tenders are entered.
Service Charges
- Return to the drop-down in the top left corner, and select Service Charges.
- This setting will be used to manually add tips to checks
- This setting will be used to manually add tips to checks
- In the System Tray drop-down select Add Record
and configure the following:
- Any value(s) not spoken to directly here should be blank, disabled, or used at your own discretion.
- Main Tab: Number: (Auto Assigned).
- Main Tab: Name: Shift4 Tip
- Main Tab: Category: (Assign a Tracking Number. Can be any numeric value Ex:2)
- If you do not wish to track or report this detail set this to 0.
- Be sure to assign a unique Category Number that differs from the Tender\Media assignment.
- Main Tab: Form of Service Charge: Open
- Main Tab: Form of Service Charge: Amount - 0.00
- Settings Tab: Reference Required: Blank
- Settings Tab: Authorization Required: Blank
- Settings Tab: Auto Service Charge: Disabled
- Press Save to save the config.
Tracking Groups
- Return to the drop-down in the top left corner, and select Tracking Groups.
- In the System Tray drop-down select Add Record
and configure the following:
- Any value(s) not spoken to directly here should be blank, disabled, or used at your own discretion.
- Name: This tracking name will display on any reports using this tracking group.
- Tracking type: Select the type of item or activity you wish to record using this tracking total. Your selection in this field determines the options that display in the Tracking Choice/Selection fields. Select from the following tracking type options:
- Tender/Media -Tracks sales by tender/ media.
- Tips Paid - Tracks tips paid.
- Tracking choice: By Category ID
- Tracking selection: Select the Category ID that was used on the Shift4 Tender or Service Charge.
- Tracking operator: Check Operator
- Press Save to save the config.
- Repeat the steps above for each Tracking Group needed.
Touchscreens
- Return to the drop-down in the top left corner, and select Touchscreens.
- Reconfigure an existing button or add a new button
for the following:
- Auth:
- Function: Shift4 Bridge
- Value: Shift4 Auth
- Legend: (This is the text on the button. Can be anything you wish)
- This performs a basic credit card authorization.
- Capture: (Final)
- Function: Shift4 Bridge
- Value: Shift4 Capture
- Legend: (This is the text on the button. Can be anything you wish)
- This performs a basic capture to complete the payment based on an existing credit card authorization.
- Sale:
- Function: Shift4 Bridge
- Value: Shift4 Sale
- Legend: (This is the text on the button. Can be anything you wish)
- This performs both basic authorization and capture of a credit card in one function to complete payment.
- Tip: (Service Charge)
- Function: Service Charge
- Value: Shift4 Tip (This will be the shift4 service charge name that you set up in section service charges)
- Legend: (This is the text on the button. Can be anything you wish)
- This performs as a button that will allow you to add tips to a check manually
- Refund:
- Function: Shift4 Bridge
- Value: Shift4 Refund
- Legend: (This is the text on the button. Can be anything you wish)
- This performs a refund for the credit card.
- The Refund Key must be placed on a screen this is only accessible to a Manager user who has the following user permissions.
- Ring negative checks
- Direct void
- Pay negative checks
- Reprint:
- Function: Shift4 Bridge
- Value: Shift4 Reprint
- Legend: (This is the text on the button. Can be anything you wish)
- This function prints the last receipt/chit that was printed for the specified transaction.
- Void:
- Voids do not have a separate key, when a sale or capture is voided the e7 interface will process the void.
3. Press Save to save the config once done.
Jobs
- Return to the drop-down in the top left corner, and select Jobs.
- On this screen select an Employee user.
- Then select the Options tab.
- Under the Interfaces section ensure the option of "Can perform inquiry" is enabled.
- Press Save to save the config once done.
- Repeat this step for each Employee as needed.
Configuring the Shift4 Interface
You need to enter the configuration settings that will be used by the Shift4Interface. 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.
- Run the Shift4Config.exe program.
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 Port (5008)
- The TCP port you selected for this Interface in e7 Configurator.
- Micros Interface Timeout (65)
- The timeout you selected for this Interface in e7 Configurator. Configure 2 fewer seconds for this value.
- UTG Timeout (60)
- 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: (5)
- In Production, set this to 1 or 2 seconds. On a test platform, use 3, 4, or 5 seconds.
Tenders and Service Charges:
- Authorization Tender (# Shift4 Auth)
- Visa Tender (# Shift4 Visa)
- Other Tenders: (# Shift4 MC)(# Shift4 Amex)(# Shift4 Disco)(# Shift4 JCB)(# Shift4 GC)(# Shift4 IYC)
UTG Tab
Enter in each UTG URL installed at the site that is used with this e7 System on the UTG Tab.
UTG Number: 1 – 5 Read Only
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 e7 system will use, and its assigned UTG Number.
- 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.)
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.
Printing Tab
-
- Do not print Auth Merchant chit - This will suppress printing of the Merchant auth chit after an auth. However, it will still be available for the reprint function.
- Do not print Auth Customer chit - This will suppress printing of the Customer auth chit after an auth. However, it will still be available for the reprint function.
- Do not print Capture Merchant chit - This will suppress printing of the Merchant Capture chit after a Capture. However, it will still be available for the reprint function.
- Do not print Capture Customer chit - This will suppress printing of the Customer Capture chit after a Capture. However, it will still be available for the reprint function.
- Do not print Auth Merchant chit - This will suppress printing of the Merchant auth chit after an auth. However, it will still be available for the reprint function.
Note: Reprinting will only print 1 of the 2 possible chits. If a customer chit is available, that will be re-printed. If not, then the Merchant copy will be re-printed.
- Do not print Tip Line on Capture chit - This will suppress printing of the tip line on a Capture chit after a Capture.
- Signature on Device - Check this if you are using Signature Capture UTG Devices.
- Print 2 Sale/Refund/Void Chits - Unchecked, 1 copy of the chit will print. Checked, 2 copies will print.
- Line Feeds between chits - After the first chit is printed, the printer will advance this many lines before the paper cut. Normally 5 is a good guess, but set it as desired.
The Main Menu Bar (at the top)
About
You can press About to determine the Interface version to the extent that the config program can determine it.
1.x.3.10 represents the configuration and service program versions that support 1.32.3.10, 1.41.3.10, etc.
1.32.3.10 represents a Shift4 TIF DLL that is correct for E7 version 32 and works with service version 1.x.3.10.
This will help determine the correct version has been installed and will help identify that the TIF / DLL files are correct in the folders
Finished
Admin > Install Service
The install should have installed the Shift4 E7 Bridge Interface Service as a windows service. If it did not, or you need to reinstall it for some reason (Like you copied the bridge files manually onto the PC), you can use this option. This does NOT install the full software but only adds it to the Windows Service Manager.
Admin > Remove Service
If you need to remove the windows service for some reason, you can use this option. This does NOT uninstall the full package.
Select Admin then select install service.
This completes the Shift4Interface setup you should now go to File > Save.
Start the Shift4 e7 Interface Service. see, Starting/Stopping a Service in Windows.