Script API Connection - AnalyticsGate/AGR-OnPrem-Setups GitHub Wiki

serverUri

Description

The Uri to the Qlik Server. This parameter is managed via the configuration file "config.hjson". It needs to be set manually only in complex environments.

Required: Yes

Example

serverUri: https://localhost/ser

app

Description

The Id of the app on which the report is based.

Required: Yes

Example

app: 0ade14e3-fcb0-469a-9ae6-b6a28ac6755d

retryTimeout

Description

This parameter should only be changed for the special case of a so-called in-app mode. This is only relevant for developers. This parameter is managed via the configuration file "config.hjson".

Note: If this parameter is changed, this will have a negative effect on the report creation time.

Default: 0

Example

retryTimeout: 0

sslVerify

Description

This parameter controls the certificate check. This can be switched on or off. It is only used for test purposes when dealing with certificate problems and should normally be activated. This parameter is managed via the configuration file "config.hjson".

Default: true

Example

sslVerify: false

sslValidThumbprints

Description

List of additional fingerprints of certificates for certificate verification. This parameter is managed via the configuration file "config.hjson".

Default: empty

Example

sslValidThumbprints: [
 {
   url: https://localhost/ser
   thumbprint: ‎a794accab24830f6751acb33eca65a7582878f80
 }
]

identities

Description

This parameter controls the identities for a websocket connection to Qlik. It is automatically assigned and managed and is only relevant for developers.

Example

[
   "936DA01F-9ABD-4D9D-80C7-02AF85C822A8"
]

credentials

Description

Contains settings for the type of authentication. This parameter is managed via the config.hjson configuration file. It is only relevant for developers.

Required: Yes

Example

credentials:
{
    key: X-Qlik-Session-ser
    type: SESSION
    cert: %appdata%\AnalyticsGate\AGR\certificates\serconnector.pem
    privateKey: %appdata%\AnalyticsGate\AGR\certificates\serconnector_private.key
}

lefs

Description

List of additional lef license codes. This parameter is intended for special cases and developers only.

Example

[
   "...LEF-CODE..."
]

licenseServers

Description

List of additional licensing servers for AnalyticsGate reporting.

Example

[
  {
    "serverUri": "https://examplehost",
    "location": "DE",
    "priority": "1"
  }
]

rendererServers

Description

List of additional renderer servers for AnalyticsGate reporting.

Example

[
  {
    "serverUri": "https://examplehost",
    "location": "DE",
    "priority": "1"
  }
]