Reservations Interface Parameters and Settings
Table 27-10 Reservations Interface Parameters, Settings and Description
Parameter Name | Parameter Value | Direction of transmission where parameter applies.Parameter Description | Recommended Setting |
---|---|---|---|
ADDITIONAL REFERENCE EXCHANGE |
(see description) |
-> Direction: Data from OPERA Cloud to external systems and external systems to OPERA Cloud. Comma separated list of unique additional external reference types that are allowed to be included in the reservation and reservation result messages to the external systems, and accepted from the external systems. This may include actual external system types (such as ORS, OXI-OPERA, MYFIDELIO, etc.), but references belong to those systems will be exchanged from OPERA Cloud to external systems only, those will be ignored while processing inbound messages from external systems to OPERA Cloud to prevent tampering legitimate external system references present in OPERA Cloud. |
Set Accordingly. |
AUTOPOPULATE MEMBERSHIP YN |
Y/N |
-> Direction: Data from external system to OPERA Cloud. If this parameter is set to Y, OXI will populate the selected memberships from the reservation message based on the membership type configuration in OPERA Cloud. This means if the membership type is setup to auto populate reservation, OXI will do the same when inserting the reservation. If that membership type is setup to not auto populate reservation or to prompt user, OXI will not copy the membership either. If the parameter is set to N, OXI will copy the selected memberships from the message into the reservation, regardless of the membership type configuration in OPERA Cloud. |
Set to Y to allow the same functionality as if OPERA Cloud user enters a membership directly. |
COPY COMMENTS FROM PROFILE |
Select a profile type accordingly. |
-> Direction: Data from external system to OPERA Cloud. For profiles which have notes (Type: Reservation) associated with it, this parameter will determine whether to copy them on to reservation as comments. The value(s) of the parameter will also determine the type of profiles the copy is intended.
Leave the value blank (null, which is default value) to avoid copying the reservation notes from profile to reservation as comments. If single value is selected then notes from that particular profile type are copied. If multiple values are selected then notes from those selected list of profile types are copied. |
Default value is null. |
EXT SYS HANDLES DAY USE |
Y/N |
-> Direction: Data from OPERA Cloud To External System. When parameter value = Y, handling day use rooms has no difference. When parameter value = N, OXI will send a cancellation message to the external system when OPERA Cloud reservation has an external reference number and the number of nights equals 0. |
Default is Y. Set accordingly. |
EXT SYS MARKET/SOURCE CONTROL |
R/B/E/D/Y or N |
-> Direction: Data from external system to OPERA Cloud. This parameter defines the sequence in which OXI identifies the market and source codes to apply in the reservation.
|
Set accordingly. |
EXT SYS PRICE CONTROL |
N/Y/YC |
-> Direction: Data from external system to OPERA Cloud Y -> External rate will be applied with discounts present in the message. The reservation rate will be fixed if OPERA Cloud Fixed Rates is enabled and the inbound message includes an indicator (identified by a structured tag in the message) that the rate should be fixed or if the indicator is not present in the message. If the inbound message includes an indicator that the rate should not be fixed, the reservation rate will not be fixed. In this case, there will be no rate comparison between the rate sent in the message against the rate detail in OPERA Cloud. The rate amount sent in the message will always be used and the decision to fix the rate in OPERA Cloud will be made by the contents of the inbound message. YC -> External rate will be applied with discounts present in the message. The reservation rate will be fixed if OPERA Cloud Fixed Rates is enabled and the inbound message includes an indicator (identified by a structured tag in the message) that the rate should be fixed. If the inbound message includes an indicator that the rate should not be fixed or if the inbound message does not include the fixed rate indicator, then a rate comparison between the rate sent in the message against the rate detail in OPERA Cloud will be executed to determine whether or not to fix the rate. The rate amount sent in the message will always be used, but the decision to fix the rate in OPERA Cloud will be made by the results of the rate comparison. If the rate in the inbound message matches the rate in OPERA Cloud, the rate will not be fixed. If the rate in the inbound message does not match the rate in OPERA Cloud, the rate will be fixed. N -> OPERA Cloud rate will be applied. Any discounts present in the message will be ignored and will not be applied. |
Set to Y as external system has already sold the rate amount, and therefore it should be confirmed in OPERA Cloud as well. |
EXT SYS GENERATED INV |
Y/N |
-> Direction: Data from external system to OPERA Cloud When a reservation message from an external system is received, OXI will generate inventory snapshots for the affected dates and room types. |
Set Accordingly. |
FORCE BLOCK CODE |
Block Code / Blank |
-> Direction: External System to OPERA Cloud only. When selected, all reservations received will be booked against the selected block, regardless of the presence or value of a block code in the message. When blank, no particular function is associated. Note: This interface parameter is available for the TUI interface only. |
Default is blank. Set Accordingly. |
FULL OPERA SHARES |
Y NS NU |
->Direction: Data both ways between external system and OPERA Cloud. The following rules apply to both incoming and outgoing messages: When this parameter is set to Y, any update on one individual reservation will be reflected in one reservation XML message. Any share related action (combine/break) will be reflected in appropriate share reservation message with only the key information about the reservations involved. When this parameter is set to NS any update, including share related on any of the reservations will be reflected in a reservation XML message containing information about all the relevant shares. External reference of all the share reservations in OPERA Cloud will be updated from the incoming result message. When this parameter is set to NU, it acts similarly to NS, but external reference of only those reservations in OPERA Cloud mentioned in the result message will be updated from the incoming result message. Note: This parameter can be active for any interface that requires it (ORS / OXI-OPERA / OXI-V7 / OXI-V6).
|
Set to N as this is only used for OPERA Cloud. |
IGNORE RES FOR UPDATE OLDER THAN |
Numeric value for number of days |
-> Direction: Data from external system to OPERA Cloud Enter a numeric value that will be translated into number of days. The value entered here will determine how many days in the past OXI will consider existing reservations for update when matching on external reference number. If the external reference number sent in the message matches the external reference of an existing reservation, then that reservation will be considered for update if the departure date of the existing reservation is same or later than the number of days in the past entered in this parameter. If the departure date of the existing reservation is earlier than the number of days in the past entered in this parameter, then the existing reservation will be ignored and a new reservation will be created. If this parameter is left blank, then ALL existing reservations will be considered for update.
|
Set Accordingly. The Default setting is blank and this parameter should be left blank if the external system will always send a unique confirmation number. |
INHERIT CONFIRMATION NUMBER |
Y/N |
-> Direction: External System to OPERA Cloud only. When set to Y, OPERA Cloud will inherit the external system's confirmation number as its own, which will allow passing of the originating (Guest) confirmation number to PMS systems that do not have the capability of processing and storing multiple external references. When set to N, OPERA Cloud will store the external system's confirmation number, assign the OPERA Cloud confirmation number and pass it along to the receiving system. This parameter is subjected to the following restrictions: - The parameter can be set to Y for only one external system across the entire OPERA Cloud system - For this one system, it can be selected for any number of resorts - For resorts, where the parameter is set to Y, the parameter SEND IFC CREATED ONLY must be set to Y as well. The restrictions serve to limit the possibility of colliding confirmation numbers between multiple external systems and OPERA Cloud. It is however the OPERAtor's responsibility to set the confirmation number sequences such that this never occurs. |
Set Accordingly. |
ITEM INVENTORY EXT SYS OVER |
Y/N |
-> Direction: Data from external system to OPERA Cloud Enter a numeric value that will be translated into number of days. The value entered here will determine how many days in the past OXI will consider existing reservations for update when matching on external reference number. If the external reference number sent in the message matches the external reference of an existing reservation, then that reservation will be considered for update if the departure date of the existing reservation is same or later than the number of days in the past entered in this parameter. If the departure date of the existing reservation is earlier than the number of days in the past entered in this parameter, then the existing reservation will be ignored and a new reservation will be created. If this parameter is left blank, then ALL existing reservations will be considered for update. Default setting is blank and this parameter should be left blank if the external system will always send a unique confirmation number. |
Set Accordingly. |
PACKAGE EXT SYS OVER |
(see description) |
-> Direction: Data from external system to OPERA Cloud. This parameter determines how the package elements received from the external system updates the packages in OPERA Cloud. A = If received, replace OPERA Cloud values with the received values. If not received, remove the values from OPERA Cloud. B = If received, replace OPERA Cloud values with the received values. If not received, do not remove the values from OPERA Cloud. C = If received, merge the received values with OPERA Cloud values. If not received, remove the values from OPERA Cloud. D = If received, merge the received values with OPERA Cloud values. If not received, do not remove the values from OPERA Cloud. N = Ignore the package elements received. Do not touch the values in OPERA Cloud. |
Set Accordingly. |
PEGASUS CHANNEL UPDATE |
ALN/LCL or ORD/RID |
-> Direction: Data from external system to OPERA Cloud. For Pegasus only: this parameter determines whether the combination ALN/LCL or ORD/RID are used to map into the OPERA Cloud channel code. For ALN/LCL: If Pegasus sends ALN, this will be used for channel mapping, otherwise the LCL will be used. For ORD/RID: If Pegasus sends ORD, this will be used for channel mapping, otherwise the RID will be used. |
Pegasus for Fairmont: ALN/LCL Pegasus for Meridien: ORD/RID |
PROMOTION EXT SYS OVER |
Y/N |
-> Direction: Data from external system to OPERA Cloud This parameter determines whether Promotion elements sent by external system shall overwrite OPERA Cloud Promotion elements or not. Overwriting may be desired, as the property should decide what Promotions the guest has in this reservation. Set to Y and reservation Promotions will always be overwritten by external system Promotions. Set to N and Promotion elements sent by external system will be appended to existing ones in OPERA Cloud. |
Set Accordingly. |
RATE CODE CONVERSION MODE |
RATE CODE FLOATING RATE |
-> Direction: Data both ways between external system and OPERA Cloud This parameter determines whether to use only one of external SRP and rate level or the combination of both to convert to/from OPERA Cloud rate codes. When set to RATE CODE, when SRP is received from external system, it will be converted to OPERA Cloud rate code, else rate level will be converted to OPERA Cloud rate code and back. When set to FLOATING RATE, combination of the external SRP and rate level will be converted to an OPERA Cloud rate code and back. |
Set Accordingly. This parameter is only available for the Pegasus Interface. |
REINSTATE CANCELLED RESERVATION |
ALWAYS - ON ANY UPDATE ACTION REINSTATE - ONLY ON REINSTATE ACTION |
Direction: Data from External System to OPERA Cloud.
This parameter determines how canceled reservations will be reinstated when processing inbound reservation messages.
ALWAYS: Cancelled reservations will be reinstated when the action type in the reservation message indicates UPDATE or REINSTATE or RESYNC. REINSTATE: Cancelled reservations will be reinstated only when the action type in the reservation message explicitly indicates REINSTATE or RESYNC. If the action type in the reservation message is different, reservation will not be reinstated and an appropriate error will be logged. |
Set Accordingly. |
REMOVE EXT SYS NO |
Y/N |
-> Direction: Data from OPERA Cloud to external system. This parameter only applies to full 2-way interfaces that send reservations both ways. If a party reservation is split into multiple single reservations in OPERA Cloud, the split-offs need to be sent as new reservations to the external system. In this case the original external confirmation number should be removed before the message is sent to ensure that a new confirmation number is triggered. The same would apply in case a share is broken in OPERA Cloud. Here we would send a new reservation for the broken share and that should result in a new confirmation number as well. Therefore the parameter would be set to Y. If set to N, the external system confirmation number will be kept after a split of a party reservation or a break share. This is required for a 1-way interface where the external system does not return a new confirmation number since it does not know about the change in OPERA Cloud. |
Set to Y for all full 2-ways that sent CRS numbers upon receipt of new reservations. Otherwise set to N. |
REMOVE EXT REF ON REINSTATE |
NO SHOW
CANCEL
NULL |
->Direction: Data from OPERA Cloud to External System Select NO SHOW if the reinstate no show message sent to the External System should not contain the External Reference Number of the current interface. Select this option when the External System cannot reinstate a no show reservation using the same reference number. Select CANCEL if the reinstate cancel message sent to External System should not contain the External Reference Number of the current interface. Select this option when the External System cannot reinstate a canceled reservation using the same reference number. If this parameter is NULL, then the External Reference Number of the current interface will always be sent to the External System for reinstate messages. |
Set Accordingly. |
RESCOMMENTS EXT SYS OVER |
Y/N |
-> Direction: Data from external system to OPERA Cloud. This parameter determines whether reservation comments sent by external system shall overwrite OPERA Cloud comments or if they shall be appended to existing ones. If set to Y the OPERA Cloud reservation comments will always be overwritten by the external system comments. If set to N, only comments where the update user = external system ID in the OPERA Cloud database will be updated. |
Set to N if you would like to keep OPERA Cloud changes intact. |
SHARE RATE CALC METHOD |
ENTIRE FULL INACTIVE SPLIT |
- >Direction:Data from external system to OPERA Cloud 'INACTIVE' = When OXI Parameter OPERA Cloud FULL SHARES is set to Y, behavior is INACTIVE, regardless of parameter value. When 'FULL OPERA Cloud SHARES' is set to N, OPERA Cloud determines the share amount as follows: SPLIT: Each sharer will carry an equal portion of the total rate amount. FULL: Each sharer will have the full rate amount. ENTIRE: First sharer will be determined as the primary and carry the entire rate amount, all other sharers will have a zero rate amount. |
Defaults to INACTIVE Works with FULL OPERA Cloud SHARES parameter, see explanation before setting. |
SHARER REMOVAL MODE |
CANCEL DELETE NEITHER |
-> Direction: External system to OPERA Cloud only. Applicable only when FULL OPERA Cloud SHARES=N. This parameter determines how should OXI handle share reservations those found in OPERA Cloud but not coming in the message. When this parameter = CANCEL it cancels any sharer present in OPERA Cloud which does not appear in the incoming message. When this parameter = DELETE it deletes any sharer present in OPERA Cloud which does not appear in the incoming message. When this parameter = NEITHER it leaves sharer(s) those present in OPERA Cloud untouched, even if they don't appear in the message. |
This parameter is only available when the parameter FULL OPERA Cloud SHARES is set to N. Set accordingly. |
SPECIALS EXT SYS OVER |
Y/N |
-> Direction: Data from external system to OPERA Cloud. This parameter determines whether special requests sent by the external system will overwrite the ones in OPERA Cloud, or if they will be appended to existing ones. The functionality of this parameter is further determined by the mode of your interface. If it works with Delta changes set to Yes (Interface Configuration>Edit Interface), the external system can send reservation changes only and does not need to send the full reservation every time a small change to a reservation occurs. OXI will then only update the changed data and not touch the additional data that was found in the OPERA Cloud reservation. This also means that the external system needs to indicate intended deletions clearly with deletion indicators in the message. Sending simply blanks will not lead to data deletion if OXI works in Delta mode. The deletion indicators can be configured in interface configuration->edit interface. If your interface is set to Delta changes No, OXI expects a full overlay of all profile data in every profile message, even if the external system only changes very little of the entire profile. Here is how the parameter works: If set to Y and the interface is setup as Delta Changes = Y, ONLY the specials originally inserted by the external system will be overwritten. If set to Y and the interface-> Direction: Data from OPERA Cloud to external system When the reservation message can't be delivered (possibly due to communication errors) to the external system, a trace will be logged against this trace department. Applicable only if OXI processor is configured to deliver the messages. is setup as Delta Changes = N, all reservation specials in OPERA Cloud will be overwritten by the external system specials. If set to N, new specials will be appended to existing ones in OPERA Cloud, regardless whether the interface works in delta mode or not. |
Determine whether values shall overwrite or append and select your setting accordingly. |
SPLIT CANCELLATIONS |
CANCEL/ DELETE |
-> Direction: Data from external system to OPERA Cloud. This parameter determines how OXI handles split off reservations, for a 1-way interface, when a cancel message is received for the original multi room reservation from the external system. CANCEL: Split reservations will be canceled. DELETE: Split reservations will be deleted. |
Set Accordingly. (For 1-Way Interface) |
STAY UPLOAD PROFILE TYPES |
(see description) |
-> Direction: Data from OPERA Cloud to external systems. If null all the stay records will be sent to external system. If value(s)are selected; then the stay records will be sent where only those profiles exist on Stay records. (i.e. If selection is only TRAVEL_AGENT, then only Stay Records that have an attached Travel Agent profile will be sent. All other Stay records without this profile will not be sent). |
Set Accordingly. |
TRACE DEPT FOR DELIVERY FAILURE |
(see description) |
-> Direction: Data from OPERA Cloud to external system When the reservation message can't be delivered (possibly due to communication errors) to the external system, a trace will be logged against this trace department. Applicable only if OXI processor is configured to deliver the messages. |
Set Accordingly. |
TRACE DEPT FOR FAILURE IN EXT SYS |
(see description) |
-> Direction: Data from external system to OPERA Cloud When the external system can't process a reservation message received from OPERA Cloud, if it sends a result message back to OPERA Cloud indicating the error, a trace with the error message will be logged against this trace department. |
Set Accordingly. |
TRACE DEPT FOR NON REVIEWED |
(see description) |
-> Direction: Data from external system to OPERA Cloud When a non-reviewed reservation message received from the external system is processed, a trace will be logged against this trace department. If a canceled reservation message is sent from an external system OXI also adds an additional trace reading "Please review this reservation cancelled by XXX external system.", where XXX is replaced with the name of the actual interface. |
Set Accordingly. |
TRACE ROOM ASSIGNMENT |
NO ROOM ALWAYS NEVER |
-> Direction: External System to OPERA Cloud only. NO ROOM - OPERA Cloud will trace if Room could not be assigned. ALWAYS - OPERA Cloud will trace Room assignment process. NEVER - OPERA Cloud will not trace Room assignment. |
Set Accordingly. |
UPDATE ACCOMPANY GUEST |
A B C D N |
-> Direction: Data from external system to OPERA Cloud This parameter determines how the accompany guest received from the external system updates the accompany guest in OPERA Cloud. A = If received, replace OPERA Cloud values with the received values. If not received, remove the values from OPERA Cloud. B = If received, replace OPERA Cloud values with the received values. If not received, do not remove the values from OPERA Cloud. C = If received, merge the received values with OPERA Cloud values. If not received, remove the values from OPERA Cloud. D = If received, merge the received values with OPERA Cloud values. If not received, do not remove the values from OPERA Cloud. N = Ignore the accompany guest received. Do not touch the values in OPERA Cloud. |
Set Accordingly. |
UPDATE FEATURES |
A B C D N |
-> Direction: Data from external system to OPERA Cloud. This parameter determines how the features received from the external system updates the features in OPERA Cloud. A = If received, replace OPERA Cloud values with the received values. If not received, remove the values from OPERA Cloud. B = If received, replace OPERA Cloud values with the received values. If not received, do not remove the values from OPERA Cloud. C = If received, merge the received values with OPERA Cloud values. If not received, remove the values from OPERA Cloud. D = If received, merge the received values with OPERA Cloud values. If not received, do not remove the values from OPERA Cloud. N = Ignore the features received. Do not touch the values in OPERA Cloud. |
Set Accordingly. |
UPDATE FIXED CHARGES |
A B C D N |
-> Direction: Data from external system to OPERA Cloud This parameter determines how the fixed charges received from the external system update the fixed charges in OPERA Cloud reservation. A = If received, replace OPERA Cloud values with the received values. If not received, remove the values from OPERA Cloud. B = If received, replace OPERA Cloud values with the received values. If not received, do not remove the values from OPERA Cloud. C = If received, merge the received values with OPERA Cloud values. If not received, remove the values from OPERA Cloud. D = If received, merge the received values with OPERA Cloud values. If not received, do not remove the values from OPERA Cloud. N = Ignore the fixed charges received. Do not touch the values in OPERA Cloud. |
Set Accordingly. |
UPDATE INHOUSE RES |
Y/N |
-> Direction: Data from external system to OPERA Cloud. With this parameter OXI allows you to update reservations that are flagged as Checked In OPERA Cloud PMS. If set to Y, OXI will accept changes to checked in reservations in OPERA Cloud except for arrival date and room type changes. If set to N, OXI will reject any changes to a checked in reservation in OPERA Cloud. |
Set to Y if you would like your in-house reservations updated further by the external system. |
UPDATE ROUTING TO ROOM |
Y/C/N |
-> Direction: Data from external system to OPERA Cloud. This parameter determines how the room routing instructions received from the external system update the room routing instructions in OPERA Cloud reservation. Y = Replace all the OPERA Cloud routings with the received routings. If no routings are received, remove all the OPERA Cloud routings. C = Accept all the valid routings received into OPERA Cloud, remove only those OPERA Cloud routings with codes configured in conversion but not received in the message. N = Ignore the routings received. Do not modify any routings in OPERA Cloud. |
Set Accordingly. |
UPDATE ROUTING TO WINDOW |
Y/C/N |
-> Direction: Data from external system to OPERA Cloud. This parameter determines how the window routing instructions received from the external system update the window routing instructions in OPERA Cloud reservation. Y = Replace all the OPERA Cloud routings with the received routings. If no routings are received, remove all the OPERA Cloud routings. C = Accept all the valid routings received into OPERA Cloud, remove only those OPERA Cloud routings with codes configured in conversion but not received in the message. N = Ignore the routings received. Do not modify any routings in OPERA Cloud. |
Set Accordingly. |
UPDATE ALERTS |
Determines how the Reservation Alerts received from the external system is processed. |
||
UPDATE SHARE RES |
Y/N |
-> Direction: Data from external system to OPERA Cloud. This parameter allows external systems to update a share reservation in OPERA Cloud. If set to Y, OXI will accept changes to shared reservations in OPERA Cloud based on a strict set of rules:
If this parameter is set to N, OXI will reject any changes to shared reservations in OPERA Cloud. |
Set to Y if you would like your shared reservations updated further by the external system. |
UPDATE TRANSPORTATION COMMENTS |
Y/N |
-> Direction: Data from external system to OPERA Cloud. This parameter setting will determine if the transportation comments in OPERA Cloud reservation should be modified or not. If the value is set to 'Y' the transportation comments in OPERA Cloud reservation will be updated or deleted based on the existence of transportation comments in the received message. If the value is set to 'N' the transportation comments in OPERA Cloud reservation will not be modified in anyway irrespective of the transportation comments existence in the received message. |
Set Accordingly. |
UPL DED RES ONLY |
Y/N |
-> Direction: Data from external system to OPERA Cloud. If set to Y, only deductible reservations will be sent to the external system. In a reservation this is determined by the reservation type and means that only reservations with deductible reservation types would be sent. This is desirable if the external system does not have a concept of tentative and definite reservations and would regard all bookings equally deductible regardless of their status. Set to N if all reservations should be sent to the external system irrespective of the reservation type. |
Set to‘N if external system handles deductible and non-deductible reservations. Otherwise set to Y. |
USE GUEST STATUS NOTIFICATION EXTENSION YN |
Y/N |
-> Direction: Data from OPERA Cloud to External Systems. When set to Y, the HTNG function "GuestStatusNotificationExt" will be used to upload reservation data to the external system. When set to N, the HTNG function "GuestStatusNotification" will be used to upload reservation data. |
|
UPDATE ALERTS |
-> Direction: Data from external system to OPERA Cloud This parameter determines how the Reservation Alerts received
from the external system will get processed in OPERA Cloud.
|
||
AUTO ATTACH ELEMENTS |
Y/N |
Direction: Data from external systems to OPERA Cloud. If this parameter is set to 'Y', OXI auto attaches the reservation elements based on the auto attach element configuration rules. If the parameter is set to 'N', OXI does not auto attach the reservation elements. |
Default value is Y. Set accordingly. |
Parent topic: Interface Controls