User Manual: e-Commerce Backoffice > Configurations V1.0
- 1 Goal
- 2 Sign In
- 3 Considerations
- 4 Section: Search Flight
- 4.1 Sub-section: Type of Journey
- 4.2 Sub-Section: Airports’ names
- 4.3 Sub-Section: Country Settings
- 4.4 Sub-section: Non Distributed Routes
- 4.5 Sub-section: Cookies and privacy policy
- 4.6 Sub-section: Display logic by device
- 4.7 Sub-section: Temporary messages
- 4.8 Sub-section: Promo codes
- 4.9 Sub-section: Passenger Type
- 5 Sección: Flight results
- 6 Section: Traveller details
- 7 Section: Extra services
- 8 Section: Purchase
- 9 Section: End of flow
- 10 Section: Summary
Goal
The goal of this manual is to provide the instructions required to complete the configuration of the reservations flow backoffice.
Sign In
Access will be provided by KIU, including links, user Id and password.
Considerations
The structure in the Backoffice settings is divided in:
Sections: every screen within the reservations flow is a section.
Modules: every section shall contain 2 modules:
Configurations Module: Here the airline’s admin user will be able to control establish the setting parameters for the Internet Booking Engine.
Translations Module: Here the airline’s admin user will be able to manage, through labels, the texts to be shown on the frontend of the reservations flow (more info in User Manual: e-Commerce Backoffice > Translations V1.0). Labels' characteristics::
Labels are usually small caps or lowercase text separated by “_” (underscore);
They cannot be deleted;
They represent text shown to the passenger on the frontend of each screen within the reservations flow.
These labels may have multiple languages associated according the airline’s requirement. New languages need to be requested to KIU.
The airline’s admin user will be able to assign the correspondent translation to each label.
Images are for sample purposes.
Section: Search Flight
Sub-section: Type of Journey
This sub-section contains the configuration for the tabs in the search box.
Category | Values | Description/Function | Validation |
---|---|---|---|
Type of Journey |
| This category is informational, there is no functionality. | No validation. |
Status |
| By setting the element to “On” (green) the category “Type” will be displayed on the screen as a new tab. At least one type must be enabled (On - green). | No validation. |
Default |
| The selected type of journey will be displayed to the passenger by default. At least one type of journey must be selected (Purple circle) | No validation. |
Translation | Input alphanumeric free text. |
| Up to 255 characters. |
Sample image of the screen displayed to the passenger:
Sub-Section: Airports’ names
This sub-section allows to customize the name of the airports to be displayed to the passenger.
Category | Values | Description/Function | Validation |
---|---|---|---|
Airports | Input alphanumeric characters. | The airport that needs to be modified must be entered here. | At least 3 characters |
Nombre del aeropuerto | Input alphanumeric characters. | The text entered here will be displayed to the passenger. | Up to 25 characters |
Sub-Section: Country Settings
This sub-section allows to create records in order to configure different sales options enabling the airline to present to the passenger all “Flight Search” options within a single screen. In order to create these records, the following informations is required:
Category | Values | Description/Function | Validation |
---|---|---|---|
Description | Input alphanumeric characters | The text will be displayed in a dropdown list for the passenger to select the correspondent/desired option. | 25 alphanumeric chracters. |
ISO County Code | Input alphabetic characters | The ISO code of the sales country needs to be configured. | Mandatory field. 2 alphabetic characters. |
Currency Code | Input alphabetic characters | The ISO code of the sales currency needs to be configured. This code will be displayed all through the reservations flow, i.e. USD. | Mandatory field. 3 alphabetic characters |
Currency Name | (configuration not available) | (configuration not available) | (configuration not available) |
Device ID | Input alphabetic characters | Set the KIU RES device number from which reservations will be created. Remember to send an email to webservices@kiusys.com in order to enable the chosen device; otherwise, it will not be ready to use. | Mandatory field. 10 alphanumeric characters |
User ID | Input alphanumeric characters | Set the KIU RES user ID that will be used to create reservations. The “NEW USER ID” value from the HB* transaction in KIU RES must be used. | Mandatory field. 9 alphanumeric characters |
Default |
|
| No validation. |
Enable |
|
| No validation. |
Sample image of the screen displayed to the passenger:
Sub-section: Non Distributed Routes
This sub-section contains the configuration of the routes that need to be excluded from the distribution through this sales channel.
Category | Values | Description/Function | Validation |
---|---|---|---|
Origin | Input airport code. | The origin airport code of the excluded route must be included. | No validation. |
Destination | Input airport code | The destination airport code of the excluded route must be included. | No validation. |
Date from | Input date. | The start date of the exclusion must be included. | dd/mm/yyyy |
Time from (currently not available) | Input time. | The start time of the exclusion must be included. | hh:mm 24hs format |
Date to | Input date. | The end date of the exclusion must be included. | dd/mm/yyyy |
Time to (currently not available) | Input time. | The end time of the exclusion must be included. | hh:mm 24hs format |
Sub-section: Update new routes
Whenever a new country setting is configured or a new flight, route, or frequency is added in KIU RES, this process needs to be run in order to include the new flight informaiton in the selection boxes of Search Flight.
Category | Values | Description/Function | Validation |
---|---|---|---|
Button | Not applicable | Click on the button in order to start the process. | No validation. |
Sub-section: Cookies and privacy policy
This sub-section allows the configuration of the message to be displayed for usage of cookies and/or privacy policies and/or any message considered applicable.
Category | Values | Description/Function | Validation |
---|---|---|---|
Activate |
|
| No validation. |
Confirmation button |
|
Note: We recommed informing the passenger that by moving forward in the reservations flow they are accepting the usage of Cookies. Therefore, by accepting, or closing the message and/or continuing with the process, the passenger is accepting the conditions. | No validation. |
Message text | Input enriched text. | Text that will be displayed to the passenger. Free text may be included using different formats and including hyperlinks. | Up to 600 characters allowed. |
Sample image of the screen displayed to the passenger:
Sub-section: Display logic by device
This sub-section contains the parameters that will be enalbed for origin and destination search options depending on the device used by passenger.
Category | Values | Description/Function | Validation |
---|---|---|---|
Type |
| These values or search parameters correspond to the way the passenger will be able to search for origin and destinations.
| No validation. |
Mobile |
|
| At least one type/parameter must be enabled. |
Tablet |
|
| At least one type/parameter must be enabled. |
Desktop |
|
| At least one type/parameter must be enabled. |
Sub-section: Temporary messages
This sub-section allows the configuration of warning messages that want to be displayed to passengers, i.e. rescheduling due to weather.
First, the color of the warning must be selected.
Category | Values | Description/Function | Validation |
---|---|---|---|
Set message type (currently not available) | Dropdown list. | The options displayed in the list correspond to the type of message and colors to be included in the background of the warning message. | At least one option must be selected. |
Then the message will be configured.
Category | Values | Description/Function | Validation |
---|---|---|---|
Enable |
|
| No validation. |
Show date and time |
|
| No validation. |
Calendar | Time and date may be selected. | The selected time and date will be included in the message. | Mandatory field if the previous checkbox is active No validation. |
Name | Input alphanumeric characters. | The warning name is just for setting purposes. It iwll not be displayed within the warning message. | Mandatory field. |
Message title | Input alphanumeric characters. | If a title is defined, it will be included in the warning message. | Optional field. Up to 150 alphanumeric characters. |
Message | Input free text. | This is the text that will be displayed in the warning message. | Optional field. Up to 450 alphanumeric characters. |
Sample image of the screen displayed to the passenger:
Sub-section: Promo codes
This sub-section will enable within the Search Flight screen a box for the passenger to optionally include a promo code given by the airline for special discounts.
In order to configure the correspondent promo codes please follow the instructions in TourCode: quotation and issuance .
Category | Values | Description/Function | Validation |
---|---|---|---|
Enable |
|
| No validation. |
Sample image of the screen displayed to the passenger:
For the moment, this option will apply the correspondent discount associated to the Promo Code all through the reservation flow (fare display, fare quotation and payment). In an upcoming version, we will be working on giving feedback to the passenger (confirmation that his promo code has been applied and the detail of the given discount).
Sub-section: Passenger Type
This sub-section allows the configuration of the passenger types available to create reservations.
Category | Values | Description/Function | Validation |
---|---|---|---|
Code | Dropdown list
| The passenger type (PT) to be added must be selected. | Mandatory field. No validation. |
Type of passenger | Se debe incorporar | The passenger type (PT) or passenger type code (PTC) must be incdicated. | Mandatory field. No validation. |
Max quantity | Input positive numbers. | Maximum number of passenger types that may be accepted in one reservation. | At least 1 must be configured as maximum. |
Enable |
|
| No validation. |
Sección: Flight results
Sub-section: Minimum purchase time
This sub-section contains the configuration for the minimum time that reservations are enabled through this channel before flight departure.
Category | Values | Description/Function | Validation |
---|---|---|---|
Minutes | Input positive numbers. | Flights departing within the range of the selected number of minutes will not be offered for selection through this sales channel. | At leaset “1” must be included. |
Sub-section: Search results preference
This sub-section allows the configuration of the maximum number of connections to be offered to the passenger.
Category | Values | Description/Function | Validation |
---|---|---|---|
Origin | Input airport code. | The origin of the route to be configured must be entered. | No validation. |
Destination | Input airport code. | The destination of the route to be configured must be entered. | No validation. |
Connections | Input positive numbers. | The maximum number of connections to be displayed to the passenger must be configured. | It may be zero (0). |
Sub-section: Price displaye (currently not available)
This sub-section allows the configuration of the values to be included in the fare detail.
Category | Values | Description/Function | Validation |
---|---|---|---|
Configuration |
| The selected option will modify the fare details shown to the passenger. | No validation. |
Sub-section: Carrousel
This sub-section allows to enable the Carrousel view.
Category | Values | Description/Function | Validation |
---|---|---|---|
One Way |
|
| No validation. |
Return Flight |
|
| No validation. |
Price |
|
| The carrousel must be enabled for at least one of the previous options. |
Sample image of the screen displayed to the passenger:
Sub-section: Sold out fares
This sub-section allows to configure how to display sold out fares.
Category | Values | Description/Function | Validation |
---|---|---|---|
Translation box | Input alphanumeric characters. | The text entered here will be displayed in the flight results grid. | Up to 255 characters. |
Show amount of sold out fare |
|
| No validation. |
Show amount of sold out fare strikethrough |
|
| This option is available only when the “Show amount of sold out fare” is enabled. |
Sample image of the screen displayed to the passenger:
Subsection: Message at the bottom of the screen
In this subsection you will be able to configure a message at the bottom of the screen
Category | Values | Description/ function | Validation |
---|---|---|---|
Enable |
|
| No need for validation |
Enable check-box |
|
| No need for validation |
Text Box | Enter rich text content and images | Text that will be shown at the bottom of the screen You may enter text, format, links / hyperlinks and images | Up to 2000 characters |
Section: Traveller details
Sub-section: Type of contact
This sub-section allows the configuration of the contacts to be required from passenger.
Category | Values | Description/Function | Validation |
---|---|---|---|
Emergency contact |
|
| No validation |
Contact at destination |
|
| No validation. |
Sample image of the screen displayed to the passenger:
Subsection: List of countries
In this subsection you may establish the order in which the list of countries will be displayed in the “Country” field, in the form that appears at the Passenger’s Information web page.
Category | Values | Description/ function | Validation |
---|---|---|---|
Text Box | Enter alphabetic characters |
| No need for validation |
Sub-section: Form of Identification (FOID)
This sub-section allows to configure the document types (more info in Manual de Usuario Reservas | ManualdeUsuarioReservas FOID(DocumentodeIdentidad) ) to be offered to the passenger as options. It allows to:
Enable the document types to be included as options to the passenger.
Configure the text to be shown to the passenger.
Category | Values | Description/Function | Validation |
---|---|---|---|
Type | Not configurable.
| All available document types are included. | No validation. |
Status |
|
| At least one document type must be enabled. |
Translation | Input alphanumeric characters. | The text entered here will be shown to the passenger within the list of available document types. If no translation is included the default or label will be shown. | Up to 255 characters. |
Sample image of the screen displayed to the passenger:
Sub-section: Frequent Flyer
This sub-section allows to enable and configure the frequent flyer programs that will be made available for passenger to include their information.
Firstly, there is the option to enable the frequent flyers box in the traveller details screen.
Category | Values | Description/Function | Validation |
---|---|---|---|
Enable |
|
| No validation. |
Then, the specific frequent flyer programs must be defined in order to be given as options for the passenger.
Category | Values | Description/Function | Validation |
---|---|---|---|
Airline code | Alphanumeric characters | The airline’s IATA code must be entered here for configuration. | Up to 2 characters. |
Program name | Alphanumeric characters | The frequent flyer program name must be entered here. This is the text that will be displayed to the passenger as options for completing frequent flyer information. | Up to 25 characters. |
Sample image of the screen displayed to the passenger:
Sub-section: SSR DOCx
This sub-section allows the configuration of the routes that will require the passenger to complete SSR DOCx information. The traveller details screen will require information in addition to personal data.
Category | Values | Description/Function | Validation |
---|---|---|---|
Origin | Input airport code | The origin of the correspondent route must be entered. | No validation. |
Destination | Input airport code | The destination of the correspondent route must be entered. | No validation. |
Enable: SSR DOCS |
|
| No validation |
Enable: SSR DOCO |
|
| No validation. |
Enable: SSR DOCA |
|
| No validation. |
Sample image of the screen displayed to the passenger, DOCs:
Sample image of the screen displayed to the passenger, DOCO:
Sample image of the screen displayed to the passenger, DOCA;
Sub-section: Types of document for SSR DOCS
This sub-section allows the configuration of the document types that might be accepted for SSR DOCS elements. It allows to:
Enable the documents that want to be offered as options to the passenger.
Configure the text that will be shown to the passenger for each document type.
Category | Values | Description/Function | Validation |
---|---|---|---|
Type | Not configurable.
| This column shows the available document types that might be offered to passenger. | No validation. |
Status |
|
| At least one type of document must be enabled. |
Translation | Input alphanumeric characters | The text entered here will be displayed to the passenger. If no information is included, the default or the label will be shown. | Up to 255 characters. |
Subsection: Message at the bottom of the screen
In this subsection you will be able to configure a message at the bottom of the screen
Category | Values | Description/ function | Validation |
---|---|---|---|
Enable |
|
| No need for validation |
Enable check-box |
|
| No need for validation |
Text Box | Enter rich text content and images | Text that will be shown at the bottom of the screen You may enter text, format, links / hyperlinks and images | Up to 2000 characters |
Section: Extra services
Sub-section: Extra Services
This sub-section allows to define the name to be displayed for the extra services offered.
Category | Values | Description/Function | Validation |
---|---|---|---|
Extra Service Code | Input alphanumeric characters | The label shown in the Extra Services screen must be entered here. | Between 1 and 50 characters |
Name | Input alphanumeric characters | The name given to extra service will be displayed on the Extra Services screen. | Up to 70 characters |
Section: Purchase
Sub-section: VAT information
This sub-section allows to configure a message to be displayed to the passenger when fiscal / VAT information is requested.
Category | Values | Description/Function | Validation |
---|---|---|---|
Enable |
|
| No validation. |
Text box | Input free text | The message to be displayed to the passenger must be entered here. | Up to 500 characters. |
Sample image of the screen displayed to the passenger:
Sub-section: Fiscal information
This sub-section allows to enable the requirement of fiscal information. If the passenger completes this data, it will be included in the e-ticket.
Firstly, the section allows to configure if Business Name is displayed or not, whether it is mandatory or not, and the field’s name to be shown. In the passenger’s e-ticket, the business name will be included in the endorsement text.
Category | Values | Description/Function | Validation |
---|---|---|---|
Enable |
|
| No validation. |
Required |
|
| No validation. |
Translation box | Input alphanumeric characters. | The title of the “busines name” box that will be displayed to the passenger must be entered. | Up to 25 characters. |
Then, it is possible to configure the display, requirement and name of the fiscal key.
Category | Values | Description/Function | Validation |
---|---|---|---|
Enable |
|
| No validation. |
Requried |
|
| No validation. |
Translation box | Input alphanumeric characters. | The title of the “fiscal key” box that will be displayed to the passenger must be entered. | Up to 25 characters. |
Finally, it is possible to configure the accepted type/s of fiscal key and their validations. In the passenger´s e-ticket the fiscal key information will be included in the VAT field with the fiscal key name chosen and the details according to the configured valdiation.
Category | Values | Description/Function | Validation |
---|---|---|---|
Type of fiscal key | Input alphanumeric characters. | The type of fiscal key available must be entered here. | Up to 25 characters. |
Value type | Dropdown list
| This value type will be used for validation when the passenger enters fiscal information.
| At least one option must be selected. |
Minimum | Input positive numbers. | This is the minimum number of characters that will be used for validation when the passenger enters fiscal information. | At least 1 character must be set as minimum. |
Maximum | Input positive numbers. | This is the maximum number of characters that will be used for validation when the passenger enters fiscal information. | At least 1 character must be set as maximum. |
Sample image of the screen displayed to the passenger:
Subsection: Message at the bottom of the screen
In this subsection you will be able to configure a message at the bottom of the screen
Category | Values | Description/ function | Validation |
---|---|---|---|
Enable |
|
| No need for validation |
Enable check-box |
|
| No need for validation |
Text Box | Enter rich text content and images | Text that will be shown at the bottom of the screen You may enter text, format, links / hyperlinks and images | Up to 2000 characters |
Section: End of flow
Sub-section: Button
This sub-section allows to configure the button at the end of the End pf flow screen in order to define where the passenger wants to be redirected after completing the reservation flow.
Category | Values | Description/Function | Validation |
---|---|---|---|
Translation box | Input alphanumeric characters | The text to be shown in the button must be entered here. | Up to 255 characters. |
Link | Input text. | The URL where passenger will be redirected must be entered here. | No validation. |
Section: Summary
Sub-section: Terms and conditions
This sub-section allows to enable and configure a message that requires passenger acceptance. This message will be displayed in the flight results screen. By configuring this message, the passenger will have to accept the terms and conditions before moving forward with the reservation/purchase flow.
Category | Values | Description/Function | Validation |
---|---|---|---|
Enable |
|
| No validation. |
Translation box | Input alphanumeric characters. | The text to be shown to the passenger must be entered here. | Up to 70 characters. |
Translation box | Input alphanumeric characters. | The text to be seen as a link must be entered here. | Up to 50 characters. |
Translation box | Input alphanumeric characters. | Terms and conditions must be entered here. This text will be shown when passenger enters the previous link. | Up to 5000 characters. |
Sample image of the screen displayed to the passenger:
Sub-section: Taxes
This sub-section allows to add the tax codes in order to give them a specific denomination. If no text is included, the IATA tax code will be displayed to the passenger.
Category | Values | Description/Function | Validation |
---|---|---|---|
Tax code | Input alphanumeric characters. | The tax IATA code must be entered here. | Up to 2 characters. |
Name | Input alphanumeric characters. | The tax name that will be displayed to the passenger must be entered here. | Up to 50 characters. |
Tax configurations apply within Ecommerce on “Summary” as well as the final screen on “Price Detail” section.
Sub-section: Fees and Surcharges
This sub-section allows to add the fee codes in order to give them a specific denomination. If no text is included, the fee name in KIU RES (TX*FEE/*) will be displayed to the passenger.
Category | Values | Description/Function | Validation |
---|---|---|---|
Fee code | Input alphanumeric characters. | The fee code must be entered here. | Up to 5 characters. |
Name | Input alphanumeric characters. | The fee name that will be displayed to the passenger must be entered here. | Up to 50 characters. |
Fees and Surcharges configurations apply within Ecommerce on “Summary” as well as the final screen on “Price Detail” section.