ubp-crs-adapter

UBP CRS Adapter

This project provides a JS module to enable an web-application to communicate with a CRS (TOMA, SABRE, CETS, ...).

Interface

After loading the script into your application

<script src="[path/to/script/ubpCrsAdapter.min.js]"></script>

you are able to create a new adapter via:

var ubpCrsAdapter = new UbpCrsAdapter.default(adapterOptions);

and to connect to a CRS via:

ubpCrsAdapter.connect(connectionType, connectionOptions);

When you are connected you can get the data from the CRS via:

ubpCrsAdapter.getData().then(data => {});

or set data to the CRS via:

ubpCrsAdapter.setData(data);

And also you can close the opened frame in the CRS:

ubpCrsAdapter.exit()

note: every method returns a promise

Supported adapterOptions

name	default value
debug	false
useDateFormat	'DDMMYYYY' (according to momentjs date format)

Supported connections

Currently this module supports the connection to following CRS:

CRS	connectionType	connectionOptions
CETS	'cets'	-
TOMA (old)	'toma'	.providerKey
Booking Manager	'bm'	-

For some connections you need credentials, which you can set in the connectionOptions.

Data object structure

Following data model is used for the communication with every CRS:

{
    agencyNumber,
    operator,
    numberOfTravellers,
    travelType,
    services,
    remark,
}

Depending on the services[*].type the data structure of a service differs.

Supported service types

service type	CETS	TOMA (old)	TOMA (new)
'car'	X	X
'hotel'		X

type	fields	example
'car'	.vehicleTypeCode	'E4'
	.rentalCode	'DEU85'
	.pickUpLocation	'BER3'
	.pickUpDate	'28122017'
	.pickUpTime	'0915'
	.dropOffLocation	'MUC'
	.dropOffDate	'04012018'
	.dropOffTime	'1720'
	.duration	'9'
	.pickUpHotelName	'Best Hotel'
	.pickUpHotelAddress	'hotel street 1, 12345 hotel city'
	.pickUpHotelPhoneNumber	'[phone]'
	.dropOffHotelName	'Very Best Hotel'
	.dropOffHotelAddress	'hotel drive 34a, famous place'
	.dropOffHotelPhoneNumber	'04031989213'

type	fields	example
'hotel'	.roomCode	'DZ'
	.mealCode	'U'
	.destination	'LAX20S'
	.dateFrom	'20092017'
	.dateTo	'20092017'

Additionally every service has a marked field which is by default falsy. But if this service is either "marked" in the crs or detected as "marked" (depends on the type) it will be true.

Field mapping

Amadeus Toma (old)

CRS field	example	adapter field	example
2	'BA'	action	'BA'
3	'FTI'	operator	'FTI'
4	'BAUS'	travelType	'BAUS'
5	'1'	numberOfTravellers	'1'
13	'X'	services[*].marked	true
30	'remark'	remark	'remark'

for car service

CRS field	example	adapter field	example
14	'MW'	services[*].type	'car'
15	'USA85E4/LAX-SFO1'	services[*].rentalCode	'USA85'
		services[*].vehicleTypeCode	'E4'
		services[*].pickUpLocation	'LAX'
		services[*].dropOffLocation	'SFO1'
16	'0915'	services[*].pickUpTime	'0915'
20	'281217'	services[*].pickUpDate	'28122017'
21	'040118'	services[*].dropOffDate	'04012018'
21	'040118'	services[*].duration	'8'

If car service includes hotel drop off or hotel pick up an extra line is added and the remark field is extended.

CRS field	example	adapter field	example
14	'E'
15	'pick up name'	services[*].hotelPickUpName	'pick up name'
15	'drop off name'	services[*].hotelDropOffName	'drop off name'
20	'281217'	services[*].pickUpDate	'28122017'
21	'040118'	services[*].dropOffDate	'04012018'
21	'040118'	services[*].duration	'8'
30	other hotel infos	services[*].hotelPickUpAddress	'hotel street 1, 12345 hotel city'
		services[*].hotelPickUpPhoneNumber	'[phone]'
		services[*].hotelDropOffName	'Very Best Hotel'
		services[*].hotelDropOffAddress	'hotel drive 34a, famous place'
		services[*].hotelDropOffPhoneNumber	'04031989213'

• .hotelPickUpName overwrites .hotelDropOffName
• the hotel infos in field 30 are structured like that: .hotelPickUpAddress .hotelPickUpPhoneNumber;.hotelDropOffName .hotelDropOffAddress .hotelDropOffPhoneNumber
  • fields which are not provided, will be ommited here
  • if .hotelDropOffName is already used, it will be ommitted here

for hotel service

CRS field	example	adapter field	example
14	'H'	services[*].type	'car'
15	'LAX20S'	services[*].destination	'USA85'
16	'DZ U'	services[*].roomCode	'0915'
		services[*].mealCode	'E4'
20	'200917'	services[*].dateFrom	'20092017'
21	'200917'	services[*].dateTo	'20092017'

Debugging

Sadly the debugging in some CRS is not possible but the adapter nevertheless provides some debugging output - either you set the adapter option .debug to true or you add the parameter "debug" to your URL. It will open an extra window for debug outputs.

How to test ...

... the code

Write a test and execute npm run test - the unit tests will tell you, if everything is fine.

... the adapter

We prepared a test file, which can be opened directly in the CRS systems. The file is located in test/manual folder: crsTest.html

In the CRS you have to be in the step, where you have a "browser view" open - after executing an external search. In that view you can drop the test file and execute the functions of the adapter.