Kayxo Kayxo insight

Overview:How Kayxo Insight allows you to make and distribute your Application in Microsoft Outlook.

Kayxo Insight is a flexible set of tools that will allow you to build an Application that can manage data from any kind of backend system into Microsoft Outlook.
This article will guide you in the overall process that starts building an application and ends installing it in the end user’s machine.

Step one: Building an Application
You should start by downloading our Evaluation Version. You can always get the latest version here.

Kayxo Insight Evaluation Version and Kayxo Insight Full Version are both Developer and a Power User’s tools. The only difference between them is that the Evaluation Version does not need any valid license to run while the Full Version does, but we will touch upon licensing considerations later. The Evaluation Version will show occasionally some annoying pop-ups warning that it is an Evaluation Version, and is not intended for production environments.

With Kayxo Insight Full/Evaluation Version, you can add message stores, create folders, configure them, source information and map the fields to Outlook fields, set all the view preferences, use the out-of-the-box Datasources or develop and test you own Datasources. A Datasource is the .NET program that shows Kayxo Insight how to obtain your information to put it into Microsoft Oultook.

Kayxo Insight Full/Evaluation Version allows you to effectively build, test and configure an Application. Power Users could also use these versions to run Kayxo Insight Applications and configure their own without programming.

The detailed steps involved in building and configuring a Kayxo Insight Application are thoroughly explained in the following documents:

Application Programmers Tutorial
Application Programmers Reference

Step two: Packaging your Application
Ok, so you have a nice Application that sources data from your backend system, with neat folders, customized views, beautiful configuration, a few custom .NET inspectors and dozens of mapped fields from your system into Outlook. It only has one problem: it is in your machine, and as a rule in the software industry, the company is not selling your machine… How do you take it out?

The answer to this is the Import/Export tool. The Import/Export tool will export all the configuration you made in the selected Message Store, including the folder structure, the views, the mappings, the inspectors configuration, the free/busy configuration, etc. into a portable file (a PST file).

At this moment Kayxo OEM partners have the chance of using their OEM private key to sign the configuration they are exporting into the PST file. We will go back to this issue later, when we talk about licensing models.

The Import/Export tool’s documentation can be found inside the Application Programmer’s Tutorial mentioned in the previous step.

The tool itself is installed by the Kayxo Insight Full/Evaluation Edition in the “Northwind Sample” subdirectory of the folder that Insight was installed in, for example “c:\Program Files\Kayxo\Insight\Northwind Sample\ImportExportTool.exe”.

Step three: Distributing your Application
Let’s recap for a second. You have developed an application using Kayxo Insight and have some or all the following stuff that you need to distribute:

• Your own Datasources, which consist of DLLs that access to your custom system (if you are not using the out-of-the-box Datasources).
• Your own custom .NET Inspectors (if you are not using the Outlook default inspectors).
• Your own custom .NET controls for displaying data in Outlook Regions (if you are using this feature).
• A PST file with all your configuration and mappings (the one you made in step 2).

You also need to install something in the end-user’s machine that will allow his Outlook to recognize and understand the configuration, and let your Application behave exactly like it did in your machine. That something could be one of two things: Kayxo Insight Full Edition, or Kayxo Insight Runtime Edition.

The Kayxo Insight Runtime Edition has the same functionality that the Full edition has, except for all the configuration capabilities. Put into other words, it is intended for end-users and will not allow them to mess with the configuration you made when you developed the Application.

The Kayxo Insight Runtime Edition is a merge module, which means that it is designed to be included as a part of your own custom installer.
Here is the list of steps that your installer should do in order to successfully deploy an Application built with Kayxo Insight:

1. Install all the custom DLLs you made (Datasources, Inspectors, etc.)
2. Install the KI Runtime Edition by calling the merge-module.
3. Run the Import/Export tool taking the configuration PST as a parameter (this will create a new Message Store in the user’s Outlook, containing the exported folder structure and the entire configuration).

After you do this, the Application is ready to run. Well, almost: the user needs to have a valid license.

Licensing options with Kayxo Insight

Kayxo Insight currently supports two licensing models: floating licenses and OEM licenses.

The floating license model means that the client Company has to install a Kayxo License Server somewhere accessible from the client machines that will use Kayxo Insight. The License Server’s information and setup can be found here.

The License Server supports the amount of floating licenses bought, meaning that it will allow running any Kayxo Insight application in that number of Kayxo Insight clients simultaneously. Saying it backwards, a client machine with Kayxo Insight Full/Runtime Edition will run only if a valid license is available. Any Application installed in that machine will run, regardless of who developed it, so one license allows running any number of Applications.

The Floating Licensing model is suitable for VARs that would like to use Kayxo Insight as a part of particular projects for a small number of Customers.

The second licensing model is the OEM license. In the OEM model, the client machines don’t need any license to run the Application, but the Application has to be previously signed with a valid OEM private key provided by Kayxo. The application is signed when exported (see step 2). Signed Applications will run regardless of the license availability, and will stop running only if their configuration is changed after being signed and installed (i.e.: hacked).

The OEM licensing model is suitable for large scale distribution, when Kayxo Insight is not a part of a particular project with a known number of seats, but more an integral part of a Product.

For technical questions regarding the products or the documentation, please refer to support@kayxo.com
For more information about licensing and commercial information, please contact sales@kayxo.com