package qlik.sse

Get desktop application:
View/edit binary Protocol Buffers messages

* The communication service provided between the Qlik engine and the plugin.

• rpc GetCapabilities (Empty, Capabilities)

  ServerSideExtension.proto:139

  / A handshake call for the Qlik engine to retrieve the capability of the plugin.

  message Empty

  ServerSideExtension.proto:35

  * An empty message used when nothing is to be passed in a call.

  (message has no fields)

  message Capabilities

  ServerSideExtension.proto:68

  * A full description of the plugin, sent to the Qlik engine, listing all functions available and indicating whether script evaluation is allowed.

  • bool allowScript = 1

    / When true, the Qlik engine allows scripts to be sent to the plugin.

  • repeated FunctionDefinition functions = 2

    / The definitions of all available functions.

  • string pluginIdentifier = 3

    / The ID or name of the plugin.

  • string pluginVersion = 4

    / The version of the plugin.

• rpc ExecuteFunction (stream BundledRows, stream BundledRows)

  ServerSideExtension.proto:142

  / Requests a function to be executed as specified in the header.

• rpc EvaluateScript (stream BundledRows, stream BundledRows)

  ServerSideExtension.proto:145

  / Requests a script to be evaluated as specified in the header.

* A number of rows collected in one message. The actual number will depend on the size of each row and is adjusted to optimize throughput.

Used as request type in: Connector.EvaluateScript, Connector.ExecuteFunction

Used as response type in: Connector.EvaluateScript, Connector.ExecuteFunction

• repeated Row rows = 1

* A header sent at the start of both an EvaluateScript request and an ExecuteFunction request under the key "qlik-commonrequestheader-bin".

• string appId = 1

  / The ID of the app the request was executed in.

• string userId = 2

  / The ID of the user the request was executed by.

• int64 cardinality = 3

  / The cardinality of the parameters.

* Data types of the parameters and return values.

Used in: FieldDescription, FunctionDefinition, Parameter, ScriptRequestHeader

• STRING = 0

  / Contains only string.

• NUMERIC = 1

  / Contains only double.

• DUAL = 2

  / Contains both a string and a double.

* The basic data type for the data stream. Can contain double, string, or both.

Used in: Row

• double numData = 1

  / Numeric value as double.

• string strData = 2

  / String.

* Field definition for function and script calls.

Used in: TableDescription

• DataType dataType = 1

  / The data type of the field.

• string name = 2

  / The name of the field.

• repeated string tags = 3

  / The tags of the field.

* The definition of a function, which informs the Qlik engine how to use it.

Used in: Capabilities

• string name = 1

  / The name of the function.

• FunctionType functionType = 2

  / The type of the function.

• DataType returnType = 3

  / The return type of the function.

• repeated Parameter params = 4

  / The parameters the function takes.

• int32 functionId = 5

  / A unique ID number for the function, set by the plugin, to be used in calls from the Qlik engine to the plugin.

* A header sent at the start of an ExecuteFunction request under the key "qlik-functionrequestheader-bin".

• int32 functionId = 1

  / The ID of the function to be executed.

• string version = 2

  / A dummy variable as a workaround for an issue.

* Types of functions (determined by their return values).

Used in: FunctionDefinition, ScriptRequestHeader

• SCALAR = 0

  / The return value is a scalar per row.

• AGGREGATION = 1

  / All rows are aggregated into a single scalar.

• TENSOR = 2

  / Multiple rows in, multiple rows out.

* Parameter definition for functions and script calls.

Used in: FunctionDefinition, ScriptRequestHeader

• DataType dataType = 1

  / The data type of the parameter.

• string name = 2

  / The name of the parameter.

* A row of duals.

Used in: BundledRows

• repeated Dual duals = 1

  / Row of duals.

* A header sent at the start of an EvaluateScript request under the key "qlik-scriptrequestheader-bin".

• string script = 1

  / The script to be executed.

• FunctionType functionType = 2

  / The function type of the script evaluation: scalar, aggregation or tensor.

• DataType returnType = 3

  / The return type from the script evaluation: numeric, string or both.

• repeated Parameter params = 4

  / The parameters names and types passed to the script.

* A header sent before returning data to Qlik, under the key "qlik-tabledescription-bin".

• repeated FieldDescription fields = 1

  / The fields of the table.

• string name = 2

  / The name of the table.

• int64 numberOfRows = 3

  / Number of rows in table.