Transcription
Oracle Hospitality OPERA ExchangeInterfaceReservation and Profile XML SpecificationsOctober 2017
Copyright 2009, 2017, Oracle and/or its affiliates. All rights reserved.This software and related documentation are provided under a license agreement containingrestrictions on use and disclosure and are protected by intellectual property laws. Except asexpressly permitted in your license agreement or allowed by law, you may not use, copy,reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, ordisplay any part, in any form, or by any means. Reverse engineering, disassembly, ordecompilation of this software, unless required by law for interoperability, is prohibited.The information contained herein is subject to change without notice and is not warranted to beerror-free. If you find any errors, please report them to us in writing.If this software or related documentation is delivered to the U.S. Government or anyone licensing iton behalf of the U.S. Government, then the following notice is applicable:U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integratedsoftware, any programs installed on the hardware, and/or documentation, delivered to U.S.Government end users are "commercial computer software" pursuant to the applicable FederalAcquisition Regulation and agency-specific supplemental regulations. As such, use, duplication,disclosure, modification, and adaptation of the programs, including any operating system,integrated software, any programs installed on the hardware, and/or documentation, shall besubject to license terms and license restrictions applicable to the programs. No other rights aregranted to the U.S. Government.This software or hardware is developed for general use in a variety of information managementapplications. It is not developed or intended for use in any inherently dangerous applications,including applications that may create a risk of personal injury. If you use this software orhardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe,backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and itsaffiliates disclaim any liability for any damages caused by use of this software or hardware indangerous applications.Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may betrademarks of their respective owners.Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARCtrademarks are used under license and are trademarks or registered trademarks of SPARCInternational, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks orregistered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The OpenGroup.This software or hardware and documentation may provide access to or information about content,products, and services from third parties. Oracle Corporation and its affiliates are not responsiblefor and expressly disclaim all warranties of any kind with respect to third-party content, products,and services unless otherwise set forth in an applicable agreement between you and Oracle. OracleCorporation and its affiliates will not be responsible for any loss, costs, or damages incurred due toyour access to or use of third-party content, products, or services, except as set forth in anapplicable agreement between you and Oracle.2
ContentsPreface . 5Audience .5Customer Support .5Documentation .51 Introduction . 6OXI Parameters that Affect Reservation Messages .6Full Reservation from External System to OPERA . 15Explanation of the Reservation Object and the Reference Place Holders in theXML Message . 15Options and Restrictions for Reservations from External System to OPERA . 17Handling Of Defaults and Conversion for Reservations from External System toOPERA . 18Sharers . 19Multi Leg (Multi Segment) Reservations from External System to OPERA . 20Multiple Room Reservations from External System to OPERA . 21Full Reservation from OPERA to External System . 21Options and Restrictions for Reservations from OPERA to External System . 21Handling of Defaults and Conversion for Reservations from OPERA to theExternal System . 22Sharers . 22Share Functionality . 22Sharers - Special Cases . 25First time Sync/Re-sync Utility for Reservations from OPERA to the ExternalSystem . 25Business Events Needed in OPERA – Module Reservations . 262 Mapping Table Data Elements . 27Reservations - Mapping Table between External System and XML Message . 273 Functional Specifications Profile Object . 51Profiles from External System to OPERA . 51Options and Restrictions for Profiles from External System to OPERA . 51Handling of Defaults and Conversion for Profiles from External System toOPERA . 52Profiles from OPERA to External System . 52Options and Restrictions for Profiles from OPERA to External System . 52Handling of Defaults and Conversion for Profiles from OPERA to the ExternalSystem . 523
First Time Sync of Profiles into the External System . 52Business Events Needed in OPERA - Module Profiles. 534 Mapping Table Data Elements . 54Profiles - Mapping Table between External System and XML Message . 546 Requirements to Build the XML Messages . 89Information on the XML Schemas Used by OXI . 89The XML Message Header Label . 89The UDF Definition Files to Validate an XML Message . 894
PrefaceThis document describes the Reservation and Profile XML schema layout and dataelements used for the OPERA Exchange Interface.AudienceThis document is intended for those developing custom applications that interact withOPERA Exchange 2-way Interface for Reservations and Profiles functionality.Customer SupportTo contact Oracle Customer Support, access My Oracle Support at the following URL:https://support.oracle.comWhen 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 and any associated log files Screen shots of each step you takeDocumentationOracle Hospitality product documentation is available on the Oracle Help Center /5
1IntroductionThis document describes the Reservation and Profile XML schema layout and dataelements used for the OPERA Xchange Interface. It further explains the mapping of theXML data elements into the OPERA application and the generic business rules that areapplied.In the following document we will refer to the third party system as external system.Third Party Systems can be central reservation systems, property management systems,or others. The OPERA applications will be referred to as OPERA. Please note thatOPERA can function as single property OPERA, multi property OPERA, or as centralsystem OPERA. The respective differences between these OPERA flavors will beaddressed where necessary. The OPERA Exchange Interface will be referred to as OXI.The specifications in this document are based on the XML schema version 4.0, compatiblewith OPERA version 4.0 onwards. All XML schema versions maintain backwardcompatibility.OXI Parameters that Affect Reservation MessagesParameter NameParameter DescriptionValueADDITIONAL REFERENCE LOVEXCHANGEData from OPERA to external systems and external systemsto OPERA.Comma(,) separated list of unique additional externalreference types that are allowed to be included in thereservation and reservation result messages to the externalsystems, and accepted from the external systems.Additional reference types should not conflict with any ofthe existing or potential external systems.e.g. amongst many others, additional reference types likeORS, OXI-OPERA, OXI-V6, OXI-ORS, MYFIDELIO etc.cannot be used.AUTO POPULATE MEMBE Y/NRSHIP YNData from external system to OPERAIf 'Y' populate selected membership/s from the reservationmessage based on the membership configuration rules inOPERA. If 'N' then populate only the selectedmembership/s from the reservation message.6
CRS MARKET/SOURCE CO Y/NNTROLData from external system to OPERA.This parameter defines the sequence in which OXI identifiesthe market and source codes to apply in the reservation.R Use the codes defined in rate definition (rate details firstand then rate header). B Use the codes defined in blockdefinition,E Use the codes received from the external system (afterconversion, if applicable),D Use the codes defined in OXI defaults,Y When used alone, same as ED andN When used alone, same as BRD.Set the value of this parameter by listing only the desiredcharacters among R, B and E in the preferred order andoptionally D as the last character without any delimiters.CRS PRICE CONTROLCRS RESERVATION GENERATES INVENTORYIntroductionLOVY/NData from external system to OPERAY - Select FD.N - Select ND.NN - OPERA rate will be applied without any discount. Awarning in OXI will be displayed accordingly.ND - OPERA rate will be applied with discounts found inthe message. A warning in OXI will be displayedaccordingly.FF - External rate will always be applied and will be fixed ifOPERA fixed rate is enabled. If OPERA fixed rate isdisabled, discount will be applied.DD - External rate will be applied with rate difference anddiscount found in the message. Rate discount reasons willbe applied from the message if external and OPERA ratematch.FD - External rate will always be applied. Where externaland OPERA rates do not match, rate will be fixed if fixedrate is enabled. If OPERA fixed rate is disabled, the ratedifference will be applied as a discount and the rate will notbe fixed.MARSHA - OPERA fixed rates must be enabled. Whereexternal and OPERA rates do not match, the external ratewill be applied and the rate will be fixed. Where externaland OPERA rates match, OPERA rate will be applied andthe rate will not be fixed.Data from external system to OPERAWhen a reservation message from an external system isreceived, OXI will generate inventory snapshots for theaffected dates and room types.7
EXT SYSTEM HANDLES DY/NAY USEData from OPERA To External System.When parameter value Y, handling day use rooms has nodifference. When parameter value N, OXI will send acancellation message to the external system when OPERAreservation has an external reference number and thenumber of nights equals 0.FULL OPERA SHARESLOVData both ways between external system and OPERAFollowing rules apply to both incoming and outgoingmessages.Y: Any update on one individual reservation will bereflected in one reservation XML message. Any sharerelated action (combine/break) will be reflected inappropriate share reservation message with only the keyinformation about the reservations involved.NS: Any update, including share related on any of thereservations will be reflected in a reservation XML messagecontaining information about all the relevant shares.External reference of all the share reservations in OPERAwill be updated from the incoming result message.NU: Similar to NS, but external reference of only thosereservations in OPERA mentioned in the result messagewill be updated from the incoming result message.NUMERICData from external system to OPERAEnter a numeric value that w
MARSHA - OPERA fixed rates must be enabled. Where external and OPERA rates do not match, the external rate will be applied and the rate will be fixed. Where external and OPERA rates match, OPERA rate will be applied and the rate will not be fixed. CRS_RESERVATION_GENE RATES_INVENTORY Y/N Data from external system to OPERA When a reservation message from an external system is
