Configuring Data Value Mappings
Data Value Mapping (DVM) functionality is available for the External Systems that are created manually in OPERA Cloud, OHIP and Outbound Configurations. You can define the mapping values (or conversions) for many categories such as Room Type, Rate Code, Market Code, Source Code, Transaction Code, Country Code, Cancellation Policy Code and Deposit Policy Code, and convert the value between OPERA Cloud Values and External Systems Values.
Data Value Mapping configuration flags for Inbound (External > OPERA) and Outbound (OPERA > External) are honored. When Flags are enabled respective conversions are applied. When flags are disabled respective conversions are not applied.
When an External System integrated from Oracle Hospitality Integration Platform (OHIP) makes any REST API call, the configured conversion values are applied by the OPERA Cloud REST APIs. The external system must send the following headers in the REST API request in order to use the DVM functionality.
All the DVM conversion are at Property Level only.
-
x-externalSystem="ExternalSystemCode" -
externalData="Y" or "true"
Adding Data Value Mappings
- Select a Conversion Code from the left panel; the right panel loads with predefined codes if available.
- Click New.
- OPERA Cloud Code: Select a code from the list.
- External Code: Enter the external system code.
- External > OPERA Cloud: Select check box to transform data received from external system.
- OPERA Cloud > External: Select check box to transform data sent to external system.
- Click Save.
Editing Data Value Mappings
- Select a Conversion Code from the left panel.
- Select the code mapping record, then click Edit.
- Update the configuration.
- Click Save.
Deleting Data Value Mappings
- Select a Conversion Code from the left panel.
- Select the code mapping record, then click Delete.
- Click Delete to confirm.
Important:
- External System must send the following headers in the API request header
x-externalSystem="ExternalSystemCode"externalData="Y" or "true"
-
External Systems Values (External Code) must be less than or equal to 20 characters.
-
The Data Value Mappings are cached and refreshed every 15 minutes to reflect the latest changes.
List of DVM Groups and Conversion Codes supported for Configuration
| VERSION_CODE | PARENT_CONVERSION | MODULE /GROUP | CONVERSION_CODE |
|---|---|---|---|
| Account Type | ACCOUNT_TYPE | ||
| Action Code | ACTION_CODE | ||
| Activity Location | ACTIVITY_LOCATION | ||
| Activity Status | ACTIVITY_STATUS | ||
| Activity Type (EAS) | ACTIVITY_TYPE | ||
| Activity Type (S&C) | ACTIVITY_TYPE_SC | ||
| Address Type | PROFILE | ADDRESS_TYPES | |
| Block Cancel/Turn/Lost Code | ALLOTMENT | BLOCK_CANCELLATION_CODES | |
| Block Code | ALLOTMENT | BLOCK_CODES | |
| Block Conversion Code | ALLOTMENT | BLOCK_CONVERSION | |
| Block Destination Code | ALLOTMENT | SC_DESTINATION | |
| Block Ranking Code | ALLOTMENT | BLOCK_RANKING | |
| Block Rate Override Reason | ALLOTMENT | BLOCK_RATE_OVERRIDE_REASON | |
| Block/Event/FITContract Status | CATEVENT,ALLOTMENT | BOOKING_STATUS | |
| Booking Type | ALLOTMENT | BOOKING_TYPE | |
| Business Segment | BUSIINESS_SEGMENT | ||
| Calendar Event | CALENDAR | CALENDAR_EVENT | |
| Cancellation Policy | RESERVATION,ALLOTMENT,RATE | CANCELLATION_POLICY | |
| Channel Code | RESERVATION,ALLOTMENT | CHANNEL_CODES | |
| Comment Type | CATEVENT,ALLOTMENT | COMMENT_TYPE | |
| Competition Code | COMPETITION_CODE | ||
| Country Code | COUNTRY_CODE | ||
| Currency Code | RESERVATION,RATE,PACKAGES | CURRENCY_CODE | |
| Day Type | CALENDAR | DAY_TYPE | |
| Deposit Policy | RESERVATION,ALLOTMENT,RATE | DEPOSIT_POLICY | |
| Dept Note Code | PROFILE | DEPT_NOTE_CODE | |
| Discount Reason | RESERVATION | DISCOUNT_REASON | |
| Document Type | PROFILE | DOCUMENT_TYPE | |
| FIT Contract Type | ALLOTMENT | FIT_CONTRACT_TYPE | |
| Function Space | CATEVENT | SC_FUNCTION_SPACE | |
| Function Space Event Type | CATEVENT | EVENT_TYPE | |
| Function Space Location | CONFIGURATION | FUNCTION_SPACE_LOCATION | |
| Function Space Rate Code | CATEVENT | SC_FUNCTION_SPACE_RATE_CODE | |
| Function Space Rate Type | CONFIGURATION | FUNCTION_SPACE_RATE_TYPE | |
| Function Space Setup | CATEVENT | SC_FUNCTION_SPACE_SETUP | |
| Gender | PROFILE | GENDER_MF | |
| Guest Preference | GUEST_PREFERENCE_TYPE | PROFILE,RESERVATION | GUEST_PREFERENCE_CODE |
| Guest Preference Type | PROFILE,RESERVATION | GUEST_PREFERENCE_TYPE | |
| Industry Code | INDUSTRY_CODE | ||
| Influence Code | INFLUENCE_CODE | ||
| Language Code | PROFILE | LANGUAGE_CODES | |
| Market Code | RESERVATION,ALLOTMENT,RATE | MARKET_CODE | |
| Meeting Room Type | MEETING_ROOMTYPE | ||
| Membership Enrollment Code | PROFILE,MEMBERAWARD | ENROLLMENT_CODE | |
| Membership Level | PROFILE,MEMBERAWARD | MEMBERSHIP_LEVEL | |
| Membership Type | PROFILE,MEMBERAWARD | MEMBERSHIP_TYPE | |
| Nationality Code | PROFILE | NATIONALITY | |
| OTA Guest Preference | GUEST_PREFERENCE_TYPE | PROFILE,RESERVATION | OTA_GUEST_PREFERENCE_CODE |
| Payment Method | RESERVATION | PAYMENT_METHOD | |
| Phone Type | PROFILE | PHONE_TYPE | |
| Priority Code | SC_ACC_PRIORITY | ||
| Product Code | RESERVATION,ALLOTMENT,RATE,MEMBERAWARD | PRODUCT_CODE | |
| Profile Priority | PROFILE | PROFILE_PRIORITY | |
| Profile Relationships | RELATIONSHIP | ||
| Profile Rooms Potential | PROFILE | ROOMS_POTENTIAL | |
| Profile Source | PROFILE | PROFILE_SOURCE | |
| Profile Type | PROFILE | PROFILE_TYPE | |
| Promotion Code | RESERVATION | PROMOTION_CODE | |
| Rate Category | RATE | RATE_CATEGORY | |
| Rate Code | RESERVATION,PROFILE,ALLOTMENT,RATE,INVENTORY,MEMBERAWARD | RATE_CODE | |
| Reservation Action Type | ACTION_TYPE | ||
| Reservation Booking Method | RESERVATION,ALLOTMENT | RESV_BOOKING_METHOD | |
| Reservation Cancellation Code | ALLOTMENT | CANCELLATION_CODES | |
| Reservation Status | RESERVATION | RESERVATION_STATUS | |
| Reservation Type | RESERVATION | RESERVATION_TYPE | |
| Revenue Group | CATEVENT | REVENUE_GROUPS | |
| Revenue Type | REVENUE_TYPE | ||
| Room Class | INVENTORY,CATEVENT | ROOM_CLASS | |
| Room Repairs Reason Code | ROOM_REPAIRS_REASON_CODE | ||
| Room Type | RESERVATION,ALLOTMENT,RATE,INVENTORY,CATEVENT,MEMBERAWARD | ROOM_CATEGORY_LABEL | |
| Rooms Potential Code | SC_ACC_ROOMS_POT | ||
| Routing Code | ROUTING_CODE | ||
| S&C Revenue Type | CATEVENT | SC_REVENUE_TYPES | |
| S&C Source Code | SC_ACC_SOURCE | ||
| Scope | SCOPE | ||
| Scope City | SCOPE_CITY | ||
| Source Code | RESERVATION,ALLOTMENT,RATE | SOURCE_CODE | |
| State Code | COUNTRY_CODE | PROFILE | STATE |
| TA Commission Code | PROFILE | TRAVEL_AGENT_COMMISSION_CODES | |
| TA Currency Code | PROFILE | TRAVEL_AGENT_CURRENCY_CODES | |
| Territory Code | SC_TERRITORY | ||
| Title | LANGUAGE_CODES | PROFILE | TITLE |
| Trace Codes | CATEVENT | TRACE_CODE | |
| Trace Departments in Reservations | RESERVATION | TRACE_DEPARTMENT | |
| Transaction Code | RATE,PACKAGES | TRX_CODE | |
| Transaction Generates | RATE,PACKAGES | TRXGENERATES | |
| Transport Type | RESERVATION | TRANSPORT_TYPES | |
| VIP Level | PROFILE | VIP_LEVEL | |
| Waitlist Code | RESERVATION | WAITLIST_CODES |
Supported REST APIs
Table 17-1 List of Synchronous APIs supported
| Business Area | API Operation Name | Business Purpose |
|---|---|---|
| Availability | postRestriction | Set stay restrictions |
| Availability | putSellLimitsByDateRange | Create sell limits by date range |
| Availability | postHurdleRates | Create new hurdle |
| Availability | putHurdleRates | Update existing hurdle |
| Availability | postSellLimitsProcess | Initiate asynchronous sell limit process |
| Availability | getSellLimitsProcessStatus | Check status of sell limits process |
| Availability | getSellLimits | Retrieve sell limit results |
| Availability | startHurdleRatesProcess | Initiate asynchronous hurdle rates process |
| Availability | getHurdleRatesProcessStatus | Check status of hurdle rates process |
| Availability | getHurdleRates | Retrieve hurdle rates results |
| Rates | postRatePlan | Create new rate headers |
| Rates | putRatePlan | Update existing rate header |
| Rates | setDailyRatePlanScheduleRange | Set flat pricing for rate plans |
| Rates | postRatePlanSchedules | Create new season/pricing schedule |
| Rates | getRatePlanSchedules | Retrieve existing pricing schedules |
| Rates | deleteRatePlanSchedules | Delete pricing schedules |
| Rates | startSetDailyRateLansSchedulesProcess | Initiate asynchronous batch rate updates |
| Rates | getSetDailyRatePlanSchedulesProcessStatus | Check status of batch rate updates |
| Rates | getSetDailyRatePlanSchedules | Retrieve batch rate update results |
| Reservations | getReservation | Pull full details of reservation |
| Reservations | putReservation | Modify existing reservation |
| Reservations | postReservation | Create new reservation |
| Reservations | postCancelReservation | Cancel reservation |
| Reservations | deleteReservationPackage | Delete non-room package from reservation |
| Reservations | postCombineShareReservations | Create Share reservation |
| Reservations | deleteShareReservation | Break Share reservation |
| Reservations | postReservationLinks | Create reservation link |
| Reservations | deleteReservationLinks | Break reservation link |
| Deposits | postDepositPayment | Post standard deposit |
| Deposits | postDepositFolio | Post advanced deposit |
| Groups | getChangesByDateTime | Retrieve list of blocks needing update |
| Groups | getBlock | Retrieve block/group details |
| Groups | putBlock | Update group block |
| Groups | postBlock | Create new group block |
| Groups | postBlockRestrictions | Set restrictions on group block |
| Groups | getBlockStatusCodes | Retrieve list of block status codes |
| Groups | putBlockStatusCode | Update status on group block |
| Groups | putBlockAllocationRange | Update group allocation records |
| Groups | startBlockAllocationProcess | Initiate asynchronous group allocation update |
| Groups | getBlockAllocationProcessStatus | Check status of asynchronous group allocation update |
| Groups | getBlockAllocation | Retrieve results of allocation updates |
Table 17-2 List of Business Events supported
| Business Area | API Operation Name | Business Purpose |
|---|---|---|
| Availability | Summary Total | DVMs provided for Room Type, Rate Code |
| Housekeeping | New Out Of Order | DVMs provided for Room Type, Rate Code |
| Housekeeping | Update Out Of Order | DVMs provided for Room Type, Rate Code |
| Rate | Restrictions | DVMs provided for Room Type, Rate Code |
Note:
Check Enable DVM check box for the Properties on External System to include conversions in the get business event payload.Parent topic: Configuring External Systems