MICROS Simphony Version 1 - Amazon Web Services€¦ · The MICROS Simphony Version 1.7 Technical...

Join us for treats Thursday, Month Day, at 3:00 p.m. in the kitchen.

Technical Installation Guide

Copyright © 2020 Shift4 Payments, LLC. All rights reserved.

MICROS Simphony Version 1.7



© 2020 Shift4 Corporation. All rights reserved. Version 1.0 External Use NDA of 24

Copyright Notice Shift4 Payments 1491 Center Crossing Road Las Vegas, NV 89144 702.597.2480 www.shift4.com [email protected]

Document Title: MICROS Simphony Version 1.7 Technical Installation Guide

Publication Date: February 3, 2020

Copyright © 2020 Shift4 Payments. All rights reserved worldwide. *Universal Transaction Gateway® (UTG)®, DOLLARS ON THE NET®, 4Go®, i4Go®, and 4Word® are covered by one or more of the following U.S. Pat. Nos.: 7770789; 7841523; 7891563; 8328095; 8688589; 8690056; 9082120; 9256874; 9495680. All trademarks, service marks, product names, and logos are the property of their respective owners. Shift4 Payments may have patents, patent applications, trademarks, copyrights, or other intellectual property rights covering subject matter in this document. The furnishing of this document does not give any license to these patents, trademarks, copyrights, or other intellectual property except as expressly provided in any written license agreement from Shift4 Payments. All graphics are property of Shift4 Payments. No part of this publication may be reproduced, stored in a retrieval system, or transmitted in any form or by any means without prior written permission of Shift4 Payments. The contents of this publication are the property of Shift4 Payments. Shift4 Payments reserves the right to revise this document and to periodically make changes to the content thereof without any obligation or notification to any organization of such revisions or changes unless required to do so by prior written agreement. Notice of Confidentiality This document contains information that is proprietary to Shift4 Payments. It carries the Shift4 classification “External Use NDA.” It is provided for the sole purpose of specifying instructions for Shift4 Payments products. The recipient agrees to maintain this information in confidence and not reproduce or otherwise disclose this information. Please refer to the signed Bilateral Non-Disclosure and Confidentiality Agreement for additional agreements and expectations. Notice to Governmental End Users If any Shift4 product is acquired under the terms of a Department of Defense contract: use, duplication, or disclosure by the US Government is subject to restrictions as set forth in subparagraph (c)(1)(ii) of 252.227.7013. Civilian agency contract: use, reproduction, or disclosure is subject to 52.227-19 (a) through (d) and restrictions set forth in the accompanying end user agreement. Unpublished rights reserved under the copyright laws of the United States.




Using the Technical Installation Guide The MICROS Simphony Version 1.7 Technical Installation Guide provides detailed information on configuring the MICROS Simphony system for use with Shift4’s Universal Transaction Gateway® (UTG®).

It is important to note that this guide is used for MICROS Simphony Version 1.7.

Who Should Use this Guide This guide is intended for individuals familiar with installing, programming, configuring, and updating the MICROS Simphony system, such as:

● MICROS Programmers/Installers

● MICROS Customer Service Representatives

● MICROS Training Personnel

● MIS Personnel

This guide assumes that the installer has the following knowledge or expertise:

● Operational understanding of PCs.

● Understanding of basic network concepts.

● Experience with Microsoft Operating Systems.

● Understanding of Point-of-Sale (POS) terminology and concepts.

● Exposure to MICROS POS systems and familiarity with operating MICROS peripherals (8700, 9700, 3700, Simphony, or other MICROS POS systems).

Note: This guide reviews the required settings to enable communication between MICROS Simphony Version 1.7 and Shift4's UTG; it is not a MICROS user manual.

Installation and Configuration Essentials A reference list and an installation checklist are included below to ensure the MICROS Simphony configuration processes run smoothly.




The reference list includes space to record numbers prior to the configuration process beginning, or to record numbers that may be assigned during the configuration process.

The installation checklist is a companion to the installation guide and guarantees all required steps are completed.

Reference List Print and use this reference list throughout the configuration process to record details that you will need to reference later. The table contains entries you may or may not need. Contact the Shift4 Support department at 702.597.2480, option 2, with any questions.

Name Details

Simphony Version Number 1.7

MICROS Server IP Address

UTG Simphony Interface Name Simphony

UTG Simphony Interface IP Address

UTG Simphony Interface Port Number Default: 5008

Service Host Name

Service Host IP Address

CaDOTN Interface Number

CAPMS Credit Card Driver Number

Merchant Name/Type, Shift4 Merchant ID

Assigned Credit Card Merchant Group Name and Number








Service Type and Number

Service Type and Number

Installation Checklist Print and use this checklist throughout the configuration process to ensure MICROS Simphony is properly configured. Contact the Shift4 Support department at 702.597.2480, option 2, with any questions.

1. Prior to Configuring MICROS Simphony

Settling Batches

Verifying the UTG Installation and Configuration

2. MICROS Simphony Configuration

Hardware Settings

Property Settings

3. Post-Configuration Process

MICROS Simphony System Verification

Running a Test Transaction




Prior to Configuring MICROS Simphony Before configuring the MICROS Simphony system for use with Shift4’s UTG, customers must settle all outstanding batches in the system and verify the UTG installation and configuration.

Settling Batches Customers must settle any outstanding batches either by running the MICROS Simphony Batch Auto Sequencer or by executing the company’s normal settlement process.

The MICROS Simphony Batch Auto Sequencer is configured to automatically run reports and archive them as part of the Batch Auto Sequencer process. Customers can run the Credit Card Report from the MICROS Simphony Enterprise Management Console (EMC) to confirm that all batches were settled.

WARNING! Settle any outstanding batches before proceeding to prevent loss of information. Once configuration is complete, customers will no longer be able to settle batches with transactions that were processed prior.

Verifying the UTG Installation and Configuration The UTG must be installed and configured on the same network as the MICROS server and terminals. Make any necessary changes to the UTG installation and configuration before proceeding.

For assistance in installing the UTG, please see the following document: Universal Transaction Gateway® Quick Installation Guide.

For assistance in configuring the UTG, please see the following document: Configuring the UTG for MICROS Simphony Version 1.7.




MICROS Simphony Configuration Use the Enterprise Management Console (EMC) to configure the MICROS Simphony system for use with Shift4’s UTG by modifying Hardware and Property settings.

Accessing the EMC To access the EMC, perform the following steps:

1. From the Start menu, select Programs > MICROS > EMC while logged in as an Administrator.

2. The merchant will enter their MICROS ID and password.

3. Under Locations, select the Enterprise Property.

Tip: Maximize the EMC window to ensure all settings, options, and menus are visible.




Hardware Settings The EMC provides access to the Hardware menu where changes will be made and verified to Service Hosts, Interfaces, Service Host Status, Credit Card Drivers, and Credit Card Merchant Groups settings to support Shift4’s UTG.

Configuring Service Hosts To add and configure a Service Host that will host the CaDOTN interface, perform the following steps:

1. In the EMC window, on the Home Page tab, locate Hardware and select Service Hosts.

2. In the EMC window, on the Service Hosts tab, click to add a new record. Click Yes when prompted.

3. Configure the following settings for the new record:

● In the Name box, type a name that defines what this Service Host will be used for (it is not case sensitive and usually corresponds to a terminal or PC). Record the name on your reference list, you will need it later.

● In the Host Name box, type the Service Host’s IP Address, record the number on your reference list, you will need it later.

● (Optional) In the Subnet Mask box, type the Subnet Mask if configured. ● (Optional) In the Default Gateway box, type the Default Gateway if configured.

4. Click to save the settings.

5. Close the Service Hosts tab.

6. If the created Service Host that will host the CaDOTN interface will be on a terminal, continue to “Configuring the MICROS Terminal.”




Configuring the MICROS Terminal

To configure the MICROS terminal to work with the newly created Service Host using the Client Application Loader (CAL), perform the following steps:

1. On the MICROS terminal, from the Start menu, select Programs > MICROS Client Application Loader > StartService.bat.

2. In the MICROS CAL window, click Configure CAL.

3. In the McrsCAL window, type the MICROS Security Code.

4. Click Next. 5. In the MICROS CAL - Select CAL Server window, under Available Servers, select the

Simphony Server Name from the list and click Next. 6. In the Property Search and Select window, select your property name and click Next. 7. In the MICROS CAL – Select WS Identity window, select Show Service Host. 8. Select the newly created Service Host and click Save.

9. Reboot the terminal.

10. Restart the Simphony server.




Configuring Interfaces To add and configure Shift4’s CaDOTN interface, perform the following steps:

1. In the EMC window, on the Home Page tab, locate Hardware and select Interfaces.

2. In the EMC window, on the Interfaces tab, click to add a new record.

3. In the Insert Record window:

● Select Next available position. ● Click OK to add the record for the new interface. ● Record the number assigned to the new interface on your reference list, you will need

it later.

4. In the EMC window, on the Interfaces tab, verify the new interface record is selected and click

to switch to Form view.




5. Click the General tab and configure the following settings:

● In the Name box, type CaDOTN. ● In the Communication Name box, type CaDOTN. ● In the Interface Type list, select CA/EDC. ● In the Communication Type list, select TCP/IP. ● (Optional) In the Backup Interface list, select the Backup Interface if configured. ● In the Offline Posting Link list, select None. ● In the Timeout box, type 65. ● In the Ping Frequency box, type 0, which is the default; 5 will keep it alive. ● In the ISL Script Name box, leave it cleared.

6. Click the Service Host tab and select the following: ● Click Select. ● In the Select Service Host window, select the newly created Service Host recorded

on your reference list. ● Click OK.




7. Click the Options tab and configure the following settings:

● Under Options, select the following: o Select Use 19 Digit Reference Entry for PMS Inquiries. o Select Allow Inquiry without Sign-In. o Select On = Use 9 digits for Terminal IDs;OFF = Use 2 digits for

Terminal IDs. ● In the TCP Host Name box, type the UTG Simphony Interface IP Address recorded

on your reference list. ● In the Port Number box, type the UTG Simphony Interface Port Number recorded on

your reference list.


9. Close the Interfaces tab.




Verifying the Service Host Status To verify the Service Host Status, perform the following steps:

1. In the EMC window, on the Home Page tab, locate Hardware and select Service Host Status.

2. Verify the Service Host’s information appears and the Connection is Up.

3. Close the Service Host tab.




Configuring Credit Card Drivers To add and configure the credit card driver that the Service Host will host, CAPMS, perform the following steps:

1. In the EMC window, on the Home Page tab, locate Hardware and select Credit Card Drivers.

2. In the EMC window, on the Credit Card Drivers tab, click to add a new record.


● Select Next available position. ● Click OK to add the record for the new credit card driver. ● Record the number assigned to the new credit card driver on your reference list, you

will need it later.

4. In the EMC window, on the Credit Card Drivers tab, verify the new credit card driver record is

selected and click to switch to Form view.




5. Click the General tab and configure the following:

● In the Name box, type CAPMS. ● In the Type list, select CAPMS. ● In the Maximum Batch Size, type 0, which is the default. ● Under Configuration, select the following:

o In the Interface list, select CaDOTN. o Select CA Manual Authorization Allowed. o Select Include $0.00 Payment Records. o Select Enable Shift4 Messaging. o Select Send RFID Data. o Select Enable Partial Authorization. o Select Replace Card Number with Token. o Clear Reverse Unused Authorizations if selected.

6. Click the Service Host tab and select the following: ● Click Select. ● In the Select Service Host window, select the newly created Service Host recorded

on your reference list. ● Click OK.


8. Close the Credit Card Drivers tab.




Configuring Credit Card Merchant Groups To configure Credit Card Merchant Groups for Shift4’s Merchant ID, perform the following steps:

1. In the EMC window, on the Home Page tab, locate Hardware and select Credit Card Merchant Groups.

2. In the EMC window, on the Credit Card Merchant Groups tab, click to add a new record.


● Select Next available position. ● Click OK to add the record for the new credit card merchant group. ● Record the number assigned to the new credit card merchant group on your

reference list, you will need it later.

4. In the EMC window, on the Credit Card Merchants Group tab, verify the new credit card

merchant group record is selected and click to switch to Form view.




5. Click the General tab and configure the following:

● In the Name box, type the name that corresponds to the Shift4 Merchant ID. ● Under Credit Card Driver Type And Driver Records, select the following:

o In the Type list, select CAPMS. o In the Primary Authorization list, select CAPMS. o In the Primary Settlement list, select CAPMS. o (Optional) In the Backup Authorization list, select the Backup Authorization if

configured. o (Optional) In the Backup Settlement list, select the Backup Settlement if

configured. ● Under Configuration, type the following:

o In the Merchant ID box, type the corresponding Shift4 Merchant ID. o In the Revenue Center Type box, type the applicable character:

● F for a Food & Beverage revenue center. ● R for a Retail revenue center. ● K for a Kiosk revenue center.


7. Repeat Steps 2, 3, 4, 5, and 6 to add and configure additional merchants if needed.




Property Settings The EMC provides access to the Property Information and Sales menus where changes will be made to Property Merchant Groups and Tender/Media settings to support Shift4’s UTG.

Configuring Property Merchant Groups To configure the Property or Revenue Center Merchant Groups to be the applicable, newly created Credit Card Merchant Groups, perform the following steps:

1. In the EMC window, on the Home Page tab, under Locations, expand the Enterprise Property and select a Property in the system tree.

2. In the EMC window, on the Home Page tab, locate Property Information and select Property Merchant Groups.




3. In the EMC window, on the Property Merchant Groups tab, configure the following:

● In the top row, which is the Property’s row, in the Merchant Group box, click . ● Select the applicable, newly created Credit Card Merchant Group.

o Note that clicking in the Property row’s Merchant Group box will apply the Credit Card Merchant Group selection to all the Revenue Centers within that Property that have Use Property Setting selected in their Merchant Group box.

● To individually configure a Revenue Center within the Property: o In the Revenue Center’s Merchant Group box, click . o Select the applicable, newly created Credit Card Merchant Group.


Requirement: Repeat all steps in “Configuring Property Merchant Groups” to configure all Property and Revenue Center Merchant Groups to be the applicable, newly created Credit Card Merchant Groups as required. After all Properties and Revenue Centers are configured, close the Property Merchant Groups tab.




Configuring Tender/Media To configure the Tender/Media settings, perform the following steps:

1. In the EMC window, on the Home Page tab, locate Sales and select Tender/Media.

2. In the EMC window, on the Tender Media tab, select a credit card tender and click to switch to Form view.

3. Click the Options tab.

4. Click the Credit Card Options subtab and configure the following:

● Under Payment Credit Card Options, type 0.00 in the following boxes: o Estimated Tip Percentage o Base Limit o Second Limit o Second Limit Percentage o Initial Authorization Amount o Offline Est Tip Percentage o Unauthorized Authorization Threshold o CA Offline Limit o (Optional) In the Quick Service Limit box, type the dollar amount of the

threshold below which the system will obtain authorization but will not require a signature, if needed.




o No Signature Limit ● Select Check Credit Card Expiration Date. ● Clear Credit Card Validity Test to avoid unnecessary, duplicate verification of the

credit card which slows processing. ● Select Require Credit Auth Before Service Total. ● (Optional) Select Require AVS on Manual Entry. ● (Optional) Select Require Card Security Code (CVV) on Manual Entry. ● Select Enable Partial Authorization.


Requirement: Repeat all steps in “Configuring Tender Media” to configure each credit card tender as required. After all credit card tenders are configured, close the Tender Media tab.




Post-Configuration Process After MICROS Simphony has been configured, verify it is operational by completing this section.

MICROS Simphony System Verification To verify the MICROS Simphony System, perform the following steps:

1. In the EMC window, on the Home Page tab, under Locations, select the Enterprise Property.

2. In the EMC window, on the Home Page tab, locate Hardware and select Service Hosts.

3. On the Service Host tab, select the Service Host and click to switch to Form view.




4. Under Services, record the Service Type and Service Number on your reference list, you will need them later.

5. Navigate to …\Micros\Simphony\ServiceHost.xml. 6. Right-click the ServiceHost.xml file and select to Open With Notepad or Wordpad.




7. Locate the following in the file and verify the Service Type Number recorded on your reference list is the same as the number in the file:

● <Service type= “Interface” id = “#” /> … where # is the Service Type Number. ● <Service type= “CreditCard” id = “#” /> … where # is the Service Type Number.

8. If the Service Type Number is incorrect, change the settings in the ServiceHost.xml file by typing the correct number in its corresponding space within double quotes.

9. Save and Close the file.

Running a Test Transaction To test the MICROS Simphony and UTG communication, perform the following steps:

1. Run a test credit authorization, and finalize it as you normally would finalize a real transaction.

2. In DOLLARS ON THE NET, confirm that test transaction came through the right merchant.

3. In DOLLARS ON THE NET, confirm settlement of the test transaction.

4. If your test transaction was successful, configuration, verification, and testing of the UTG is complete, congratulations!

MICROS Simphony Version 1 - Amazon Web Services€¦ · The MICROS Simphony Version 1.7 Technical...

Documents

Transcript of MICROS Simphony Version 1 - Amazon Web Services€¦ · The MICROS Simphony Version 1.7 Technical...