Oracle Food and Beverage Harmonized Interface For POS
Oracle Food and Beverage Harmonized Interface For POS
Oracle Food and Beverage Harmonized Interface For POS
2 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
TABLE OF CONTENTS
Disclaimer 2
Preface 5
Audience 5
Customer Support 5
Documentation 5
Revision History 5
1 Introduction 8
Overview 8
Features 8
Harmonized Interface for POS Enablement Program 9
Oracle Integration Validation 9
Advantages for Partners 9
Oracle General Responsibility Assignments 11
Oracle and Oracle Partners Features Responsibility Matrix 12
3 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
7 Harmonized Interface for POS Configuration 46
Harmonized Smart Studio - HSS 46
Step 1 – General Settings 46
Step 2 – Workstation 47
Step 3 – Additional Settings 49
Step 4 – Oracle Integration Settings 50
Step 5 – Oracle Adapter Settings 51
Step 6 – Saving and Export Configuration 52
8 Installation Checklist 53
Verify the Creation of Documents Folder Structure 53
Verify the Extension Application Harmonized at Workstations (Simphony) 53
9 Operation 54
Generate a Fiscal Document 54
Payload 54
Check Fiscal Document Status 54
View Config 54
Export Config 54
10 Support 55
Support Best Practices and Issues Handling 55
Issues Diagnostic/Troubleshoot steps 55
Issues Escalation 55
Feature Requests 56
4 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
PREFACE
This document provides instructions to configure Simphony with the Harmonized Interface for POS. It describes the
Harmonized Interface characteristics, features, and best practices to internal Oracle teams, Oracle Customers or Oracle
Partners when developing this integration using Payload Application Programming Interface (API) and when the
Electronic Invoice (EI) is used for a country using Simphony.
Audience
This document is intended for Oracle Consulting Team, Oracle Partners and System Administrators that develop, install,
and maintain the Oracle Hospitality Simphony as the POS solution and the Harmonized Interface for POS as the
integration Interface.
Customer Support
To contact Oracle Customer Support, access My Oracle Support at the following URL:
https://support.oracle.com
When contacting Customer Support, please provide the following:
• Product version and program/module name
• Functional and technical description of the problem (include business impact)
• Detailed step-by-step instructions to re-create
• Exact error message received
• Screen shots of each step you take
Documentation
Oracle Hospitality product documentation is available on the Oracle Help Center at
https://docs.oracle.com/en/industries/food-beverage/index.html
Revision History
DATE DESCRIPTION OF CHANGE
5 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Troubleshooting Review
6 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
May 2023 Changed Version
Document Review
Added Support to Menu Item Quantity Voiding for Simphony 19.4 when option
24 - Treat Error Corrects as Voids at Control Parameters is enabled (Negative
Items). New mandatory configuration is present at HarmonyConfig that must be
used for ALL Simphony Versions no matter if the option bit is enabled or
disabled.
7 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
1 INTRODUCTION
Harmonized Interface for POS is a powerful interface that leverages Electronic Invoice processing and integrates with
Oracle Food and Beverage Simphony. Harmonized Interface for POS and Payload API permits third-party companies,
like Electronic Invoice Providers, to integrate with Oracle F&B Products and receive custom POS check information to
perform invoice processing.
Any third-party company that needs fiscal and non-fiscal data from the POS to generate the Electronic Invoice or any
other Application can use the Harmonized Interface for POS and Payload API.
Overview
Harmonized Interface for POS adds transparency for installation and configuration tasks as only one Installation Package
can be used for all Simphony Versions. This fiscal solution is closely aligned with property administrator goals, providing
centralized control and maintenance.
New Harmonized comes Ready to Go! Core Settings are embedded into product code and minimal or even none
configuration is necessary.
New Harmonized Smart Studio – HSS – delivers to Oracle Customers, Fiscal Partners and Consulting Services the
necessary agility to configure and customize Interface settings.
Features
8 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Harmonized Interface for POS Enablement Program
The Harmonized Enablement Program is a structured process to help Oracle Partners or Oracle Customers to build an
integration with Harmonized Interface for POS
9 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
• Expand your Business
• Save Time
• Learn and Install Harmonized to your Customer
• Harmonized Interface guarantees standard integration
Technical
• Easy to Integrate
• Use XML or JSON
• REST Web Service, Socket or API Support
• Naturally integrated to Simphony
Development
• Full Access to Interface Documentation and Toolkit
Operations
• Oracle Customer Transparent Operation
Installation, Maintenance and Support
• Installation procedures are made directly from EMC, without workstation local intervention or configuration
• Easy to Configure, Upgrade and Maintain
• Guaranty Equal Workstation Configuration
• Use Harmonized Smart Studio to configure your Integration Parameters
10 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Oracle General Responsibility Assignments
The following table describes the general task responsibilities:
RACI DEFINITIONS
R Responsible The person who performs an activity or does the work within the phase or task.
C
The person that needs to feedback and contribute to the activity. Contributes to the phase or task
Consulted
and provides guidance and support.
I
The person that needs to know of the decision or action. Informed and aware of requirements and
Informed
what has been delivered to support or provide assistance.
Oracle
Project Deliverable Oracle Oracle Oracle Oracle Oracle
Fiscal
(or Activity) Fiscal R&D Partner Consulting Customer Sales
Strategy
11 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Test Integration with Oracle Fiscal R&D
A R I I C I
Test Integration with Oracle Customer
C R I I A I
Oracle
Oracle Oracle Oracle Oracle Oracle
Integration Feature, Task or Procedure Fiscal
Fiscal R&D Partner Consulting Customer Sales
Strategy
12 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Provide a Parser Template to Oracle
Customers I R C I A
Manage Changes in Parser Template
C R A
Understand, Build and Configure the
Fiscal Table Mapping (optional) C R C I A
Provide a Fiscal Table Mapping to
Oracle Customers C R C I A
Manage Changes Fiscal Table Mapping
C R C I A
13 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
2 HARMONIZED INTERFACE FOR POS SPECIFICATIONS
Harmonized Versioning
14 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Business Model (Using an Oracle Partner)
1. The process starts when operator make a final tender (payment) on check;
2. Harmonized Interface read check data and generate Payload according to Parser Template;
3. Harmonized Interface communicates with Partner;
4. Partner process Electronic Invoice;
5. Partner returns a status message, print message or the Electronic Invoice;
6. Finally, Harmonized Interface can print a receipt (if necessary) and closes the check.
15 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Harmonized Interface Parser Template and Payload Concepts
Communicates with Oracle Partner or Oracle Adapter Communicates with Harmonized Server
16 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Single Server, Multi-Server and Routing
For Simphony, when Multi-Server is configured and for any reason one of the Servers is down, Harmonized Interface will
automatically (Routing) ask operator to choose the next available server to process operation.
Observe the Oracle Hospitality Customer needs to define multiple Servers usage.
Data Extensions
Data Extensions is a Symphony configurable structure feature that permits add custom data to the database and it is
available for almost every Simphony main table. These extensions are useful when adding custom or specific data/value
to Check Detail, uploading configuration for an interface, and setting custom parameters for specific development.
For Harmonized FI, we use Simphony Data Extensions to add specific configuration to the interface and to Partners (as
they need).
The same concept is applied to RES 3700 but, since this product does not have this feature built-in, we emulate Data
Extensions using a separated application.
Additional Features
17 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Harmonized Install Structure for Simphony
18 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Pre-requisites for Simphony
• Simphony: V18.2.x or above
• Simphony Essentials: 19.5 or above
• Simphony Transaction Services: GEN1 and GEN2 for 19.2.x or above
• Workstations: WS5A, WS6, Oracle Tablets
• Operational Systems: Microsoft Windows and Oracle Linux for Micros
• OS Regional Settings: English, US
• Printer: Simphony Supported Printers that can print PDF417 or QR Codes if required
• Harmonized Interface: Installation Package
• Oracle Fiscal Partner (when required): Configured Parser Template and Communication Settings
Documentation
• Oracle Adapter for Mexico Fiscal Partners: Consult PAC Availability at this Documentation
Additional information’s
Additional information regarding specific situation and/or feature for this Release.
19 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Cancel Invoices – Simphony Essentials
Invoice cancel at Simphony Essentials can be made either by creating a negative transaction using the Transaction
Return function or using the Harmonized Void Closed Check Function.
Harmonized Void Closed Check function can be found at Manager Procedures screen under Fiscal Main Functions >
VoidClosedCheck.
20 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
3 HARMONIZED INTERFACE FOR POS - UPGRADING FROM LEGACY –
SIMPHONY
Upgrading from Legacy
When upgrading from Legacy Mexico FIP please be aware to, stop PAC Fiscal Service, remove previous Extension
Application from the Simphony Server and follow Harmonized installation steps with special attention to Data
Extensions values.
1. Follow steps to upload the New Harmonized Dlls from Install Package (Details)
2. Follow steps to update the CAL Package (Details)
3. Copy, review, and Paste the HarmonyConfig XML from this guide into HarmonyConfig Data Extension (Details)
4. Copy, review, and Paste the HarmonyLocalConfig XML from this guide into HarmonyLocalConfig Data
Extension (Details)
5. For CFDI 4.0, configure the following:
a. Create NEW Data Extension [MX FE] Subject to Tax (SAT Code)
b. Configure NEW Data Extension [MX FE] Subject to Tax (SAT Code)
c. Change the [MX FE] Layout Version CFDI (SAT) to 4.0
d. Review or test with PAC if the new layout version is being sent
6. Perform an Update Database on all Workstations
7. Restart Simphony POS
21 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Configurations Steps
This guide provides a suggested order of install and configuration. It is recommended to install the Harmonized
Interface first and then start to configure the fiscal interface.
Install steps and product configuration listed at this guide is divided by Oracle Product, be sure to follow the right paths.
The Harmonized FI configuration should be done, either using the Harmonized Configurator (HSS) or editing the XML
file using a text editor (Notepad++, Sublime or Ultra Edit).
ICON LEGEND
Indicates that the configuration step or feature only applies to Oracle Partner
Indicates that the configuration step or feature only applies when using Oracle Fiscal Adapter
Indicates that the configuration step or feature applies to an Oracle Partner or Oracle Fiscal
Adapter
22 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
5 HARMONIZED INTERFACE FOR POS INSTALLATION
Before you start
Installation steps will be presented at this manual for both types, Oracle Partner and Oracle Fiscal Adapter. You will find
differentiation between steps thought icon indicator.
ICON LEGEND
Indicates that the configuration step or feature only applies to Oracle Fiscal Partner
Indicates that the configuration step or feature only applies when using Oracle Fiscal Adapter
Indicates that the configuration step or feature applies to an Oracle Fiscal Partner or Oracle Fiscal
Adapter
7. Add the first ddl from installation package, clicking on Insert Application Content button and enter
ZoneableKey and Description with same dll name without file extension. I.E.:
23 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
8. From that point you will able to see the Designer tab and for each dll, insert application content and repeat the
following steps
9. At Designer tab change Content Type to 3 – DLL
10. Hit Import From a File and select the correspondent file
11. Repeat configuration of all the dll’s left from installation package
12. Fill disk file name with the same dll name w/extension
24 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Step 2 – Load the Parser Template
1. At Extension Application click on Insert Application Content button
2. Type PARSER_TEMPLATE on both fields.
4. Click Import from a file and select the Parser Template provided by the Oracle Partner or, when using the
Oracle Fiscal Mexico Adapter, import from Install Package.
5. Select the appropriate template file and upload it to EMC.
6. Please Fill the Disk File Name as parserTemplate.xml
25 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
7. From that point you will able to see the Designer tab and for each dll, insert application content and repeat the
following steps
8. At Designer tab change Content Type to 3 – DLL
9. Hit Import From a File and select the correspondent file
10. Fill disk file name with the same dll name w/ file extension
3. At dialog box enter CAL Package Location path or search it using search box. The Cal Package files are available
on installation package. Click OK
4. …\Simphony\CAL_Simphony\Win32
5. Confirm data and hit Upload
6. When finished, Harmonized package will be available for configuration
7. Select Harmonized package to display options on main screen
8. Select Check and Posting, Check and Posting Backup and Workstation to limit CAL Package contents to deploy
9. Click on Deployment Schedules tab and Add Deployment
10. Set Deployment Type, selecting 1 – Property/Enterprise or 2 – Specific Service Host.
11. In case you select Property/Enterprise at Deployment Type, fill it w/ Property name to deploy CAL Package to
all workstations of this property
12. If you wish, you can select a Specific Service Host at Deployment Type and fill w/ workstation name
13. At Action to take, select 0 – Install.
14. (Optional) Effective From and Effective to can be configured to specify install period. If it remains blank, install
will be always performed when a new workstation is added.
15. After CAL installation ends at workstations, a folder named Harmonized will be created at:
\Micros\Simphony\WebServer\wwwroot\EGateway\Handlers\ExtensionApplications\Harmonized
16. Do the same if you are using Linux or Simphony Essentials
26 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
17. At inferior left corner hit Add Custom CAL Package
18. At dialog box enter CAL Package Location path or search it using search box. The Cal Package files are available
on installation package. Click OK
19. …\Simphony\CAL_Simphony\LINUXCLIENT
20. Confirm data and hit Upload
21. Click on Deployment Schedules tab and Add Deployment
27 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
6 ORACLE PRODUCT CONFIGURATION
Before you start
Installation steps will be presented at this manual for both types, Oracle Partner and Oracle Fiscal Adapter. You will find
differentiation between steps thought icon indicator.
ICON LEGEND
Indicates that the configuration step or feature only applies to Oracle Fiscal Partner
Indicates that the configuration step or feature only applies when using Oracle Fiscal Adapter
Indicates that the configuration step or feature applies to an Oracle Fiscal Partner or Oracle Fiscal
Adapter
71 - Tender/Media MX_FE_PymTdr 0 - Text Max Chars: 128 [MX FE] Payment Tender (SAT
Code)
1001 – Property or MX_FE_CdeFct 0 - Text Max Chars: 128 [MX FE] Code Factors (SAT Code)
20 - Revenue Center
1001 – Property or MX_FE_CdeTxs 0 - Text Max Chars: 128 [MX FE] Code Taxes (SAT Code)
28 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
20 - Revenue Center
1001 – Property or MX_FE_Crrncy 0 - Text Max Chars: 128 [MX FE] Currency (SAT Code)
20 - Revenue Center
1001 – Property or MX_FE_DflASC 0 - Text Max Chars: 128 [MX FE] Default Automatic
ServCharge
20 - Revenue Center
1001 – Property or MX_FE_DflCsh 0 - Text Max Chars: 40 [MX FE] Default Tender Cash
Lines: 20
20 - Revenue Center
1001 – Property or MX_FE_DstnHT 8 - Text List (List) HEADER | [MX FE] Header Trailer
TRAILER Destination
20 - Revenue Center
1001 – Property or MX_FE_HdrTlr 1 - Multiline Max Chars: 40 [MX FE] Header Trailer
Text Lines: 20
20 - Revenue Center
20 - Revenue Center or MX_FE_PdcCde 0 - Text Max Chars: 128 [MX FE] Product Code (SAT
Code)
131 - Menu Item Master or
134 - Menu Item
Definition or
1001 – Property
1001 – Property or MX_FE_PymMtd 0 - Text Max Chars: 128 [MX FE] Payment Method (SAT
Code)
20 - Revenue Center
20 - Revenue Center or MX_FE_UntMsr 0 - Text Max Chars: 128 [MX FE] Unit Measure (SAT
Code)
131 - Menu Item Master or
134 - Menu Item
Definition or
1001 – Property
1001 – Property MX_FE_LytVsn 0 - Text Max Chars: 128 [MX FE] Layout Version CFDI
(SAT)
29 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
20 - Revenue Center or MX_FE_SubTax 0 - Text Max Chars: 128 [MX FE] Subject to Tax (SAT
Code)
131 - Menu Item Master or
134 - Menu Item
Definition or
1001 – Property
To let the Data Extensions better organized; define the Sort Priority for Harmonized Interface Data
TIP Extensions stay grouped.
Oracle Fiscal Mexico Adapter – Configure the “Tax Rates” as “Included, Percentage” (or modify the existing ones,
at the Enterprise, Zone or Property level).
1. At EMC, at desired level, go to Setup > Tax Rates. Screen below will be showed
Notes:
2. Only TASA and EXENTO Factor Taxes will be supported, therefore, CUOTA Factor Taxes are not included within
the MX FE functionality.
3. Menu Items, Discounts, Manual Service Charges that are required to be classified as “No-Grabables”, should
NOT have a Tax Classes linked, as there are also Taxes called “IVA Tasa Cero Y Exento” and these concepts are
not the same fiscally.
4. Simphony does not calculate taxes for Automatic Service Charge, Charge Tips and Manual Service Charge that
have the parameter 3-Post to Charged Tips Total on Tips Reports activated, these must classify as “No
Grabables”, they should NOT have any Tax Classes configured. MX FE functionality will omit the tax calculation
for Service Charges of this type.
30 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
5. If Discounts configured require reporting Taxes (this is how they are normally configured); these must have
activated (enabled) and without exception, all the Taxes defined and used in the Property. Failure to activate all
of them will cause inconsistencies in the amounts reported for the different Taxes.
6. All Order Types defined at the Property, must have All Tax Rates in use enabled. Failure to activate them all will
cause inconsistencies in the amounts reported for the different Taxes.
7. Items and Service Charges that are exempt from taxes, should not have Tax Rate / Tax Classes Configured. The
MX FE functionality will validate the status of this parameter, based on the “Configure SAT Taxes (Codes)”
configuration.
ISR 001
IVA 002
IEPS 003
4. Configure the [MX FE] Code Factors (SAT Code) Data Extension. Be aware that it is feasible to set these
parameters at two levels: “Property” or “Revenue Center”
31 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
5. It is mandatory that all Tax Rates configured in Micros, be related to the value corresponding to the SAT Tax
Factor Catalog. If in the future, the Property requires configuring a new Tax, is mandatory to configure it (add it)
also in this section. Leaving empty (null), incorrectly configuring, or omitting this parameter will cause the
incorrect delivery of the information to the PAC, generating tax implications
Tasa T
Cuota C
Exento E
Oracle Fiscal Mexico Adapter – Follow steps below to configure Data Extensions
These configurations are (obligatorily) linked with the following parameters, which must also be configured based on
the needs of the Property. It is important to indicate that if multiple taxes are used, then a Tax Class must be created that
has all the configured Tax Rates for Mexico activated and link those especially for Discounts and Order Types.
Menu Items
(Zone) Property | Configuration | Menu Items | Menu Items Classes and Menu Item Maintenance
(If required, activate the necessary Tax Rates for each Tax Classes to be linked)
Service Charges
(Zone) Property | Configuration | Sales | Service Charges
32 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
(If required, activate the necessary Tax Rates for each Tax Classes to be linked, if the Service Charge is not used as
Automatic Service Charge, Charge tip or is used manually and the parameter 3-Post to Charged Tips Total is activated
on Tips Reports)
Discounts
(Zone) Property | Configuration | Sales | Discounts
(Activate all the Tax Rates used in the Property for each Tax Classes to be linked)
Order Types
(Zone) Property | Setup | Sales | Taxes and Order Types | Order Type Parameters
(Activate all the necessary Tax Rates for each Tax Classes to be linked)
1. At EMC, at desired level, go to Setup > Tax Classes. Screen below will be showed
2. Select the desired taxes and link then to their correspondent Tax Rate
Oracle Fiscal Mexico Adapter – Follow steps below to configure Tax Parameters
1. In EMC go to Setup > Tax Parameters > International Options
2. Make sure that option 1 - On= Apply Tax as Add-On; OFF= Apply Tax as VAT is Not Selected
3. Make sure that option 13 - Truncate Inclusive Taxes is Not Selected
Oracle Fiscal Mexico Adapter – Follow steps below to configure Tender Media
1. In EMC go to Configuration > Sales > Tender/Media.
2. Set for all Tenders defined as Payment, the option 22 - Print Check Trailer at Options/Printing Options tab
3. Set for the Reprint Check Service Total record, the option 22 - Print Check Trailer at Options/Printing Options tab
33 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
4. Configure the Data Extension [MX FE] Room Charge value for all/any the Room Charge Payment if applicable
5. Configure the Data Extension Value [MX FE] Last 4 Digits (Bank Card) to activate the last 4 CC number prompt
(required) when using Credit/Debit Cards
6. If the Property uses STS, create new Credit/Debit Cards Tender Media records without the Data Extension [MX
FE] Last 4 Digits (Bank Card) selected to be used by the STS Application.
7. Select the Option 68 - Mask Account Number for all Credit/Debit Cards and make sure that Option 5 - Reference
Entry Required at Options/Ops Behavior Tab is unchecked
8. Make sure also, that Option 5 - Reference Entry Required at Options/Ops Behavior Tab is unchecked for Cheque
Bancario Tender
34 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
9. Reference entry for Cheque Bancario will be required activating the [MX FE] Account Num (Bank Check) Data
Extension
10. If the Property uses STS, create new Cheque Bancario Tender Media records without the Data Extension [MX FE]
Account Num (Bank Check) selected to be used by the STS Application.
11. Configure [MX FE] Payment Tender (SAT Code) for each Tender following the table below
01 Efectivo
02 Cheque nominative
04 Tarjeta de crédito
05 Monedero electrónico
06 Dinero electrónico
08 Vales de despensa
12 Dación en pago
15 Condonación
17 Compensación
23 Novación
24 Confusión
25 Remisión de deuda
26 Prescripción o caducidad
35 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
27 A satisfacción del acreedor
28 Tarjeta de débito
29 Tarjeta de servicios
30 Aplicación de anticipos
99 Por definir
Oracle Fiscal Mexico Adapter – Follow steps below to configure Adapter custom settings for Units of Measure,
Currency, SAT Payment Method SAT Product Code, Header | Trailer Destination and Header | Trailer Contents.
Be aware that it is feasible to set these parameters at two or more levels, make sure to select the one that best fit to the
Oracle Customer:
• Property
• Revenue Center
• Menu Item Master
• Menu Item Definition
36 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
SAT CURRENCY CODE DESCRIPTION
37 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
SAT UNIT CODE DESCRIPTION
H87 Pieza
KGM Kilogramo
90101501 Restaurantes
90101502 Bares
38 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
90101601 Instalaciones para banquetes
39 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
PARAMETER DESCRIPTION
@@ Line Feed
Print Example:
========================================
Thank you for visiting us
========================================
SI UD. DESEA FACTURA, INGRESE A:
http://www.PortalPACFE/Propiedad
REFERENCIA: 13080006002744
CFDI Version
1. Configure the [MX FE] Layout Version CFDI (SAT) for the property. Please check with the Oracle Customer what
is the value required from his PAC. Default value is to indicate the Electronic Invoice SAT Version 3.3.
PARAMETER DESCRIPTION
40 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Step 10 – Configure Property Parameters (Property Level) for Simphony Essentials
Oracle Fiscal Mexico Adapter – For Simphony Essentials only, configure the following parameter:
1. Access at EMC, select the Property and go to Setup > Parameters Property Parameters > Simphony Essentials
2. Enable the Fiscal Location as Mexico.
3. This setting will enable Fiscal Main and Mexico Functions buttons at POS Manager Procedures screen
View Harmonized Core Opens a Screen that enables the POS User to View Harmonized Core Configuration
Configuration for this workstation
View Harmonized Local Opens a Screen that enables the POS User to View Harmonized Local Configuration
Configurations for this workstation
Export Harmonized Core Export to an XML file the Harmonized Core Configuration for this workstation.
Configuration Export file can be found at X:\Micros\Simphony\WebServer folder as
ServerConfig.xml
Export Harmonized Local Export to an XML file the Harmonized Local Configuration for this workstation.
Configuration Export file can be found at X:\Micros\Simphony\WebServer folder as
ServerLocalConfig.xml.xml
Consult FIP Version and PAC Execute a list of commands for this Country.
Export Sales Report (CSV) Exports from Local Datasore or CheckPosting Databases Fiscal information when
available
Force Next Fiscal Numbering Before dropping a database or deleting data from a specific table, be sure to know
the previous/last Invoice Number. You will need the sequential number from the
system reestablish Fiscal Functionality at the Workstation.
Use Force Next Numbering Touchscreen Button to set the new <Sequential
Number> after restoring a Database.
Payload Invoice Status Opens a Screen that enables the POS User to View Invoice Statuses for this
workstation
41 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Reprint Invoice by Selection Reprints an Invoice by Selecting a check from a list
Get Version Number from Opens a Screen that enables the POS User to View the Harmonized Resources
Harmonized Components Versions
Audit Harmonized Internal Opens a Screen that enables the POS User to audit the Reset the IRN <Sequential
Numbering Sequence Number> procedure
Procedure
LEGEND ARGUMENTS
42 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
To perform the Void Closed Check by Check Number, POS users must have the Void Check Key privilege. At
TIP EMC go to Personnel> Roles> Operations> Void/ Returns: Option 36 - Authorize/Use the [Void Check] Key
1. You can find these settings at Installation Package, searching at the following path:
a. …Harmonized FI POS 23.X\Custom Additional Files\HarmonyConfig.xml
b. …Harmonized FI POS 23.X\Custom Additional Files\HarmonyLocalConfig.xml
2. At EMC, if you already created the two Workstations Data Extensions – HarmonyConfig and
HarmonyLocalConfig – select Property level and go to Setup > Hardware/Interfaces > Workstations.
3. Go to Data Extensions tab and locate both Data Extensions.
4. Open the HarmonyConfig.xml file, copy and paste settings for each Workstation available at the Property
5. Do the same procedure for the HarmonyLocalConfig.xml
HARMONYCONFIG
<HarmonyConfig>
<Core>
<CultureName>es-MX</CultureName>
<Interface>
<PrintJobType>MIXED</PrintJobType>
<NegativeQuantityVoidEnabled>True</NegativeQuantityVoidEnabled>
<RemoveAllVoidForBehaviors>True</RemoveAllVoidForBehaviors>
<TransactionServicesEnabled>False</TransactionServicesEnabled>
</Interface>
<Server>
<ExtensibilityReflectionEnabled>False</ExtensibilityReflectionEnabled>
</Server>
<PartnerCommunication>
<PartnerCommunicationMode>API_NET</PartnerCommunicationMode>
<API_NET>
<NetPartnerName>Oracle.Fiscal.Mexico.Adapter.dll</NetPartnerName>
</API_NET>
</PartnerCommunication>
</Core>
</HarmonyConfig>
HARMONYCONFIG – INTERFACE/CLIENT
<HarmonyConfig>
<Core>
<OracleProduct>Simphony</OracleProduct>
<HarmonyMode>Interface</HarmonyMode>
<CultureName>es-MX</CultureName>
<Interface>
<HarmonyServerIP>Enter the Harmonized Server IP Number Here</HarmonyServerIP>
<HarmonyServerPort>5004</HarmonyServerPort>
</Interface>
</Core>
</HarmonyConfig>
43 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
HARMONYLOCALCONFIG
<HarmonyLocalConfig>
<Oracle.Fiscal.Mexico.Adapter>
<OracleProduct>{OracleProduct}</OracleProduct>
<WorkstationID>{WorkstationID}</WorkstationID>
<DatabaseType>{DatabaseType}</DatabaseType>
<PACService>
<PAC_SrvSvc_IP>127.0.0.1</PAC_SrvSvc_IP>
<!--IP address of the server from Socket PAC Service is running.-->
<PAC_SrvSvc_Port>6000</PAC_SrvSvc_Port>
<!--Listen port of the server from Socket PAC Service is running.-->
<PAC_SrvSvc_TmeOut>15</PAC_SrvSvc_TmeOut>
<!--Time to wait for PAC Service Response.-->
<PAC_SrvSvc_WritePort>11000</PAC_SrvSvc_WritePort>
<!--Write port of the server from Socket PAC Service is running.-->
<PAC_SrvSvc_Off>False</PAC_SrvSvc_Off>
<!--Activate or deactivate the request for the generation of PAC FIP. Enter "true" to
deactivate PAC FIP, "false" to leave it active-->
<PAC_Show_Failure_Message>True</PAC_Show_Failure_Message>
<!--If activated, all error messages will be shown on the screen for any failure in case of PAC
FIP Service Fails. Enter "true" to activate, "false" to deactivate.-->
<PAC_SrvSvc_Cancel>False</PAC_SrvSvc_Cancel>
<!--Activate or deactivate the request for the generation Cancel of PAC FIP Checks. Enter
"true" to activate PAC FIP, "false" to leave it deactivate.
Only activate when the PAC supports Check Cancel messages.-->
</PACService>
</Oracle.Fiscal.Mexico.Adapter>
</HarmonyLocalConfig>
Workstations
1. In the EMC, select Property level and go to Setup > Hardware/Interfaces > Workstations.
2. Create a new STS Workstation
3. In General Settings, Select Workstation Type as 3-POSAPI Client
4. Select the “Enable Simphony Transaction Services (Gen1) Location API” Option bit
5. Select the Service Host ID where the workstation runs. In the Address / Host Name field, enter the machine
where Transaction Services is installed.
6. Change HarmonyConfig and set the <TransactionServicesEnabled> to TRUE at the POSAPI Client and
Workstation Client
7. Change HarmonyConfig and set the <ExtensibilityReflectionEnabled> to TRUE at the POSAPI Client and
Workstation Client
45 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
7 HARMONIZED INTERFACE FOR POS CONFIGURATION
At this session, Harmonized Core and Adapter Configuration will be presented.
Use default value for By default, Harmonized POS User Language is set to es-MX. Turn it off to select user
Harmonized POS User language that best fit to the Oracle Customer
Language
Use default value for Log By default, Log Path and Name is set to Product Log File Path and uses Workstation
Path and Name name as definition. Turn it off to select Custom Path and Name that best fit to the
Oracle Customer
Log Path and Name Configure Harmonized Log Path and Name
46 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Use default value for Log By default, Log Level is set to INFO. Turn it off to select Custom Log Level that best fit
Level to the Oracle Customer or momentum.
Log Level By default, you can define level INFO when Customer is in Production. In case of error
or during installation, you can define TRACE or DEBUG level for a more detailed log.
Use default value for Days to By default, Log History maintains 15 days of Log Data
Keep Log History
Days to Keep Log History Set the number of Days that Harmonized will Keep at defined log folder
Use default value for Log file Select this if you want to enable the default value for log file size 1MB
size (MB)
Log file size (MB) Enter the default log file size
Step 2 – Workstation
SETTING NAME DESCRIPTION
Harmonized Server IP IP of Harmonized Interface Server. In case if this WS is a Harmonized Interface Server,
fill this field with WS own IP.
IP 0.0.0.0 can be used if you are using DHCP for the Workstation; Harmonized will
understand this address as localhost.
Use default value for Turn it on to use default values for Harmonized Server Port
Harmonized Server Port
Harmonized Server Port Communication Port for Harmonized Server. By default, it uses port 5002, but any port
can be used if this port is not used by other application and/or is not blocked by any
Firewall rule
Use default value for Use Mixed value to comply with Oracle Fiscal Mexico Adapter
Harmonized Print Job Type
47 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Harmonized Print Job Type Choose one of the 4 options available. Please consult the Oracle Partner to define
these options.
• None
• Partner
• Product
• Harmony
• Mixed
For Brazil, use Mixed value to comply with Oracle Fiscal Mexico Adapter
Transaction Services Enabled True means that Harmonized Interface will process transactions from Simphony STS
GEN1 or GEN2. Configure it only for the Service Host (Harmony Server) that will
process the transactions for the POS API Client (STS).
RVCId to Disable STS Fiscal Enter RVCId to Disable STS Check Fiscal Processing. One or more RVCId can be
Processing for one or more entered. RVCId’s must be entered separated by “,”
RVCs
Ex.: 1234,5678
Suppress Void Reason Suppress Void Reason Prompt when using Void Closed Check with Harmonized
Prompt Enabled
Days to Keep data of Void Set the number of Days that Harmonized will Keep Internal Transaction Historic Data
Closed Check that can be used with Void Closed Check.
Default value is 30 days
Enable Negative Quantity Support to Menu Item Quantity Voiding for Simphony 19.4 when option 24 - Treat
override for items, discounts, Error Corrects as Voids at Control Parameters is enabled (Negative Items). New
service charges or payments mandatory configuration is present at HarmonyConfig that must be used for ALL
Simphony Versions no matter if the option bit is enabled or disabled.
Remove all Void operations Offers Support for Behaviors filters when something (MI, SVC, Disc, TMED) is used as a
for Behaviors at Parser filter on Parser Behaviors.
Template
Use default value for Local Define WS IP of the Harmonized Interface Server. If this WS is Server, this
Workstation IP configuration will be ignored.
Local Workstation IP Define WS IP of the Harmonized Interface Server. If this WS is Server, this
configuration will be ignored.
IP 0.0.0.0 can be used if you are using DHCP for the Workstation; Harmonized will
understand this address as localhost
Use default value for Local Turn it on to use default values for Harmonized Interface Port
Workstation Port
48 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Local Workstation Port Communication Port for Harmonized Interface. By default, it uses port 5004, but any
port can be used as long as this port is not used by other application and/or is not
blocked by any Firewall rule
Full Payload Creation Turn this option on to make Harmonize generate Full Payload. This may only be
Enabled required for support purposes
Use default value for Full By default, Full Payload and Path Name is already configured to Harmonized
Payload Path and Name Standards
Full Payload Path and Name Configure Custom Full Payload creation Path and Name
Use default value for Payload By default, Payload file is saved at HarmonizedPath/Documents/Requests
Save Path
Use default value for Days to By default, Harmonized keep Partner Data on DB for 30 Days
Keep Partner Data on DB
Days to Keep Partner Data on Set the Quantity of Days that Harmonized will keep Partner Data
DB
Reuse Rejected Fiscal You can configure Harmonized to re-use rejected fiscal invoice number when the
Number Enabled previous invoice was rejected
49 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Use default value for By default, Harmonized Internal Transaction History is maintained for 30 days.
Harmonized Transaction
History Days to Keep on DB
Harmonized Transaction Set the number of Days that Harmonized will Keep Internal Transaction Historic Data
History Days to Keep on DB
Copy Data from Extensibility Enable or disable the function to copy the Extensibility Data to payload Header
Data to Header Enabled
Information above reprint Text to be printed above Receipt Header when Harmonized Reprint feature is used
header
Information below reprint Text to be printed after Receipt Trailer when Harmonized Reprint feature is used
header
Oracle Partner Fill this field with value of communication adopted by the Oracle Partner. Default value
Communication Mode for Oracle Fiscal Mexico Adapter is API_NET.
REST Communication Type Enter the Partner REST Server Content Type
• WebClient is for X_WWW_FORM_URLENCODED
• WebRequest is for FORM_DATA
REST URL Address Enter the Partner REST Address starting with http://
Use <![CDATA[RESTAddress]]> when REST address contains special characters
REST Username Enter the Oracle Partner REST User name, if applicable.
REST Password Enter the Oracle Partner REST User password, if applicable.
50 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Socket Port Enter Oracle Partner Socket Port if applicable.
API (Dll) Resource Name Enter the Oracle Partner dll name if API CommMode is configured. Oracle Partner
Resource need to be loaded at:
\Micros\Simphony\WebServer\wwwroot\EGateway\Handlers\ExtensionApplications
\Harmonized\Partner.dll – Simphony
Enter Oracle.Fiscal.Mexico.Adapter.dll for Oracle Fiscal Mexico Adapter
API NET (Dll) Resource Name Enter the Oracle Partner dll name if API_NET CommMode is configured. Oracle Partner
Resource need to be loaded at:
\Micros\Simphony\WebServer\wwwroot\EGateway\Handlers\ExtensionApplications
\Harmonized\Partner.dll – Simphony
Enter Oracle.Fiscal.Mexico.Adapter.dll for Oracle Fiscal Mexico Adapter
Exchange Data Format Default Value is XML, choose JSON if Oracle Partner wants to receive the Payload into
this format
Html Decode Enabled Converts a string that has been HTML-encoded for HTTP transmission into a decoded
string.
Url Encoded Enabled Converts a string that has been encoded for transmission in a URL into a decoded
string
Param Name Parameter name for REST Apache Server Tomcat Integration
Socket Port where PAC Enter PAC Service Socket Port. Please keep the Default Value 6000
Service is Running
51 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Persistent Socket Port for Enter Persistent Socket Port value for Linux. Please keep the Default Value 5110
Linux
Time to Wait (seconds) for Enter the maximum amount of time, in seconds, that Oracle Fiscal Mexico Adapter can
PAC Service Response wait to receive a response for PAC Fiscal Service
Turn PAC FIP Service Off Turn PAC Fiscal Service Off
Enable PAC FIP Invoice True activates the Invoice Cancel Procedure either by using the Harmonized Void
Cancel Procedure from POS Closed Check or ringing negative menu items using Transaction Void.
Confirm with the PAC if they support this feature.
5. For Simphony you will need to transfer these configurations to EMC for each Workstation related Data
Extension. Once you export, the files are located to HSS\Export Folder
52 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
8 INSTALLATION CHECKLIST
53 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
9 OPERATION
Generate a Fiscal Document
Payload
The generation of fiscal document is automatic after last payment in the check. In case of success, will occur:
A. XML Payload will be stored in folder APPROVED;
B. Oracle Partner would receive and process EI;
C. The POS check will be closed;
D. A Receipt will be printed (optional in some cases).
If occur any problem during the print of Receipt (step D), the check will be closed because XML is already generated and
approved.
If occur an error during the generating of fiscal document, a message will be showed in Simphony with error description.
In this case, the check in Simphony will remain open, waiting a new attempt (new payment), considering that last
payment was aborted. If the check has more than one payment and occur an error during the fiscal document
generation, it is needed make only the last payment again.
The Payload file name pattern is Pay + WorkstationID + "_" + CheckNum + "_" + "FiscalNumber" + "_" + Timestamp.
View Config
This function shows a screen with Full Harmonized Interface configuration.
Export Config
This function save on ServiceHost.exe’s folder (usually is Micros/Simphony/WebServer) an xml with Harmonized
Interface Configuration.
54 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
10 SUPPORT
Issues Escalation
The escalation to development happens only and solely through the BUGDB platform. The product group ID to be used
is 13224 (HGBU Fiscal Layer), components and subcomponents must be selected.
The severity shall be selected based on the incident severity.
1. Complete Loss of Service
2. Severe Loss of Service
3. Minimal Loss of Service
4. Minor Error, No Loss of Service
55 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
Only in case of complete loss of service, no transactions possible at all, severity 1 shall be selected.
The escalated issue must contain all of the required information to allow development to provide proper assistance
doing an appropriate research. The information required shall include but not limited to the information listed in the
escalation template.
Feature Requests
In case of feature requests, it is necessary to provide a copy of the legislation stating the requirement, including a
detailed description of the expected feature for the operational point of view.
56 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public
CONNECT WITH US
Call +1.800.ORACLE1 or visit oracle.com.
Outside North America, find your local office at oracle.com/contact.
Copyright © 2023, Oracle and/or its affiliates. All rights reserved. This document is provided for information purposes only, and the contents hereof are subject to change without
notice. This document is not warranted to be error-free, nor subject to any other warranties or conditions, whether expressed orally or implied in law, including implied warranties
and conditions of merchantability or fitness for a particular purpose. We specifically disclaim any liability with respect to this document, and no contractual obligations are formed
either directly or indirectly by this document. This document may not be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without
our prior written permission.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of
SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered
trademark of The Open Group. 0120
Disclaimer: This document is for informational purposes. It is not a commitment to deliver any material, code, or functionality, and should not be relied upon in making purchasing
decisions. The development, release, timing, and pricing of any features or functionality described in this document may change and remains at the sole discretion of Oracle
Corporation.
57 Harmonized Interface for POS | Oracle MICROS Fiscal Solution for Mexico | Version 23.2.0.3
Copyright © 2023, Oracle and/or its affiliates | Public