Professional Documents
Culture Documents
1 – Released 08/23/2023
INDEX
INDEX ............................................................................................................................................................................. 1
NOTES ............................................................................................................................................................................. 3
CHANGELOG ................................................................................................................................................................. 3
FLOWCHART ................................................................................................................................................................. 4
General Information ................................................................................................................................................. 5
Scope of Work ............................................................................................................................................................. 5
Simphony Configuration: ....................................................................................................................................... 5
OPI (Oracle Payment Interface) ........................................................................................................................... 5
Offline PMS Interface ............................................................................................................................................. 5
FreedomPay ............................................................................................................................................................. 5
PREREQUISITES ......................................................................................................................................................... 6
Simphony EMC Configuration and Pre-Installation ....................................................................................... 8
CAL Packages (Only for using Lane devices) ............................................................................................... 8
Payment Drivers (Only for using Lane devices)........................................................................................ 10
Payment Module (Only for Lane devices) ................................................................................................... 13
Tender Media (for both Lane Devices and Move Devices CUTOVER) ................................................ 15
Page Design (Only for Lane devices) ............................................................................................................ 20
Tender Parameters (Only Lane devices)...................................................................................................... 23
Extension Application (Only for Lane devices) – CUTOVER FOR LANE DEVICES. ........................ 24
Pay@Table Preinstallation (For Move Devices only) ................................................................................... 27
EMC OPI for Pay@Table Specific Configuration ............................................................................................ 27
Printer Configuration .......................................................................................................................................... 27
Workstations for POS API Configuration .................................................................................................... 30
P@T Employee Configuration........................................................................................................................... 34
OPI Installation for Pay at Table ........................................................................................................................ 37
INSTALL JAVA (PRE-REQUISITE FOR MYSQL) .......................................................................................... 37
INSTALL MYSQL (PRE-REQUISITE FOR OPI)............................................................................................. 37
OPI Installation .................................................................................................................................................... 42
OPI SECURITY PATCH 19.1.1.0 ....................................................................................................................... 49
OPI SECURITY PATCH 19.1.1.7 ....................................................................................................................... 50
OPI Configuration .................................................................................................................................................... 50
Import the settings Template File ................................................................................................................. 50
FreedomPay Antonio Service Installation ....................................................................................................... 54
1
BACK TO INDEX
V1.1 – Released 08/23/2023
2
BACK TO INDEX
V1.1 – Released 08/23/2023
NOTES
This guide will be updated as the installation becomes more streamlined and methods are standardized for
each hotel chain. Be mindful of the guide version you are currently reading and take notes of anything
that is not contemplated in each step.
Much like in OPI and FCC installations, POS Simphony can have different devices in a property:
Lane devices (L3000, L5000, L7000, referred to as “Lane Devices” from now on) and/or Move devices
(Move 5000). Depending on the deployment requested by the property staff or indicated by the invoice
email, the installation of either or both options will require different steps, and it is the job of the installer
to be mindful of the process. Because of the nature of each installation being different, this guide aims to
keep the installer on a single line, with clear indications on where and how to proceed according to each
situation.
On some key words, you will find notes that explain the function of certain items, as well as what some
acronyms mean, so that the installer can comprehend the installation process and learn to adapt to
certain situations that may arise. This information comes from both personal and collective experience, as
well as official documentation, linked below.
CHANGELOG
V1. Release – 08/21/2023
V1.1 – 08/23/2023
Syntax corrections.
Troubleshooting scenarios.
Reference Documentation:
Oracle Simphony - https://docs.oracle.com/cd/F14820_01/doc.191/f15052.pdf
3
BACK TO INDEX
V1.1 – Released 08/23/2023
FLOWCHART
4
BACK TO INDEX
V1.1 – Released 08/23/2023
General Information
This document describes the process to configure and install FreedomPay Credit Cards in Simphony 18.2
and later, currently for Marriott properties.
Scope of Work
Simphony Configuration: This will require proper access to the different environments for the following
modules:
• Enterprise level
o Employee Maintenance
o CAL Packages
• Property and RVC
o Extension Application
o Payments
o Payment Drivers
o Tender Media
o Page Design
o Workstations
o Tender Parameters
o Printers
o RVC Configuration
FreedomPay
• Download media from the share file Marriott CALA-Mexico / Marriott EU / Marriott US.
• Antonio Service Install and configuration.
5
BACK TO INDEX
V1.1 – Released 08/23/2023
PREREQUISITES
1. Configuration Deployment.
Marriot has 4 different types of properties:
o Marriott GPOS
▪ Miemc.simphony.net (http://Miemc.simphony.net/SimphonyApp )
o Marriott Global
▪ Mar01-ohsim-prod.microsdc.com (http://Mar01-ohsim-
prod.microsdc.com/SimphonyApp )
o Starwood
▪ Swdtrans.microsdc.com (http://Swdtrans.microsdc.com/SimphonyApp)
o On-Premise
▪ Application and Database are in local servers at the property.
In the On-Premise cases, most of the time the installer will have to:
Each property will belong to a different host. It is up to the installer to check which EMC client the
property belongs to.
In order to have all EMC Clients installed at the same time, it is recommended to download and
then rename the origin folder for each appropriately (e.g, Marriott EU will be C:\Program
Files\Oracle Hospitality\EMCClient Global), so that the clients can be installed and ran through
different shortcuts.
Once the correct EMC client is downloaded, enter with your credentials.
6
BACK TO INDEX
V1.1 – Released 08/23/2023
2. At the start of the meeting, confirm with your Marriott Contact/Hotel POC:
a. Quantity and types of devices to be installed. (XX Lane devices or XX Move Devices).
b. Hotel does not have any Credit Card transactions running (For Lane Devices Preinstall and
Cutover).
c. Hotel has admin access in order to login to CAPS (Check and Posting Server), OPI (Opera
Payment Interface) server and IFC Server, if applicable.
3. Coordinate with the Hotel Tech Contact the way to get connection to the Server where OPI Services
will be installed. Typically, hotels have a dedicated server for OPI, but it is also possible that they
have chosen to install OPI, Antonio, mySQL and Java in the CAPS Server or the IFC Server.
If only Lane Devices are to be installed, then proceed to SIMPHONY EMC CONFIGURATION and
PREINSTALLATION.
If both Lane Devices and Move Devices are to be installed, then start from SIMPHONY EMC
CONFIGURATION and PREINSTALLATION.
If the property is cutting over with Lane Devices, then proceed to EXTENSION APPLICATION and
CUTOVER for LANE DEVICES
If the property is cutting over with Move Devices, then proceed to TENDER MEDIA (for Lane Devices
and Move Devices CUTOVER)
7
BACK TO INDEX
V1.1 – Released 08/23/2023
You need to make sure you have access to each property with privileges to Override and configure the
Payment and Payment Driver modules as well as Tender Media, Extension Application, Page Design at the
Property levels and some cases in the RVC levels if each RVC will use unique Store IDs, as well as
Employee Maintenance and CAL Packages at the Enterprise levels.
Also, to take note of, within EMC you may have access to all properties. In order to select the correct
property, you must filter the MARSHA code so as not to mistakenly modify any other property.
For Cloud Environments: First check to make sure the CAL packages are already available:
8
BACK TO INDEX
V1.1 – Released 08/23/2023
• Under Custom
o Validate that the CAL Packages are set to deploy for the property you are working on.
9
BACK TO INDEX
V1.1 – Released 08/23/2023
• Save
• Report that the installation step has been completed in the Chat, and continue.
• Navigate to the property level, select the setup tab, under Hardware/Interfaces select Payment
Drivers.
10
BACK TO INDEX
V1.1 – Released 08/23/2023
• Right Click on the row that you need to override (Generally is named VisaD, OPI or SPI)
• Select Override Record, Using Existing Record.
If each RVC has a different StoreID, the installer will have to modify the same settings for each Revenue
Center within EMC by accessing each one separately and going through the same changes.
12
BACK TO INDEX
V1.1 – Released 08/23/2023
• Report that the installation step has been completed in the Chat, and continue.
• Navigate to the property or RVC level, select the setup tab, under Hardware/Interfaces select
Payments.
13
BACK TO INDEX
V1.1 – Released 08/23/2023
• Right Click on the row that you need to override (Generally is named Credit Cards).
• Select Override Record, Using Existing Record.
14
BACK TO INDEX
V1.1 – Released 08/23/2023
• Save
• Report that the installation step has been completed in the Chat, and continue.
Tender Media (for both Lane Devices and Move Devices CUTOVER)
Validate that you have access to override and configure the Tender Media.
• Navigate to the property level, select the configuration tab, under Sales, select Tender Media.
15
BACK TO INDEX
V1.1 – Released 08/23/2023
16
BACK TO INDEX
V1.1 – Released 08/23/2023
17
BACK TO INDEX
V1.1 – Released 08/23/2023
18
BACK TO INDEX
V1.1 – Released 08/23/2023
• Save
• Report that the installation step has been completed in the Chat, and continue.
To finish the Cutover with the Move Devices, jump to Move Devices Testing (Cutover Phase).
19
BACK TO INDEX
V1.1 – Released 08/23/2023
• Navigate to the property level, select the Configuration tab, under User Interface, select Page
Design (The design may differ from location to location).
• Select Payment Screen, it can also be found as EMV CC screen.
• If present, validate that you have Auth Credit Card, Card Finalize and Card Refund with the
following configuration:
o “Auth Credit Card”/”CC AUTH”/”Authorize Credit Card” (the argument should say:
CreditDebit:Loadable CreditAuthOnly)
Type: Payment Tenders
In the field below it, click on the right pointing arrow, select:
0 – None
On Payment Type, select CreditDebit: Loadable
On Functions, select CreditAuthOnly
20
BACK TO INDEX
V1.1 – Released 08/23/2023
21
BACK TO INDEX
V1.1 – Released 08/23/2023
Type: Function
0 – None
On Payment Type, select CreditDebit: Loadable
On Functions, select CreditAuthAndPay
• Save
If any of these buttons are missing, you will have to create the space within the Payment/EMV CC screen
and add the 3 buttons. If needed, you can remove the Visa, Mastercard, AMEX, etc buttons.
Be mindful of the design and try to follow the same as the property had previously.
You can change the colour of each button on the “Style” section, on its right pointing arrow.
22
BACK TO INDEX
V1.1 – Released 08/23/2023
• Report that the installation step has been completed in the Chat, and continue.
• Navigate to the property level, select the Setup tab, under Parameters, select Tender Parameters
23
BACK TO INDEX
V1.1 – Released 08/23/2023
• Select the Configuration Tab and set the Default Payment Tender to OPI Default
• Save
• Report that the installation step has been completed in the Chat, and continue.
24
BACK TO INDEX
V1.1 – Released 08/23/2023
25
BACK TO INDEX
V1.1 – Released 08/23/2023
Before proceeding:
The installer must check on the invoice and/or ask the property staff what version of EMC they are using,
as that will dictate the following .dlls that the installer will be using for the cutover.
If the property is using EMC 18.2, the installer has to download and load the files off of
“FreedomPayRemoteController” within the Marriott CALA-Mexico / Marriott EU / Marriott US fileset. (look
for the “FSWS” folder for each region/country).
If the property is using EMC 19.4+, the installer has to download and load the files off of
“FreedomPayRemoteControllerV2” within the Marriott CALA-Mexico / Marriott EU / Marriott US fileset. (look
for the “FSWS” folder for each region/country).
Troubleshooting: If while trying to reload the database, the workstation shows a connection error to the
likes of “Could not connect to net.tcp://127.0.0.1:9095 (or any other port different from 8081), refresh the
database, if that does not work, restart the workstation and try again. If the EMC settings are correct, then
refreshing the database and restarting the workstation should force the devices to download the dlls.
• Report that the Lane Devices Testing has been completed in the Chat, and/or continue with the
Move Devices Cutover.
26
BACK TO INDEX
V1.1 – Released 08/23/2023
27
BACK TO INDEX
V1.1 – Released 08/23/2023
28
BACK TO INDEX
V1.1 – Released 08/23/2023
• On the next screen, the workstation must be the POS API workstation recently created, and the
printer type must be Local Disk File.
• On Printer Configuration, in File name, type in “C:/Micros/Simphony/CAPS.PRT.TXT” Other variants
are “Journal.txt”, “Record.txt”.
• Save
29
BACK TO INDEX
V1.1 – Released 08/23/2023
• Report that the printer has been set up in the Chat, and continue.
• Navigate to your Property > Setup Tab > Hardware/Interfaces > Workstations
• Right Click on CAPS WS/SERVER and choose Copy (Make sure you select the correct workstation).
• Right click again on the CAPS Record and chose QUICK ADD > Create Record from Copy
30
BACK TO INDEX
V1.1 – Released 08/23/2023
• Choose # 3-POS API Client under Type and for ServiceHost ID Choose the original workstation you
copied from. Take note of the IP address as you will be using it later.
• If available, make sure that the option “Enable Simphony Transaction Services 1” is checked.
• You can check the Servicehost ID in the workstations list to make sure you selected the correct
workstation.
• Head to the Revenue Centers tab, and make sure that the POS API workstation has access to all the
Revenue Centers under which the Move Devices will be working.
31
BACK TO INDEX
V1.1 – Released 08/23/2023
• Save
• If you do not know if the POS API workstation has been created already, check if one of them has
“POSAPI Client” in the Type column, or “Pay@Table-API” in the Workstation class column, and that
it is a copy of the CAPS server (by checking the IP address).
• If no workstation shows up as CAPS, the installer can check EMC > Property > Property Parameters
> Workstations and see which one says “Check and Posting”. That one should correspond to the
CAPS.
• Save
• Because the File Printer has already been set up, click on the Printers Tab.
• On it, click on the Select button in the Customer Receipt Printer, and select the new File Printer you
have just created. Then, click on the “Set for All Printers” Button under it.
32
BACK TO INDEX
V1.1 – Released 08/23/2023
• Save
33
BACK TO INDEX
V1.1 – Released 08/23/2023
• Report that the installation step has been completed in the Chat, indicating the IP Address of the
POS API workstation created and the Printer is assigned, and continue.
• Search for Object Number 999900006 and Double Click on the record found.
Bare in mind that there could be variants such as Employee number 3, or employee number
999900001.
34
BACK TO INDEX
V1.1 – Released 08/23/2023
35
BACK TO INDEX
V1.1 – Released 08/23/2023
• Select Insert
• Save
• Report that the Pay At Table Employee has been assigned to the property in the Chat, and
continue.
36
BACK TO INDEX
V1.1 – Released 08/23/2023
• Follow defaults prompts until you get “You have successfully installed java”
37
BACK TO INDEX
V1.1 – Released 08/23/2023
38
BACK TO INDEX
V1.1 – Released 08/23/2023
• Click next to advance to the Type and Networking options. Leave defaults in place and click next.
• Enter the password for the root account as opiadmin19.1 (or the ones provided previously)
then click next.
39
BACK TO INDEX
V1.1 – Released 08/23/2023
• On the Windows Service Screen leave the defaults in place then click next.
• Select “No, I will manage the permissions after the server configuration” and click Next.
40
BACK TO INDEX
V1.1 – Released 08/23/2023
• Click Finish on the last screen of the MySQL Installation then click finish again to exit.
41
BACK TO INDEX
V1.1 – Released 08/23/2023
OPI Installation
• From the OPI/Pre-requisites package, run the OraclePaymentInterfaceInstaller_19.1.0.0.exe, then
click ok for the English Language default.
• Click Next on the welcome screen, then click next on the Pre-requisites screen.
• Leave the selection on “Complete” then click next, leave the default folder in place and click next.
42
BACK TO INDEX
V1.1 – Released 08/23/2023
• MySqL should be selected as the database then click next, then leave the default port then click
next.
• Enter root as the Login ID and opiadmin19.1 as the password for the Database Server Login then
click next.
• NOTE: Be aware that, if the property has provided their own credentials, you must adhere to those
changes.
43
BACK TO INDEX
V1.1 – Released 08/23/2023
• Enter opidbuser as the and Opidbuser191! as the password, confirm the password for the
Database User then click next
• NOTE: Be aware that, if the property has provided their own credentials, you must adhere to those
changes.
• You should see a “Database Connection Successful, then click ok, then you should see “Database
Configuration operation successful” then click ok again.
44
BACK TO INDEX
V1.1 – Released 08/23/2023
Enter opiconfiguser as the username and OpiConfiguser191! as the password for the Super User
account for the configurator then click next-
• NOTE: Be aware that, if the property has provided their own credentials, you must adhere to those
changes.
• You should see a “Create Super User Operation Successful, then click ok
45
BACK TO INDEX
V1.1 – Released 08/23/2023
• Accept the default connections for the Configuration tool Connection and click next
46
BACK TO INDEX
V1.1 – Released 08/23/2023
• Select “POS” and the instance and “Native Driver” then click next
47
BACK TO INDEX
V1.1 – Released 08/23/2023
48
BACK TO INDEX
V1.1 – Released 08/23/2023
• Restarting the CAPS/OPI server is not necessary. Instead, you can restart the OPI Service.
You should see a “database upgrade operation was successful” message, click ok to exit
49
BACK TO INDEX
V1.1 – Released 08/23/2023
• You should see a “database upgrade operation was successful” message, click ok to exit.
OPI Configuration
Import the settings Template File
• Launch the OPI Configurator C:\OraclePaymentInterface\v19.1\Config\LaunchConfiguration.bat
• Login as opiconfiguser (unless the property provided with their own credentials)
50
BACK TO INDEX
V1.1 – Released 08/23/2023
• Navigate to the Import Configuration Menu then click import, then click ok again.
From the fileset Package choose the correct OPI.XML file for that region, then click ok.
• In the OPI Configuration navigate to Merchants > Configuration and delete one of the entries (if
more than one are present) and modify the other by pressing on the wrench button.
51
BACK TO INDEX
V1.1 – Released 08/23/2023
• Update the Highlighted Fields for your location starting with the FreedomPay StoreID, then click
save when finished.
• Navigate to the Pay-At-Table Devices tab and you will find two PAT devices for two RVCS already
prepopulated. Update the RVC ID to match your RVC numbers in EMC.
• Make sure you add the RVCs in sequential numbers so the Device ID will match the order, the
Device ID is unique to the RVC. Ex. You have 2 RVCs, 101 and 201, sequentially the Device ID
should be 1111111 for 101 and 2222222 for 201. The Device IDs are 7 digits long, when you get to
the 10th Device ID then you need 1010101, 2020202, Etc. Make a note of the Device IDs as you will
need them for the FreedomPay Pay-At-Table Config file.
• Navigate to the Settings Tab and set the IP of the POSAPI Workstation created in EMC. After that,
access that full website from a web browser. If it cannot be accessed (it should direct to what
appears to be an XML file), then make sure there is communication between the OPI server and the
CAPS by pinging it, and that the port is opened.
• Make sure the Employee fields are the same as the employee used for P@T in EMC (Employee N°
999900006) and Save.
52
BACK TO INDEX
V1.1 – Released 08/23/2023
• Navigate to the Pay-At-Table > Service Settings tab then update the certificate password to
PT@bl12016
• Set Mode to HTTP
• Uncheck Enable Secure Connection
• Uncheck TLS 1.2
• Save
• Navigate to the Pay-At-Table > POS API Settings tab then add the Tender Media # from EMC for
each Credit Card Tender, Print Check and Service Charge use for Tips in EMC and Save.
53
BACK TO INDEX
V1.1 – Released 08/23/2023
• Report that the OPI has been installed and configured in the Chat, specifying the IP Address where
OPI was installed, and continue.
The following tags need to be populated with site specific information received with the Site Readiness
Survey. Please note, examples below refer to an installation where 2 RVCs are required. Each OPI instance
is limited to 8 RVCs. If more than 8 RVCs are required, a new OPI Instance is required. This will be
contemplated in the ANOMALIES AND TROUBLESHOOTING SCENARIOS section.
It is suggested that the installer downloads Notepad++ from here, as it will greatly aid in editing the file.
• SegmentList: Enables devices to be used in multiple RVCs. Each number relates to an individual
Segment ID. This will vary according to how many RVCs will be using the Move Devices; If there
are 4 RVCs, then there should be 4 segments. This example shows 2 RVCs being used.
54
BACK TO INDEX
V1.1 – Released 08/23/2023
• POS.LoginType: Operators are requested to sign into device with OPI integrations. Options
available are Key or Swipe. Ask the property POC for clarification on which method they would like
to use, but usually it is the swipe one (the employee swipes their Micros card before a transaction).
• Saf.FloorLimit: Relates to Transaction Store and Forward. Allows a limit of offline transaction
approval if communication to Freeway Web Service is down. Leave this as default, as it can allow
for exploitation from the customer.
• Saf.Post.AllowOffline: Relates to Post Payment Store and Forward. Enables ability to store
checks that are unable to close on Simphony. Once available, Saf.Post.AllowOffline will post and
close check.
• OPI.Url: IP address where OPI is installed. It may differ if Antonio Service and OPI are not
installed on the same server.
• OPI.DeviceID: Relates to the Terminal ID specified in OPI. This is essential to the standard
configuration and must follow the same order as how it was set up in OPI. Example enables for 2
RVCs. Add or Remove line items as required to match the Segments/RVCs.
• OPI.MerchantID: Specify Store ID for each RVC. In some Marriott properties, the StoreID can be
different for each RVC, always corroborate this information prior to the preinstall. Add/Remove line
items as required (matching with the amount of Segments/RVCs).
55
BACK TO INDEX
V1.1 – Released 08/23/2023
• POI.enableRvcSelection: It needs to have a value of true as it will allow the Move Devices to
switch between RVCs. It needs to reflect the number of RVCs (if there are 6 RVCs, then there
should be 6 lines, each numbered 1 to 6).
• POI.RVCList: Defines RVC selection for Flexible RVC mappings, this means that the devices will be
able to change RVCs without an issue, which is ideal. Remove line items as required (NOTE: UPP
Devices (Americas – Ports 7001) have a limitation of 4 RVCs, while RAM Devices
(Europe – Ports 6001+) have a limitation of 8 RVCs). For more than 4 RVCs with UPP
Devices, see the ANOMALIES AND TROUBLESHOOTING SCENARIOS section. Bear in
mind that the order of the RVCs matters and must follow the same order as it is within
EMC and OPI. The name of each RVC can be shortened so that the device can fully display the
name.
• OPI.TSURL: Assign IP address of Simphony POSAPI client. Refer to EMC > Workstations
• OPI.EmployeeRVC: Defines RVC ID as specified in OPI. XXX refers to RVC ID in OPI > Merchants
56
BACK TO INDEX
V1.1 – Released 08/23/2023
• OPI.AutoGetCheckNumber: This indicates whether property staff will have to manually select
the check number. When set to auto, property staff will get the last posted check.
• Click Finish
57
BACK TO INDEX
V1.1 – Released 08/23/2023
• Validate the service is installed correctly. If when trying to restart the services, it fails, then there
could be a Syntax error somewhere in the config file, or an Antivirus software is possibly blocking
the file from running.
• Once the service is installed, the PAL Packages need to be installed in the workstation.
Navigate to the folder where the PayAtTable installer is located and find the correct PAL packages or check
the share point link to the corresponding region. The ones the installer should use are the Customer Facing
(no Branding). These files must be moved to C:/Programdata/Freedompay/Atlas/Antonio/Pal.
It is imperative that the installer uploads the correct set of PAL Packages as they will dictate the language
and the functioning standards for each region.
After restarting the Antonio services, the Move Devices that are properly connected to Wi-Fi and charged
should start rebooting and downloading the PAL Packages to each device. The final screen should be
“Secured by FreedomPay” and then allow the property to select the RVC.
• Report Antonio has been installed and configured in the Chat, specifying the IP Address where
Antonio was installed, and continue.
• Create a Backup of the entire SPH folder (copy and paste in the same folder).
• Stop the POS Interface if it is running as a Service; look for “IFC8Service
(Inncode_SPH_ifc8config.xml)”. Inform the property that the POS Interface will be down for a few
minutes, meaning they will not be able to process charges in Simphony.
58
BACK TO INDEX
V1.1 – Released 08/23/2023
• Open the .XML file within the original folder with IFC8.
You should see each interface within the property. If there are many running within the IFC server, ensure
the one you are modifying corresponds to the correct property.
• Head to Properties > Configuration > Log in with Windows Admin Credentials (ask for the property
POC to access or write them down in a notepad, as you may be accessing it a few times).
59
BACK TO INDEX
V1.1 – Released 08/23/2023
• Clone the existing IFC1 object by right clicking > Clone Node
• Click Ignore
60
BACK TO INDEX
V1.1 – Released 08/23/2023
• Click Retry
Once the IFC2 node is created, the installer must change the port to the Marriott Approved one, which is
7138.
• IFC2 > Physical Layer > Port = 7138 > Click somewhere else > Apply
Once that is done, both IFC nodes must have the Parameter “Required” set to N (NO).
61
BACK TO INDEX
V1.1 – Released 08/23/2023
After that, route the Workstation ID of the Offline IFC to the IFC2 object. In order to do that, the installer
must:
• PMS1 > Right Click on WSNumX parameter and select Clone & Rename Item > Rename as
WSNum000000099 > Set Value = IFC2 > Apply
62
BACK TO INDEX
V1.1 – Released 08/23/2023
After that, clone the WSNumX parameter again and rename it as WSNum99 and set the Value to IFC2
• PMS1 > Right Click on WSNumX parameter and select Clone & Rename Item > Rename as
WSNum99 > Set Value = IFC2 > Apply
63
BACK TO INDEX
V1.1 – Released 08/23/2023
The installer must then change the LA_Timeout Parameter in each IFC Object from its default value of
3000 (ms) to 6000
64
BACK TO INDEX
V1.1 – Released 08/23/2023
The installer must then mark the IFC objects to identify the Online and Offline Interface.
65
BACK TO INDEX
V1.1 – Released 08/23/2023
66
BACK TO INDEX
V1.1 – Released 08/23/2023
The POS Interface should now look like this. The IFC2 Offline tab at the bottom, if extended, should light
up on the Link every 30 minutes once the Client is installed.
• Report that Offline IFC Interface has been created in the Chat, and proceed.
67
BACK TO INDEX
V1.1 – Released 08/23/2023
Supported Version
• Simphony 2.10.3 and higher
• WIN 32 Client with Windows 7 32/64 or Windows 10 32/64 as CAPS/ PMS Client
• Database SQLExpress 2008 R2 or SQLExpress 2012
Requirements
• The application must reside on the Simphony 2 CAPS which runs by default SQLExpress 2008
R2 or SQLExpress 2012.
• Check and Posting Details must be purged after one week, this is configured by default on each
Check and Posting Workstation.
• This application does not support circumstances where multiple Taxes by item are enabled. It
supports a maximum of 8 Tax Itemizers per check. Any Add-On Tax in the range 9 to 64 is
automatically added to Tax Itemizer 8.
The following settings must be checked in EMC before the Offline PMS Interface is running:
68
BACK TO INDEX
V1.1 – Released 08/23/2023
• Taped Totals i.e. Post Offline Transaction with Actual Transaction Time
Restrictions
Additional restrictions which are currently not outlined below may apply if a nonstandard installation may
be processed.
• The MF_PMS_IFC_Client.exe needs to run on the Simphony2 CAPS client. It cannot be used from
Simphony server nor the Database Server (in case of separate Application and Database Servers).
• The MF_PMS_IFC_Client.exe will typically only post once a day all checks to the PMS (i.e. after
Start-Of-Day of the POS but before End-Of-Day of the PMS). But the application can also be
installed as Windows service. With this, the installer can set the time, in the settings xml file, when
the service posts checks to PMS. By default, this is done every 30 minutes.
• MF_PMS_IFC_Client.exe cannot be used as Windows service and console application at the same
time.
• If the posting process is running you cannot start another posting process.
• On new installations the RunFiExportForPrevDay function will not work for one day to prevent
double postings. This limitation will change on the next day.
• On a new installation, checks closed before installation Date/Time will not be posted.
• The application haves a Summarylog.txt log file for night auditors under the Maintenance folder
• If the AutoReporting parameter is active, the Maintenance folder will be watching for the files
start.now, repostStatus2.now and repostStatus3.now to exist:
o start.now: if exists, will run the MF_PMS_IFC_Client.exe with default settings
o repostStatus2.now: if exists, will delete status 2 record from tables and will run the
MF_PMS_IFC_Client.exe again
o repostStatus3.now: if exists, will delete status 3 record from tables and will run the
MF_PMS_IFC_Client.exe again
• It is not recommended to run the application in a timeframe cycle lower than 15 minutes.
69
BACK TO INDEX
V1.1 – Released 08/23/2023
Bare in mind that if these credentials do not work, the installer should ask the property’s POC for them to
log in with their own. If they do not have credentials and the provided ones here do not work, then
proceed to ANOMALIES AND TROUBLESHOOTING SCENARIOS.
• From the Add User File copy the newly edited password.
70
BACK TO INDEX
V1.1 – Released 08/23/2023
71
BACK TO INDEX
V1.1 – Released 08/23/2023
• Click Install
• Click Finish
72
BACK TO INDEX
V1.1 – Released 08/23/2023
• When the setup has finished to copy the required files, the “Finish” button will display the following
message BUT DO NOT CLICK OK YET!
• Navigate to C:\Micros\Simphony\Custom\MF_PMS_IFC_Client\Tools
• Right Click on “Create_MF-EAME_Db.sql” file and Edit
73
BACK TO INDEX
V1.1 – Released 08/23/2023
• You should see message on the Message Window and close the QueryExPlus App
• Now go to the Offline PMS Install and click OK to finish the install
74
BACK TO INDEX
V1.1 – Released 08/23/2023
• Click Confirm
If for some reason the credentials do not work (occurs from bad copy paste), head to ANOMALIES AND
TROUBLESHOOTING SCENARIOS.
76
BACK TO INDEX
V1.1 – Released 08/23/2023
Bear in mind that if these credentials do not work, the installer should ask the property’s POC for them to
log in with their own. If they do not have credentials and the provided ones do not work, then proceed to
ANOMALIES AND TROUBLESHOOTING SCENARIOS.
77
BACK TO INDEX
V1.1 – Released 08/23/2023
• Navigate to C:\Micros\Simphony\Custom\MF_PMS_IFC_Client
• Right Click on the MF_PMS_IFC_Client.xml and Edit
78
BACK TO INDEX
V1.1 – Released 08/23/2023
• Save.
• Restart MF_PMS_IFC_Client_Service (can be found as either “Micros-Fidelio Offline PMS IFC
Service” or “Oracle FBGBU Offline PMS IFC Service”.
79
BACK TO INDEX
V1.1 – Released 08/23/2023
80
BACK TO INDEX
V1.1 – Released 08/23/2023
In order to check if there is a connection between the Offline PMS in the IFC server and the Client installed
in the CAPS, the installer can run the software from the command line:
C:\Micros\Simphony\Custom\MF_PMS_IFC_Client>MF_PMS_IFC_Client.exe
81
BACK TO INDEX
V1.1 – Released 08/23/2023
If there is no connection between the Offline PMS Client and the IFC side, ping the IP address and telnet
using the port 7138. The installer may need to open the ports manually before continuing.
• Report that Offline PMS Client is running and communicating with the Offline IFC in the Chat, and
continue with the Testing.
• Once all Move Devices have been tested, the Preinstallation is complete.
• If testing was not complete, clarify it in the notes and the reason why, so that the engineer in
charge of the Cutover can follow through with the process.
82
BACK TO INDEX
V1.1 – Released 08/23/2023
Before leaving the call, you must retrieve the following files for the completion email:
• OPI.xml config – You can export this from OPI itself, rename it as [INNCODE]_OPI.xml
• AntonioService.exe.config – You will find this file in C:/Program Files
(x86)/FreedomPay/Antonio
• MF_PMS_IFC_Client.xml – You will find this file in C:\Micros\Simphony\Custom\MF_PMS_IFC_Client
in the CAPS server.
• Unlink the PMS Interface for the CC Tenders in EMC (as covered in the Tender Media section).
• Remove the CC Tenders off of the exceptions in the Offline PMS Client.
• Re-test the Move Devices, ask the Property to check both Opera and the FreedomPay Portal.
• Remind the property that payments in Opera will show up after every 30 minutes.
• Navigate to C:\Micros\Simphony\Custom\MF_PMS_IFC_Client
• Right Click on the MF_PMS_IFC_Client.xml and Edit
• Delete the Tender numbers that correspond to Credit Card Tenders in EMC, so that those numbers
are the only ones that are NOT within the exceptions.
83
BACK TO INDEX
V1.1 – Released 08/23/2023
• Save.
• Restart MF_PMS_IFC_Client_Service (can be found as either “Micros-Fidelio Offline PMS IFC
Service” or “Oracle FBGBU Offline PMS IFC Service”, depending on the version installed).
84
BACK TO INDEX
V1.1 – Released 08/23/2023
Once they do, run the Offline PMS Client in order to force the transactions to go through Opera, and ask
the property POC to check Opera and see if they show up.
Before leaving the call, you must retrieve the following files for the completion email:
OPI.xml config – You can export this from OPI itself, rename it as [INNCODE]_OPI.xml
AntonioService.exe.config – You will find this file in C:/Program Files (x86)/FreedomPay/Antonio
MF_PMS_IFC_Client.xml – You will find this file in C:\Micros\Simphony\Custom\MF_PMS_IFC_Client in the
CAPS server. Make a copy as it will reflect the new CC Tenders.
After everything is working, answer any questions the property POC may have and report that the Cutover
has been complete.
1. On EMC, the installer must create a new POS API workstation based off of another workstation
other than the CAPS. While all workstations should be able to process payments for it, ask the
property POC if there is a workstation that is guaranteed will be active while the property is open.
85
BACK TO INDEX
V1.1 – Released 08/23/2023
Once the POS API workstation has been created, we need to head to the Revenue Center tab, and make
sure that ONLY the Revenue Centers that were left out in the previous POS API are selected here. In the
example below, the property has 9 RVCs, so only the last one is selected as active for that POS API.
Within the AntonioService.exe.config, it is necessary to change which POS API it will have to connect to in
order to process the payments for that specific RVC. In order to do that, we need to add lines in
“opi.TSURI” so that it looks like this (example given with 9RVCs):
Here, the last RVC will be pointing at the new POS API (usually indicated by an IP Address) we have just
created. That way, whenever a transaction is done in that RVC, it will be processed in the indicated POS
API Workstation instead of the CAPS.
The rest of the Antonio Config file will reflect the amount of segments/RVCs as before (1 line for each).
86
BACK TO INDEX
V1.1 – Released 08/23/2023
3. OPI Configuration.
Within OPI, we must create a New Merchant that will contain the same basic information as the previous
one:
• Name
• City
• State or Province
• Country/Region
• Tenders Employee Number
• Users Employee Number
• Tables Employee Number
87
BACK TO INDEX
V1.1 – Released 08/23/2023
• Enter the POS API website to validate there is communication between the POS API and OPI.
As it is the case, the RVC number must reflect the correct number within EMC and Antonio.
88
BACK TO INDEX
V1.1 – Released 08/23/2023
Once everything is set up properly, each time a transaction is made in the 9th + RVC, it will trigger a
response from the second merchant we created, which points to the previously created POS API and allow
transactions.
A common practice is to assign RVCs 1,2,3 and 4 to Device 1, then RVCs 5,6,7 and 8 to Device 2. If that is
the case, then proceed with that. In the below example, there are 6 RVCs, so 1,2,3 and 4 were assigned to
Device 1, and 3,4,5 and 6 were assigned to Device 2.
There is however, a possibility that the property POC wants to have RVCs 1,3,5 and 9 to be run with a
specific Device.
If that is the case, the installer must indicate to the property POC which ports to connect to depending on
which RVCs they will be using. See the following example:
In this particular case, the Devices assigned to ports 7001 to 7008 will be assigned to RVCs 100 to 800,
and the Devices assigned to port 7009 will be assigned to RVCs 100, 300, 500 and 900.
Take into account that running this script will temporarily shut down the CAPS ServiceHost (Simphony),
and the property POC needs to be warned about this.
90
BACK TO INDEX
V1.1 – Released 08/23/2023
• Replace the Password for “MF_EAME” and confirm it with the same password.
You should now be able to log back into QueryExPlus with the MF_EAME db credentials.
Within it, go to the Server Section, and under it, add the following lines:
XX:XX being the time zone corresponding to the region the property is in. Once that is done, restarting the
mySQL service and trying again should work.
91
BACK TO INDEX