opera exchange interface - oracle help center lookup...listening oxi processor receives the lookup...

Oracle® Hospitality OPERA Exchange Interface

Profile Lookup Vendor Specification

May 2018

2

Copyright © 2004, 2018, Oracle and/or its affiliates. All rights reserved.

This software and related documentation are provided under a license agreement containing

restrictions on use and disclosure and are protected by intellectual property laws. Except as

expressly permitted in your license agreement or allowed by law, you may not use, copy,

reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or

display any part, in any form, or by any means. Reverse engineering, disassembly, or

decompilation 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 be

error-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 it

on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated

software, any programs installed on the hardware, and/or documentation, delivered to U.S.

Government end users are "commercial computer software" pursuant to the applicable Federal

Acquisition 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 be

subject to license terms and license restrictions applicable to the programs. No other rights are

granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management

applications. 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 or

hardware 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 its

affiliates disclaim any liability for any damages caused by use of this software or hardware in

dangerous applications.

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.

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 responsible

for 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. Oracle

Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to

your access to or use of third-party content, products, or services, except as set forth in an

applicable agreement between you and Oracle.

3

Contents

Preface ....................................................................................................... 4

Audience .................................................................................................................................. 4

Customer Support ................................................................................................................... 4

Documentation ........................................................................................................................ 4

1 Assumptions ......................................................................................... 5

2 Validations ........................................................................................... 6

3 Profile Lookup Lifecycle ...................................................................... 7

4 HTTP Communication ......................................................................... 8

Lookup Request ....................................................................................................................... 8

Profile Request ......................................................................................................................... 8

5 XML Schemas ....................................................................................... 9

Lookup Request ....................................................................................................................... 9

Lookup Response .................................................................................................................. 10

Profile Request ....................................................................................................................... 12

Profile Response .................................................................................................................... 12

6 HTTP Call Samples ............................................................................ 13

Profile Lookup Request and Response .............................................................................. 13

HTTP POST Data (Request for matching profiles) .................................................... 13

HTTP POST Response (List of matching profiles returned synchronously by

external system) ............................................................................................................. 13

Profile Request ....................................................................................................................... 14

HTTP GET Response (Unique matching profile returned synchronously by

external system) ............................................................................................................. 14

7 Profile Anonymization Schema Changes .......................................... 16

XDR: profile.fidelio.5.0.xml: ................................................................................................ 16

XSD .................................................................................................................................. 16

Sample Message ............................................................................................................. 17

4

Preface

Profile lookup may be used to retrieve profile information from remote systems. At a

minimum, profile lookup should provide the following functionality:

Search for profiles matching the criteria provided by the user. It should accept

wildcards as part of the matching criteria.

Retrieve complete information of a profile when requested by specifying the unique

identifier of the profile.

Audience This document explains the functionality currently offered by OPERA XChange Interface

for doing profile lookup in external systems from OPERA.

It is intended for third party vendor developers who might be implementing the

functionality to interface with OPERA XChange Interface. Knowledge of HTTP protocol

and server side implementation is a prerequisite to accomplish this task.

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 and any associated log files

Screen shots of each step you take

Documentation Oracle Hospitality product documentation is available on the Oracle Help Center at

http://docs.oracle.com/en/industries/hospitality/

https://support.oracle.com/

http://docs.oracle.com/en/industries/hospitality/

5

1 Assumptions

This document describes the intended functionality of profile lookup in OXI flavored

interfaces. Details explained in this document may change as needed or required.

6

2 Validations

OXI does not validate the lookup criteria receive from OPERA. For details on any

validations performed by OPERA, please refer to OPERA’s documentation.

External systems may get a wild card profile lookup request. Neither OPERA nor OXI

mandates any particular wild card conventions. A commonly used wild card is * for one

or more characters.

7

3 Profile Lookup Lifecycle

OPERA displays the profile editscreen with the profile created/

merged by OXI

OPERA user initiates profile lookup

Listening OXI Processorreceives the lookup request,

builds a profile lookup requestXML and sends to the

external system as HTTPPOST operation.

External system retrieves lookupcriteria from the input stream,

builds a profile lookup responseXML from the list of profiles

matching the criteria and sendsin the HTTP response stream.

OXI processor parses the

response and sends the profiles

to OPERA.

OPERA displays the profiles to the user. User selects a profile.

OPERA initiates a profile request for the profile selected

by the user.

Listening OXI processor receivesthe profile request and sends tothe external system as HTTP

GET operation.

External system retrieves theprofile request from the URL

parameters, builds a completeprofile XML from the matchingprofile and sends in the HTTP

response stream. Using OXI's generic match/

merge process, OXI processorbuilds the profile in OPERA

and sends the id of the

resultant profile to OPERA.

8

4 HTTP Communication

Lookup Request URL : http://server[:port]/configurableUrl HTTP Operation : POST Parameters : none

Content-Type : text/xml Data Stream : plquery XML message Response Stream : plresult XML message

Profile Request URL : http://server[:port]/configurableUrl?

propertyName=ExternalResort&transactionId=TransactionID&action=G

ETC RS&profileId=ExtSysUniqueProfileID HTTP Operation : GET

Content-Type : text/xml Data Stream : None Response Stream : profile XML message

URL Parameters

Seq Parameter Name

Type Description

1 propertyName string Property code recognized by the external system.

External resort configured in OXI’s interface setup.

2 transactionId int Id to uniquely identify this request.

3 action string Always GETCRS.

4 profile_id int Unique profile Id recognized by the external

system. This will be the value sent by the external

system in ProfileSet\nameId element of plresult

message.

http://server/

http://server/

XML Schemas 9

5 XML Schemas

Lookup Request XML Schema : plquery

XML Schema version : 1.1

Query <xs:complexType name="Query">

<xs:sequence>

<xs:element name="propertyName" type="xs:string"/>

<xs:element name="formatName" type="xs:string" minOccurs="0"/>

<xs:element name="transactionId" type="xs:string"/>

<xs:element name="setSize" type="xs:int" minOccurs="0"/>

<xs:element name="transactionType" type="xs:string" minOccurs="0"/>

<xs:element name="firstName" type="xs:string" minOccurs="0"/>

<xs:element name="lastName" type="xs:string" minOccurs="0"/>

<xs:element name="city" type="xs:string" minOccurs="0"/>

<xs:element name="state" type="xs:string" minOccurs="0"/>

<xs:element name="zip" type="xs:string" minOccurs="0"/>

<xs:element name="country" type="xs:string" minOccurs="0"/>

<xs:element name="memberNumber" type="xs:string" minOccurs="0"/>

<xs:element name="creditCard" type="xs:string" minOccurs="0"/>

</xs:sequence>

<xs:attribute name="profileType" type="xs:string"

use="required"/>

</xs:complexType>

Name Type Data Type

Use Comment

profileType attribute string required Type of the profile. Valid values

are GUEST, CORPORATE,

TRAVEL, GROUP and

WHOLESALER. OXI uses

profile type conversion.

propertyName element string required Property code recognized by the

external system. External resort

configured in OXI’s interface

setup.

formatName element string optional Not used.

transactionId element string required Unique id associated with the lookup

request. Generated by OPERA while

initiating the lookup.

10

setSize element int optional Maximum number of matching

profiles to return in the response.

External system should use this as a

hint to limit the number of matching

profiles.

transactionType element string optional Not used.

firstName element string optional First name of the profile. OPERA

mandates this field.

lastName element string optional Last name of the profile. OPERA mandates this field.

city element string optional City of the profile.

state element string optional State of the profile.

zip element string optional Zip code of the profile.

country element string optional Country of the profile.

memberNumber element string optional Membership number.

creditCard element string optional Not used.

Lookup Response XML Schema : plresult XML Schema version : 1.0

LookupResult

<xs:complexType name="LookupResult">

<xs:sequence>

<xs:element name="transactionId" type="xs:string"/>

<xs:element name="ProfileSets" type="ProfileSets" minOccurs="0"/>

<xs:element name="errorMsg" type="xs:string" minOccurs="0"/>

</xs:sequence>

</xs:complexType>

Name Type Data Type Use Comment

transactionId element string required transactionId sent in

lookup request.

ProfileSets element ProfileSets optional List of matching profiles.

errorMsg element string optional Details of error, if any.

XML Schemas 11

ProfileSets

<xs:complexType name="ProfileSets">

<xs:sequence>

<xs:element name="ProfileSet" type="ProfileSet" minOccurs="0"

maxOccurs="unbounded"/>

</xs:sequence>

</xs:complexType>


ProfileSet element ProfileSet optional Details of matching profile.

ProfileSet

<xs:complexType name="ProfileSet">

<xs:sequence>

<xs:element name="resortNameId" type="xs:string" minOccurs="0"/>

<xs:element name="nameId" type="xs:int" minOccurs="0"/>

<xs:element name="memberNumber" type="xs:string" minOccurs="0"/>

<xs:element name="lastName" type="xs:string" minOccurs="0"/>

<xs:element name="firstName" type="xs:string" minOccurs="0"/>

<xs:element name="address" type="xs:string" minOccurs="0"/>

<xs:element name="address2" type="xs:string" minOccurs="0"/>

<xs:element name="city" type="xs:string" minOccurs="0"/>

<xs:element name="state" type="xs:string" minOccurs="0"/>

<xs:element name="zip" type="xs:string" minOccurs="0"/>

<xs:element name="country" type="xs:string" minOccurs="0"/>

<xs:element name="profileType" type="xs:string" minOccurs="0"/>

<xs:element name="udf" type="xs:string" minOccurs="0"/>

</xs:sequence>

</xs:complexType>


resortNameId element string optional Unique id of the profile in

OPERA, if available.

nameId element int optional Unique id of the profile in

external system. This value is

mandatory as it is the key used

while requesting for full profile

when user selects a profile from

the returned list of profiles.

memberNumber element string optional Membership number. OPERA

displays this.

lastName element string optional Last name. OPERA displays

this.

firstName element string optional First name. OPERA displays

this.

12

address element string optional Address line 1. OPERA displays

this.

address2 element string optional Address line 2. OPERA displays

this.

city element string optional City. OPERA displays this.

state element string optional State. OPERA displays this.

zip element string optional Postal code. OPERA displays

this.

country element string optional Country. OPERA displays this.

profileType element string optional Profile type.

Udf element string optional Not used.

Profile Request XML Schema : Not applicable

Notes : No XML schema is used to request a particular profile. Profile’s

unique identifier is passed in the request itself.

Profile Response XML Schema : profile XML Schema version : 1.2 or 2.0 as configured in OXI XML Tables : Please refer to OXI profile download specifications.

HTTP Call Samples 13

6 HTTP Call Samples

Profile Lookup Request and Response HTTP Action : POST

Sample URL : /servlets/ORSLookup URL Parameters : None

Request & Response content type : t ext/xml

Request & Response character encoding : UTF8

HTTP POST Data (Request for matching profiles)

<?xml version="1.0"?>

<?Label SLBK|PLQUERY|5018|SUCCESS?>

<Query xmlns="plquery.fidelio.1.1" profileType="">

<propertyName>SLBK</propertyName>

<transactionId>1111</transactionId>

<setSize>50</setSize>

<firstName>Jane</firstName>

<lastName>Smith</lastName>

<city> Anytown</city> <state>FL</state>

<zip>99999</zip>

<country>US</country>

</Query>

HTTP POST Response (List of matching profiles returned synchronously by external system)

<?xml version="1.0"?>

<LookupResult xmlns="plresult.fidelio.1.0">

<transactionId>5018</transactionId>

<ProfileSets>

<ProfileSet>

<resortNameId>29542</resortNameId>

<nameId>10759</nameId>

<memberNumber>97105</memberNumber>



<address> 1111 Street</address> <city>Anytown</city>

<state>FL</state>

<zip>99999</zip>


</ProfileSet>

<ProfileSet>

14




<lastName>John</lastName>

<firstName>Smith</firstName>

<address> 1111 Street</address> <address2>2222 Street</address2>

<city>Anytown</city>

<state>FL</state>

<zip> 99999</zip> <country>US</country>

</ProfileSet>

<ProfileSet>






<address>1111 Street</address>


<zip>99999</zip>


</ProfileSet>

<ProfileSet>




<address>2222 Street</address>


<state>FL</state>

<zip>9999</zip>


</ProfileSet>

</ProfileSets>

</LookupResult>

Profile Request HTTP Action : GET Sample URL : /servlets/ORSLookup URL Parameters : propertyName=SLBK&transactionId=10766&action=GETCRS&profileId=10766 Response content type : text/xml Response character encoding : UTF8

HTTP GET Response (Unique matching profile returned synchronously by external system)

<?xml version = '1.0'?>

<?Label SLBK|PROFILE|108|SUCCESS?>

<Profile profileType="GUEST" gender="F" xmlns="profile.fidelio.1.2">

<profileID>10766</profileID>

HTTP Call Samples 15

<creatorCode>OXI-V6</creatorCode>

<createdDate>2003-11-12T13:57:03.000</createdDate>

<lastUpdaterCode>SORIAM</lastUpdaterCode>

<lastUpdated>2004-04-29T16:36:14.000</lastUpdated>

<genericName>John</genericName>

<IndividualName>

<namePrefix>Mrs</namePrefix>

<nameFirst>Jane</nameFirst>

<nameSur>Smith</nameSur>

</IndividualName>

<primaryLanguageID>E</primaryLanguageID>

<Documents>

<Document>

<name>Jane</name>

<docNumber>A1111111</docNumber>

<nationality>US</nationality>

<documentCode>PASSPORT</documentCode>

</Document>

</Documents>

<PostalAddresses>

<PostalAddress addressType="HOME">

<address1>1111 Street</address1>


<stateCode>FL</stateCode>

<postalCode>99999</postalCode>

<countryCode>US</countryCode>

<mfPrimaryYN>Y</mfPrimaryYN>

</PostalAddress>

</PostalAddresses>

<PhoneNumbers>

<PhoneNumber phoneNumberType="HOME">

<phoneNumber>+1(999)999-9999</phoneNumber>


</PhoneNumber>

</PhoneNumbers>

<mfResort>SLBK</mfResort>

<mfVipStatus>0</mfVipStatus>

<mfAllowMail>NO</mfAllowMail>

<mfAllowEMail>NO</mfAllowEMail>

<mfGuestPriv>NO</mfGuestPriv>

</Profile>

16

7 Profile Anonymization Schema Changes

This message specification has been extended to exchange the anonymization status of a profile.

XDR: profile.fidelio.5.0.xml: <AttributeType name="anonymizationStatus" dt:type="enumeration" dt:values="UNDEFINED REQUESTED

ANONYMIZED" default="UNDEFINED" required="no"/>

<ElementType name="Profile" content="eltOnly">

<attribute type="anonymizationStatus"/>

XSD

Profile Anonymization Schema Changes

17

Sample Message

<?xml version="1.0" encoding="UTF-8"?>

<?Label MOTTI|PROFILE|8531399|SUCCESS?>

<Profile xmlns="profile.fidelio.5.0" profileType="GUEST" gender="UNKNOWN" multiProperty="0"

miniProfile="0" pseudoProfile="0" anonymizationStatus="ANONYMIZED" replaceAddress="0">

<creatorCode>SUPERVISOR</creatorCode>

<createdDate>2018-03-22T16:13:45.000</createdDate>

<lastUpdaterCode>SUPERVISOR</lastUpdaterCode>

<lastUpdated>2018-03-22T16:13:58.000</lastUpdated>

<genericName>kXXXXXXXXn</genericName>

<IndividualName>

<nameSur>kXXXXXXXXn</nameSur>

<nameOrdered>E</nameOrdered>

</IndividualName>

<primaryLanguageID>E</primaryLanguageID>

<alternateLanguageIDs>CH</alternateLanguageIDs>

<PostalAddresses>




<mfAddressLanguage>CH</mfAddressLanguage>

<cleansed>0</cleansed>

</PostalAddress>



<mfPrimaryYN>N</mfPrimaryYN>

<mfAddressLanguage>E</mfAddressLanguage>

<cleansed>0</cleansed>

</PostalAddress>

</PostalAddresses>

<mfResort>MOTTI</mfResort>

<mfResortProfileID>8523838</mfResortProfileID>

<mfNameCode>5XXXXXXXX5</mfNameCode>

<mfAllowMail>YES</mfAllowMail>

<mfAllowEMail>NO</mfAllowEMail>

<mfGuestPriv>NO</mfGuestPriv>

<Udfs>

<Udf xmlns="udf.fidelio.2.0">

<UdfDefinition xmlns="udfdefinition.fidelio.2.0">

<pmsTableName>NAME</pmsTableName>

<pmsColumnName>UDFC01</pmsColumnName>

</UdfDefinition>

</Udf>

</Udfs>

18

<mfNationalName>

<nameLast>kXXXXXXXXn</nameLast>

</mfNationalName>

<mfAllowPhone>0</mfAllowPhone>

<mfAllowSMS>0</mfAllowSMS>

<SalesExtention/>

<PrivacyOption>

<mfAllowMail>Y</mfAllowMail>

<mfAllowEMail>N</mfAllowEMail>

<mfAllowPhone>0</mfAllowPhone>

<mfAllowSMS>0</mfAllowSMS>

<mfAllowHistory>0</mfAllowHistory>

<mfAllowMarketResearch>1</mfAllowMarketResearch>

<mfAllowThirdParty>1</mfAllowThirdParty>

</PrivacyOption>

<ResortData>

<ResortDatum>

<mfResort>EnterExtResort_11504</mfResort>

<sfaAttachments>0</sfaAttachments>

</ResortDatum>

<ResortDatum>

<mfResort>CLOUD5</mfResort>


</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>

<mfResort>BARRIE</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>ZOLTAR</mfResort>


</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>


19

<mfResort>QADEANNA</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>FAIR</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>FAIR2</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>FAIR3</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>FRED</mfResort>


</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>

<mfResort>IPKK</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>RADQA</mfResort>


</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>

<mfResort>KMH</mfResort>


</ResortDatum>

<ResortDatum>


20


</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>

<mfResort>MEAD</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>MEXICO</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>MOTTI</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>MOTTITWO</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>MO_III</mfResort>


</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>




21

</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>

<mfResort>TORONTO</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>VIXX</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>WORLD1</mfResort>


</ResortDatum>

<ResortDatum>

<mfResort>ZEROORS</mfResort>


</ResortDatum>

<ResortDatum>



</ResortDatum>

<ResortDatum>



</ResortDatum>

</ResortData>


<ResortList>EnterExtResort_11504</ResortList>

<ResortList>CLOUD5</ResortList>

22



<ResortList>BARRIE</ResortList>

<ResortList>ZOLTAR</ResortList>


<ResortList>QADEANNA</ResortList>

<ResortList>FAIR</ResortList>

<ResortList>FAIR2</ResortList>

<ResortList>FAIR3</ResortList>

<ResortList>FRED</ResortList>



<ResortList>IPKK</ResortList>

<ResortList>RADQA</ResortList>


<ResortList>KMH</ResortList>






<ResortList>MEAD</ResortList>

<ResortList>MEXICO</ResortList>

<ResortList>MOTTI</ResortList>

<ResortList>MOTTITWO</ResortList>

<ResortList>MO_III</ResortList>







<ResortList>TORONTO</ResortList>

<ResortList>VIXX</ResortList>

<ResortList>WORLD1</ResortList>

<ResortList>ZEROORS</ResortList>



<MultiResortEntities>

<MultiResortEntity included="1">

<entity>ROUTING_INSTRUCTIONS</entity>

</MultiResortEntity>


<entity>CREDIT_CARDS</entity>



23


<entity>RESORT_ARS</entity>



<entity>COMMENTS</entity>



<entity>PREFERENCES</entity>



<entity>NEGOTIATED_RATES</entity>



<entity>RESORT_NEG_RATES</entity>



<entity>RESORT_COMMISSIONS</entity>



<entity>CHANNEL_ACCESS_CODES</entity>



<entity>YIELD_ADJUSTMENTS</entity>



<entity>PSEUDO_CITY_CODES</entity>



<entity>RELATIONSHIPS</entity>


</MultiResortEntities>

</Profile>

Note: profile.fidelio.5.0.xml is used in reservation.fidelio.5.0.xml, so it contains

the same profile changes.