HotelX Mapping

The map plugins are used to change the supplier codes to client codes or vice versa. There are these types:

  • Hotel Map 
  • Board Map 
  • Room Map 
  • Rate Map 
  • Amenity Map 
  • Promotion Map

Our map formats share a common structure. In order to load your maps you just need to follow the instructions below:

Entity Maps

File Format

The file should be in the following format:

  • Encoding: UTF-8

  • File Name: [Context Source]_[Context Destination]_[entity]_map.csv

    • Context Source: it corresponds to the client code

    • Context Destination: it corresponds to the supplier code

    • 1 file for each supplier

  • Header Row: Code Source, Code Destination

    • Context Source: it corresponds to the client codes

    • Context Destination: it corresponds to the supplier codes

  • Delimiter: Comma (“,”)

  • Directory: /F[folder code]_[unique code]/HotelX_[unique code]/Maps/[entity]/

File Names

All map files must have the same name structure as follows - you need create a file for Context Destination

Entity File Name
Hotel [Context Source]_[Context Destination]_hotel_map.csv
Board [Context Source]_[Context Destination]_board_map.csv
Room [Context Source]_[Context Destination]_room_map.csv
Rate [Context Source]_[Context Destination]_rate_map.csv
Amenity [Context Source]_[Context Destination]_amenity_map.csv
Promotion [Context Source]_[Context Destination]\promotion_map.csv

Directories

Entity File Name
Hotel /F[folder code]_[unique code]/HotelX_[unique code]/Maps/Hotel/
Board /F[folder code]_[unique code]/HotelX_[unique code]/Maps/Board/
Room /F[folder code]_[unique code]/HotelX_[unique code]/Maps/Room/
Rate /F[folder code]_[unique code]/HotelX_[unique code]/Maps/Rate/
Amenity /F[folder code]_[unique code]/HotelX_[unique code]/Maps/Amenity/
Promotion /F[folder code]_[unique code]/HotelX_[unique code]/Maps/Promotion/

Sample Files

Let’s suppose we have the following client code and supplier code, then we need to create one file for each supplier we have:

  • Client code: GUE

  • Supplier Code: BVJ

Name: GUE_BVJ_hotel_map.csv

Code Source, Code Destination
10,c11\#10
10000,7604
10000,1274249

How to use mapping

Nowadays, mapping can be used in Booking-Flow and Content APIs.

Use in Booking-Flow

There are two ways of using mapping in Booking-Flow: * If the context used in the query is different from supplier/s context that are used in the operation. In that case, HotelX will try to map all entities(hotel, board, etc.)(but amenities and promotions) to query’s context. * If the mapping plugin is requested (only boards, amenities and promotions), only entities requested in the query will be tried to map.

Context in plugins via parameters You can also specify a context for each of the plugins you’ll use in your query. This context will be the context in which you want to map the supplier codes. To do so, you’ll only need to specify it via parameters. This context, if specified, will have priority over the context specified via settings in your query. This in an example:

{
    "plugins": {
        "step": "RESPONSE_OPTION",
        "pluginsType": [
            {
                "type": "BOARD_MAP",
                "name": "board_mapX",
                "parameters": [
                  {
                    "key": "context",
                    "value": "yourContext"
                  }
                ]
            }
        ]
    }
}

Important: Mapping in booking-flow is only usable in Search service.

Here you have the nodes where you can find mapped codes in Search response:

Hotel: search.options[].hotelCode (hotelCodeSupplier will contain the hotel’s code in supplier’s context)
Board: search.options[
].boardCode (boardCodeSupplier will contain the board’s code in supplier’s context)
Room: search.options[].rooms[].code (supplierCode will contain the room’s code in supplier’s context)
Rate: search.options[].rooms[].ratePlans[].code (supplierCode will contain the rate plan’s code of the room in supplier’s context)
Amenity: search.options[
].amenities[*].code and/or inside rooms*
Promotion: search.options[*].promotionCode (promotionCodeSupplier will contain the promotion’s code in supplier’s context)

Examples of plugin that executes board and/or amenity mapping:

Boards:

{
    "plugins": {
        "step": "RESPONSE_OPTION",
        "pluginsType": [
            {
                "type": "BOARD_MAP",
                "name": "board_mapX"
            }
        ]
    }
}

Amenities:

{
    "plugins": {
        "step": "RESPONSE_OPTION",
        "pluginsType": [
            {
                "type": "AMENITY_MAP",
                "name": "amenity_mapX"
            }
        ]
    }
}

Promotions:

{
    "plugins": {
        "step": "RESPONSE_OPTION",
        "pluginsType": [
            {
                "type": "PROMOTION_MAP",
                "name": "promotion_mapX"
            }
        ]
    }
}

Use in Content

The use of mapping plugin in Content is entirely different from Booking-Flow. Nowadays only is available in Hotel-List query and only amenity map are available. In order to request mapping in content (other entities mapping could be available in future), it is necessary to query the node mappings stored inside the entity: This node is a list of mappings that will store the code of the entity in supplier context and the context of the supplier. Also, is necessary to indicate the group code and destination context in query variables.

How to request inside Hotel-List for amenities:

 allAmenities(mapOptions: [{ groupCode: $amenitiesGroupCode, context: $amenitiesContext }]) {
              edges {
                node {
                  amenityData {
                    amenityCode
                    mappings {
                      context
                      code
                    }
                  }
                }
              }
            }

MapOptions is a list of pair {groupCode, destinationContext}.The groupCode is the HotelX groups assigned to you (HotelX_…),
and the destinationContext is the context you want to receive the codes
For each pair in this list, the mapping will be applied for each amenity.
In other words, Hotel-List will change amenityCode to the context set in destinationContext

Other Maps

Room map by provider hotel

This plugin allows to convert the room codes in supplier context but by the hotel. Is the same plugin (room map) explained before, but it offers the possibility to map by supplier and hotel.

Format File

The file must be in the below format:

  • Encoding: UTF-8 
  • File Name: [Context Source]_[Context Destination]_room_map.csv
  • Header Row: Code Source,Code Destination
  • Directory: /F[folder code]_[unique code]/HotelX_[unique code]/Maps/

If you are using a file of room map, is necessary you modify this file adding a new column. Please, see the next example down:

Sample File

Name: xtg_provider_room_map.csv Data:

Code Source,Code Destination,Code Hotel
1,X,A
1,Y,A
1,Z,A
2,X1,B
2,X2,C
3,X3,D
4,X4,
5,X5,

How you can see, in the same file are combined maps with 3 values and maps with 2 values. The rows with two values are mapped by provider. The files with three values are mapped by provider and hotel. Is possible to use only the mapping by provider hotel, in this case, your file only has rows with three values.

How applies

What happens if you use the combined plugin (room map and room map by provider hotel)? In this case, all the rooms with provider hotel map will be mapped to your context (the context put in the first value of file’s name (client context)) and the room codes that don’t have provider hotel map, will be mapped with provider map code (in case that exist). If no map codes are found, the option can be discarded (this rule is configurable).

Execution example

{
    "plugins": {
        "step": "RESPONSE_OPTION",
        "pluginsType": [
            {
                "type": "ROOM_MAP",
                "name": "room_map",
                "parameters":[{"key":"hotel", "value":"true"}]
            }
        ]
    }
}

Default Codes

This feature allows to set a default code for each code in the source (provider) context. The entities that can have default codes are:

  • Board
  • Room
  • Rate
  • Amenity
  • Promotion

Important: this feature only must be used in Booking-Flow. Only one default code can be assigned to each supplier context.
In order to use this feature, it is necessary to append the default code to the FTP.

Example file with default code

File name: sourceContext_destinationContext_entity_map.csv

Code Source, Code Destination
10000,7604
10000,1274249
MY_DEFAULT_CODE,*

MY_DEFAULT_CODE is the code that will be returned in response.

In the example above, all the codes of entity “entity” of provider with context destinationContext that not be found in the file, will be MY_DEFAULT_CODE in response.

Remember that, if you do not use default codes, in case that a mapping is not found, and the option is not discarded, in the response you will receive:

code: codeInSupplierContext
supplierCode: codeInSupplierContext

This feature is useful for controlling not mapped codes, and in case that you use aggregation plugins, all this options will be grouped in the same group and discarded.

Modifying data through FTP

Once mapping files are loaded, we can perform the following operations on them:

Updating data

We have two options:

  1. Reprocessing the same data by renaming the file and just removing “_processed”.
    Example: SourceContext_DestinationContext_entity_map_processed.csv –> example.csv
  2. Changing the data by deleting the processed file and uploading a new one with new information.

Deleting data

Uploading a new file only with headers (no information).

Code Source, Code Destination