Bjornwa / server-side-extension

A Qlik server-side extension protocol for extending the Qlik built-in expression library with functionality from external calculation engines.

Server Side Extension

This repository provides a server-side extension (SSE) protocol based on gRPC that allows you to extend the Qlik built-in expression library with functionality from external calculation engines. You can use external calculations engines from both load script expressions and chart expressions. These SSE plugins are referred to as analytic connections by Qlik.
SSE is part of the Advanced Analytics Integration (AAI) concept at Qlik.
This repository includes documentation that describes the SSE protocol, how to use it and how to build your own plugins. Currently we have examples written in a few different languages only but examples in more languages will come later.

Status

Current Plugin Version and State: v1.0.0
Matching Qlik Sense Version: Qlik Sense June 2017 release (or later). Both desktop and enterprise.
Matching QlikView Version: QlikView November 2017 (or later). Both desktop and server.
Examples Disclaimer: The examples provided are just examples, therefore use them at your own risk.

Previous Versions

Documentation

• Overview
• Communication flow
• Generating certificates for secure connection
• Configuring SSE plugins in Qlik Sense and QlikView
• Writing an SSE plugin
• Protocol Documentation (API reference)

Examples

Python

• Getting started with the Python examples
• Writing an SSE plugin using Python

C++

• Writing an SSE Plugin using C++
• A basic example

C#

• Writing an SSE Plugin using C#
• The SSE R-plugin is written in C#

Java

• A basic Java example
• Writing an SSE plugin using Java

Go

• A basic Go example
• Writing an SSE Plugin using Go

Contributing

Please follow the instructions in CONTRIBUTING.md.