Using the Document Starter Kit

Get Started

Role Guides

Kaptio Platform Architecture

Global Platform Setup

PIM: Supplier Contracting

PIM: Tour & Package Design

CRM Module

CONNECT: Land & Air Connectivity

DOCS Module

CRS: Training Guides

PAY: Payment Gateway Integrations

Data Migration

Peripheral Integration Guides

A key function of Kaptio Travel (KT) is to facilitate the delivery of branded documents from multi-day tour operators and their customers. To allow for maximum flexibility of the document setup and branding, Kaptio provides this Documents Starter Kit which contains a base setup of documents with code examples, which can either be used as-is or used as a foundation/examples for custom documents.

This document provides specifications of what, when and how data is made available for Documents for delivery to the customer as well as provides detailed insight into where key data is stored in the Kaptio system and how it’s applied within the Document Starter Kit

General Business Flow

An example of the high-level business flow describing document generation in Kaptio is described below.

The content manager has a wide range of configuration options when it comes to documents. Each channel defines which document types it uses (currently labelled Stages) and one or more document templates can be defined for each document type. These are used to define which data to pull into a document and the behaviour of documents, such as actions presented to customers on the document, expiration date and email template used to deliver the document.

All documents can be presented as online documents and/or PDF.

When generating a document, an example business flow is as follows:

• An Agent or direct customer contacts a sales consultant to create a trip and produce one or more itineraries
• The sales consultant composes a trip and one or more itineraries.
• The sales consultant manually generates an Itinerary Document (Proposal) which will pull in content articles from services, locations and other relevant entities, and data defined for the document type and channel based on the selected Template. Supported document types are:
• Proposal
• Booking Confirmation
• Amendment
• Travel Documents
• Cancellation
• The sales consultant modifies the Itinerary Document as needed.
• The sales consultant publishes the Itinerary Document and sends it to the customer via the built-in Email Composer
• The customer reviews the proposals and is given several standard options: 1. Reject the proposal; 2. Get back to the sales consultant with an additional question(s) and 3. Accept the proposal and select the option to BOOK.
• When options 1 or 2 are selected notification is sent to the sales consultant and the status of the Itinerary is updated accordingly
• When option 3 is selected the booking conversion process is triggered.
• Kaptio provides multiple ways to convert the itinerary to a booking (manual by a sales consultant or automated through the customer book option). In both cases, Kaptio Travel will produce a payment schedule based on configured business rules. The customer will be requested to make a deposit payment. Receiving the payment (automated or manual) triggers the creation of an Itinerary Document (Booking Confirmation) and its automatic delivery to the customer via Email.
• When the travel start date draws near, the Sales Consultant, Operational Support Staff or an automated process will generate an Itinerary Document (Travel documents), containing all vital information needed while travelling and deliver it to the customer via Email.
• If the Itinerary is cancelled, an Itinerary Document (Cancellation) is created (automated or manual) showing any cancellation fees that apply and delivered to the customer via Email.

Example Document

To help visualize the resulting documents, here is a short demo of an example online document:

https://share.getcloudapp.com/YEukyqmd

Kaptio Data Model

To understand the content generation process it is useful to have a high-level understanding of the underlying Kaptio Travel data model. For detailed object descriptions and relationships see Kaptio Developer Doc (see https://docs.kaptioapis.com/ ) and the standard Salesforce Object Modeler/Schema builder.

The High-Level Entity Relationship Diagram below provides a high-level overview of the objects relevant to Documents.

In the context of this document, relevant objects are divided into 4 groups:

• Document Setup: Channel, Template, Content, Content Assignment
• Assignment objects: Service, Price Category, Package, Package Day, Departure Template Location, Service Departure Location, Ship, Cabin, Image, Video
• Itinerary Data: Itinerary, Itinerary Item, Itinerary Service
• Document Generation: Itinerary Content, Itinerary Content Line Item, KObject

Document Setup Objects

For the context of this document, the relevant objects for document setup are:

• KaptioTravel__Channel__c: Channels define the selling channels for each Business Unit, and contain rules related to currency, language, pricing and templates.
• KaptioTravel__Template__c: Templates relate to a Channel and stage and consists of a set of components. The template controls what content gets pulled together for a specific Itinerary.
• KaptioTravel__Content__c: Content is a text article used in any number of customer-facing materials such as proposals and travel documents.
• KaptioTravel__ContentAssignment__c: Allows you to connect content articles with multiple sources (See Assignment Objects). So that the same articles could be re-used, instead of duplicating it in a system.

Assignment Objects

The Content Assignment object creates a relationship between a Content article and the entities it belongs to or media files that belong to it. The following is a list of objects that can be assigned to a content article:

• KaptioTravel__Item__c: Labelled Services. Products sold by the supplier are referred to as Services in Kaptio Travel. Services define individual Itinerary components such as accommodation, activities and car rental, defined by the record type.
• KaptioTravel__Price_Category__c: Price Categories relate to a Service and represent the variations of the products offered by the Service.
• KaptioTravel__Package__c: Packages are the parent object for all configurations of a package. It allows you to set up a combination of items to be booked together in a specific order and, in this case, content articles assigned as package summary and/or day summary.
• KaptioTravel__PackageDay__c: This object is not relevant to document generation but is solely mentioned for reasons of completeness. The package day component represents a specific day within the Itinerary. The current iteration allows for content to be attached as marketing content for websites or other channels.
• KaptioTravel__Location__c: Defines location hierarchy to control search and content. Content articles are assigned to a location and queried based on locations on services but the document engine can be set to collect articles from parent locations in addition to or instead of the location assigned to a service.
• KaptioTravel__DepartureTemplateLocation__c: Departure Templates define a template for the Itinerary of a cruise or a multi-day rail service. Departure Template Locations define locations within those Itinerary templates. Each Departure Template Location can be linked to a content article to give a general overview of the activities at that location within the context of the cruise/rail trip.
• KaptioTravel__ServiceDepartureLocation__c: Service Departures are defined as cruise or multi-day rail services. These use the Departure templates to generate the departure, including locations, which can then be overwritten per departure, if needed. Service Departure Locations are generated as a one-to-one copy of Departure Template Location but no content is assigned to them. The content engine will use the Departure Template Location content unless overwritten
• KaptioTravel__Ship__c: Defines Ships that Cruises are operated with.
• KaptioTravel__Cabin__c: Defines the cabins of a Ship
• KaptioTravel__Image__c: Stores link to an image to inject in content generation flow. By default, these are stored on AWS but can be configured to use other hosting services.
• KaptioTravel__Video__c: Stores link to a YouTube/Vimeo video to inject in content generation flow. No video hosting is part of the Kaptio Travel platform

Itinerary Data Objects

Kaptio Travel uses various objects to capture information related to the booking which can be surfaced on documents.

• KaptioTravel__Itinerary__c: An Itinerary is a key Object in Kaptio Travel as it is the parent object of the entire booking structure in Kaptio. Every booking at the highest level is represented by the Itinerary object. The Itinerary object contains a significant amount of financial information at a summarized level. At a very high level, the object provides insight into:
• Travel Dates (start and end)
• Total value (price) and outstanding balance
• Total value of Payments Received
• Costs (supplier costs, Re-seller Commission, additional charges).
• KaptioTravel__ItineraryItem__c: The ItineraryItem object provides detailed information by Booking line by Price Category and contains a few fields exclusively created for document display purposes. See table below (TODO).
• KaptioTravel__ItineraryService__c: This object aggregates information at the booking line and booking sub-line, including price categories, fees, meal plans, and add-ons (see conceptual example below).

Document Generation Objects

• KaptioTravel__ItineraryContent__c: The parent object of an Itinerary Document. This component is currently labelled as “Itinerary Content” but is set to be relabelled to “Itinerary Document” for increased clarity of the difference between Itinerary Documents and Content articles.
• KaptioTravel__ItineraryContentLineItem__c: Some template components allow for querying for multiple content articles. This object stores that selection information along with some additional details per selection and allows for configuring the selection during the content generation process.
• KaptioTravel__KObject__c: The KObject acts as a series of records that represent the output of the content generation engine. It stores two types of data:
• The actual output of the content generation document. Parts of this data are dynamic until the document is published at which time an HTML output is created and locked from editing to preserve the data of the Itinerary when published.
• The main document JSON file stores all edits made to the document. This allows for edits to be persisted between versions.

The Document Starter Kit

The Documents Starter kit was created to jumpstart the process of creating the branded documents needed to complete the customer journey.

With Kaptio Travel being built on the Salesforce platform, due to the restriction of managed packages, the document presentation code needs to be built as an extension to the Kaptio Travel system for it to be accessible and editable by our end users.

The Document Starter provides a fully out-of-the-box ready template that can be configured with a logo and colour scheme without touching any code. However, the code is also available to be used as reference or modified.

Installing the Starter Kit

Please reach out to Kaptio for the starter kit to be installed on your org.

Starter Kit Meta Data

Following is the component list for the starter kit. All files will follow the KTD_ prefix naming conventions to denote Kaptio Travel Documents.

Please note that this list may evolve with future updates.

Code

Static Resources

Static resources are files that can be referenced in documents. With the starter kit, Kaptio provides static resources called KaptioDocuments.

Custom Metadata Types

Custom Metadata Types (CMT) Custom metadata is customizable, deployable, packageable, and upgradeable application metadata. In the starter kit, we provide two custom metadata types which contain configuration settings that can be applied to one or many layouts.

Please note that this list may evolve with future updates.

Kaptio Document Settings Fields

Kaptio Document Date Formats Fields

Kaptio Document Date Formats Included Records

• General Business Flow
• Example Document
• Kaptio Data Model
• Document Setup Objects
• Assignment Objects
• Itinerary Data Objects
• Document Generation Objects
• The Document Starter Kit
• Installing the Starter Kit
• Starter Kit Meta Data
• Code
• Static Resources
• Custom Metadata Types
• Kaptio Document Settings Fields
• Kaptio Document Date Formats Fields
• Kaptio Document Date Formats Included Records