Get Started
Tailor-Made ItinerariesTour & Cruise ItinerariesFIT Package ItinerariesRole Guides
Kaptio AdminSupplier ContractingProduct Design/BuildProduct ContentTraining ManagerData ExpertsDevelopersKaptio Platform Architecture
Architecture OverviewDevelopment GuidelinesFunctional DecompositionPlatform FAQNew to Salesforce?Security & ComplianceManage your EnvironmentsData Import & ExportGlobal Platform Setup
Getting Started with Core ConfigurationManage Global SettingsConfigure ChannelsManaging Users, Roles & AccessUnderstanding Your Sample DataPIM: Supplier Contracting
Managing SuppliersSetup LocationsManaging ServicesConfigure PricesBulk Import Service DataManage InventoryPromotion & Discount SetupPIM: Tour & Package Design
Getting Started with PackagesUnderstanding Departure TypesManage Package PricingSetup Package ContentConfigure Package DefaultingCRM Module
Customizing Kaptio TravelManage Account Record TypesSetup Trip & Itinerary WorkflowManage Salesforce FeaturesCONNECT: Land & Air Connectivity
Getting Started with ConnectivityPNR Import Setup & UsageIntegrating Amadeus Hotel Connectivity Setup & UsageDOCS Module
Getting Started: ContentManaging Content & MediaSetup Document StagesSetup TemplatesBuilding Custom Content ComponentsBulk Import Content DataUsing the Document Starter KitUsing the ATOL Certificate Starter KitPersonalizing DocumentsGenerating DocumentsCustomer Access to DocumentsEmail Setup & UsageAdvanced Sample Email TemplateCRS: Training Guides
Getting Started: TrainingTraining Reservation TeamsTraining Finance TeamsPAY: Payment Gateway Integrations
Getting Started: PaymentsImplementing Braintree/PayPalIntegrating Your Own GatewayData Migration
Guide to Booking MigrationPeripheral Integration Guides
Accounting IntegrationData Warehouse IntegrationWebsite IntegrationIntroduction
Travel Agencies that operate flight within the UK are required to provide ATOL certificates to their customers in order to fulfil CAA regulations.
Kaptio has provided a starter kit that provides a generic PDF ATOL Certificate document and logic to generate a certificate for each combination of passengers needed within an Itinerary. Please see the example document below for a case of two couples sharing one flight but then having separate flights within one itinerary.
Installation
The starter kit is an unlocked package, which means you’ll have access to modify the code once installed.
Version | Description | Published Date | Installation link |
1.0 | ATOL Certificate with sorting by passenger groups | November 15, 2022 | https://login.salesforce.com/packaging/installPackage.apexp?p0=04t7Q0000005eL0QAI |
Please note: Kaptio will never update the starter kit on a customer environment without a request from the customer. The kit will be continously updated but these updates will not be pushed out automatically. Due to this, the description in this document may differ from your version.
General Business Flow
The current version of the ATOL Certificate Starter Kit does not come with any workflows out of the box to define when an ATOL document is to be generated or how it should be delivered.
The only pre-requisite for a ceritificate to be generated is that an Itinerary has flight. Within the code there are snippets available to narrow this scope but since this may be dependent on each customer’s setup, this is not applied by default.
It is assumed that when this starter kit has been installed, each customer will create their own process and business flows around when to generate a certificate and how to deliver it.
Recommended Use
Document Setup
The starter kit provides a Custom Metadata Type (CMT) object called “KTATOL Settings” and a single record for default settings. These will need to be configured before certificates can be issued.
In KTATOL Settings you can define the Company name and ATOL Number that will appear on the document, as well as defining which Channels the current CMT record should apply to by adding a comma separated list of Channel codes.
For example, the value “B2CUS, B2BUS, GTUS” would define the record applying to three channels with the channel code B2CUS, B2BUS and GTUS.
Please note: Leaving the channel field empty will apply the values of that record to all channels which don’t have a record that include their channel code. This can be useful if you only need one record.
Reviewing a Certificate
The simplest way to review a document is to set up a custom formula field with the following attributes and adding it to your Itinerary layouts where applicable:
- Data Type: Formula
- Formula Return Type: Text
- Formula:
HYPERLINK('/apex/KTATOL_Certificate?id='+Id, 'View ATOL Certificate', '_blank')
Please note that this is an internal link, which customers cannot see without login access. If your process is to manually download and send these to your customers, this link will serve that purpose.
Making the certificate available externally
In the case that the certificate is to be delivered directly to a customer, via email or some type of portal, an external link will need to be generated.
For this to happen the custom formula field above or a separate field can use the following formula:
HYPERLINK( $Setup.KaptioTravel__AppSettings__c.KaptioTravel__CustomerFacingUrl__c + 'c__KTATOL_Certificate?id='+Id, 'View ATOL Certificate', '_blank')
Please note: this version will require updates to the External Sites user’s permissions to be able to read the components provided in this starter kit.
Starter Kit Components
Following is the component list for the starter kit. All files will follow the KTATOL_ prefix naming conventions to denote Kaptio Travel’s ATOL Certificate starter kit
Please note that this list may evolve with future updates.
Codeturned_in
FILE | ROLE | TYPE | |
1 | KTATOL_CertificateController | Main controller for the certificate logic | Apex class |
2 | KTATOL_CertificateControllerTest | Unit test for the starter kit | Apex class |
3 | KTATOL_CertificateControllerTestHelper | Data creation class for unit tests | Apex class |
4 | KTATOL_CertificateHelper | Helper class | Apex class |
5 | KTATOL_CertificateService | Service functions | Apex class |
6 | KTATOL_Certificate | Certificate output | Visualforce page |
Static Resources
Static resources are files that can be referenced in documents. With this starter kit, Kaptio provides a static resources called KTATOL_Assets.
Please note: The static resource is a zip file which can be worked on directly in an IDE that runs the SFDX:CLI. We recommend this approach rather than include inline CSS or using Visualforce pages as CSS containers.
For information on how to set these up, please see the Quick Start: Visual Studio Code for Salesforce Development trailhead
FOLDER | FILES/SUBFOLDERS | DESCRIPTION | |
1 | CSS | Style.css | Style documents for the layout.Note: Some elements are defined during runtime via JS |
2 | Images | backgroundLogo.png | Contains any relavant images |
Custom Metadata Types
CMT’s are customizable, deployable, packageable, and upgradeable application metadata. In the starter kit we provide a single custom metadat type which contain configuration settings that can be applied to one or many layouts.
Please note that this list may evolve with future updates.
A | B | C | |
1 | Metadata Type | Description | Included records |
2 | KTATOL Setting | General settings for a layout. Can be assigned to channels and document types if required. | Default |
KTATOL Settings fields
A | B | C | D | |
1 | Field | API Name | Type | Description |
2 | ATOL Number | ATOL_Number__c | Number | The ATOL Number displayed on certificates generated using this setting record |
3 | Channels | Channels__c | Text | Allows user to enter a comma separated list of channel codes to which the setting record should apply to. Empty field sets the record as the default. |
4 | Company Name | Company_Name__c | Text | The Company name displayed on certificates generated using this setting record |