External Service

The External Services Setup is where connection details are entered an setting congifurations entered to allow Tourplan to connect to external reservation or host systems.

External Services are available for Professional and Enterprise licence editions of Tourplan. The connection setting details required in this dialogue are configured when the connection software is installed.

The software required to connect to any external service is additional to a standard Tourplan system. When either the Professional or Enterprise Edition of Tourplan is purchased, the connection setting details required in this dialogue is configured.

The External Product Search functionality can connect to various types of service providers to not only reserve services, but (depending on commercial relationships and availability of systems) use inventory, and dynamic pricing. Current external service connections are available to most accommodation, and rental car systems as well as to remote Tourplan systems. Development of additional system connectors is ongoing.

Create an External Service

  1. Select menu .
    1. Click the Home menu to expand it:

    2. Click the System menu option to expand it:

    3. Click Code Setup to go to the Code Setup menu:

  2. Select menu .
    1. Click the Code Setup menu to expand it:

    2. Click the System menu option to expand it:

    3. Click External Service to open the External Service screen: (any existing records will display)

  3. Click .

  4. On the screen, select a Type, enter a Name and Description.

  5. On the Configuration tab, enter the login credentials in the Login and Password fields.
  6. Enter a URL and any other connection details in the Configuration field.
  7. Check the completed screen.
  8. Click to keep the changes.

  9. Click to discard any changes.

NOTE: After clicking Save, the screen clears, ready for another External Service Connection – continue adding External Service Connection details, or click Exit to close the screen.

 

About External Service Fields

In this example the 'External Payment' option selected in the Type field has exposed the standard fields used for most External Service interactions.

Type

A selection of the applicable External Service types. The type codes are pre-defined and are not user definable or editable. Available options are:

  • CRS/XML - Used for connections to external host computer reservation systems.

  • EPS - A default setting is configured, this setting should not be removed.

  • ESearch - This setting will only be required if advised by your Tourplan Support Team.

  • External Air - Used for PNR import files.

  • External payment - Used for connections to external payment providers.

  • External Supplier - Used for connections to external suppliers - If selected, the 'Configuration' tab options are expanded and the 'Additional' tab is activated. Please see External Service to view the field and tab options.

  • Manual Flight - Used for charter flight external service providers.

Name

A short name of the External Service.

Description

A long description of the External Service.

Login

The login credentials for the External Service.

Password

The Password required for the login credentials used in the Login field.

Password Repeat

The Password required for the login credentials used in the Login field repeated.

Configuration

The URL or any other connection details required to connect to the External Service.

If 'External Supplier' Type is selected

In this example the 'External Supplier' option selected in the Type field has exposed extra fields and activated the Additional tab containing the configuration field which displays the configuration details string.

Connection Details

Endpoint

The endpoint configuration name to use when connecting to the adapter for the external service. This is looked up in the configuration string under the name of the endpoint.

Destination

The destination name in the remote system (blank if not set).

Login

The login credentials for the External Service.

Password

The password required for the login credentials.

Password Repeat

The password required for the login credentials repeated.

 

External Service Status

NOTE: The Status fields offer organisations the ability to select a workflow variation for the displayed external service. If left unassigned the system will use the default INI Setting for external service statuses - for more information on default system settings click on the link EXTERNAL_OK_STATUS (All Users).

OK Status

Search for and select the appropriate external service OK status(s) as configured in 'Code Setup'.

Request Status

Search for and select the appropriate external service Request status(s) as configured in 'Code Setup'.

Cancel Status

Search for and select the appropriate external service Cancel status(s) as configured in 'Code Setup'.

Quote Status

Search for and select the appropriate external service Quote status(s) as configured in 'Code Setup'.

 

General Settings

Enabled

The 'Enabled' checkbox is ticked by default when inserting a new external service connection. This setting enables the external service connection to send external requests.

If the checkbox is blank the external service connection is disabled.

Message Code

NOTE: Defining this field allows organisations to select a specific message type to display necessary information from the message default assigned in the INI Setting ES_MESSAGE_FORMAT (All Users).

Select the appropriate Message Type code for external services as configured in Code Setup. Click here for more information on Message Types.

Service Date From

Enter the earliest arrival date for bookings made via this external system. Manually type the date, use the calendar provided or leave blank for no restrictions.

Service Date To

Enter the latest arrival date for bookings made via this external system. Manually type the date, use the calendar provided or leave blank for no restrictions.

Guarantee

NOTE: This field is required for virtual credit card functionality. If VCC functionality is not enabled this field is left blank.

If organisations use VCC functionality a value is assigned for a Guarantee type from the external supplier. If no guarantee value is found an exception will be thrown.

Rates Source

Select the 'Rates Source' used for external services either Use Internal Rates - rates from the products in the Tourplan system or Use External Rates - rates from the external system.

Product Description

Select the 'Product Description' used for external services either Use Internal Description or Use External Description.

Zero Rates

Select Show or Do Not Show external service 'Zero Rates'.

The Additional Tab

In the Configuration field enter further connection details required to connect to the External Service. This is only required on advice from your local Tourplan Support Team.