qliksense.conf

If you use:

  • Remote Data Collector. Go to the Windows machine where RDC is installed (Example path is: C:\Program Files (x86)\Metric Insights\Insightd\plugins)
  • Local Data Collector. Go to the machine where MI is installed (Example path is:  /opt/mi/datacollector/plugins)

Open or create qliksense.conf file (for details, go to Create a Qlik Sense Configuration File)

UI Variables for Qlik Sense

All UI Variables can be specified in the Qlik Sense configuration file.

Variable name
 Description
Click through server
 Input "Click through server":
  • the URL to use for creating UI links back to your Qlik Sense server.
For example: https://qliksense-test.metricinsights.com.
NOTE: This is the same URL that you see when accessing Qlik Sense via your web browser.
Server
 Enter the Qlik Sense server:
  • with Scheme (http/https/wss://)  – for Secure protocol connection.
  • without Scheme  – for Unsecure connection.
For example: wss://qliksense-test.metricinsights.com
NOTE: If this variable is empty, the plugin uses the "Click through server" field value.
Sheet filter
 Specify the title(s) of your Qlik Sense Sheet(s).
Application filter
 Provide the name(s) of Application(s) you have created in Qlik Sense.
Object filter
 Input Qlik Sense Object name(s) that you want to be fetched to Metric Insights.
User domain
 Enter User Domain for your account. This Parameter is used for authentication.

Variables specified in the Qlik Sense configuration file

Below is a list of variables that can be defined in the qliksense.conf file.

Required variables:

  • client_key_path
  • client_key_pass

Optional variables:

  • all other variables are optional

NOTE

  1. As of Release 5.4.0 and beyond, chrome.exe (Chrome Browser) and chromedriver.exe (Chrome Driver) are included in the RDC package.
  2. pathToBrowser and pathToDriver variables are now specified optionally if you want to use your own Chrome Browser and Chrome Driver files instead.
  3. All Qlik Sense Filters (for Stream, App, Sheet and Object) support Wildcard Syntax. Possible wildcard symbols are:
    • The asterisk ( * ) representing any number of unknown characters/objects
    • The question mark ( ? ) representing only ONE unknown character/object
    • The exclamation mark ( ! ) representing excluded characters/objects
Variable name
 Description
REQUIRED PARAMETERS
client_key_path
 Specify a path to the client.pfx certificate file (or folder). The certificate contains the public key. Identification with certificates involves a cryptographic operation to show, that you are in the possession of the secret private key matching the public key in the (public) certificate. This private key is contained in the .pfx file.
client_key_pass
 Define a password to client.pfx
AVAILABLE ON THE UI
srv_url
 Input “Click through server” – the URL to use for creating UI links back to your Qlik Sense server.

For example: https://qliksense-test.metricinsights.com.
NOTE: This is the same URL that you see when accessing Qlik Sense via your web browser.
server
 Enter the Qlik Sense server:
  • with Scheme (http/https/wss://) – for Secure protocol connection
  • without Scheme – for Unsecure connection
For example: wss://qliksense-test.metricinsights.com
NOTE: If this variable is empty, the plugin uses the value of a field srv_url
stream_filter
 Enter Stream names (comma-separated) to narrow the list of Streams. Wildcard symbols (*, ?, !) are allowed.
app_filter
 Used to narrow the list of Qlik Sense Applications (comma-separated). Wildcard symbols (*, ?, !) are allowed.
sheet_filter Used to narrow the list of Qlik Sense Sheets (comma-separated). Wildcard symbols (*, ?, !) are allowed.
obj_name_filter
 Enter the names of Objects to narrow the list of Qlik Sense Documents (comma-separated) after download documents. Wild card symbols (*, ?, !) are allowed. (e.g., Social Media*, demo*)
user_domain
 Provide a User Domain for your Qlik Sense account. It is required for User authentication.
OPTIONAL PARAMETERS
imageSize
 This is a Boolean variable (true / false). Enable (or disable) the ability to resize the image fetched from Qlik Sense. If its value is "True", it is possible to set variables: Image_height, Image_width
image_height
 Enter the height value of the picture in pixels (0-5000) if you want to specify it.
image_width
 Enter the width value of the email picture in pixels (0-5000) if you want to specify it.
pathToBrowser
 Specify the path to chrome.exe (Chrome Browser)
pathToDriver
 Specify the path to chromedriver.exe (Chrome Driver)
datalocale
 Enter the data locale property (delimiters of decimal fraction). Can be DataLocale.US or DataLocale.EU or null.
  • If EU, the data parses with European type of delimiters (",").
  • If US or null – with standart (".").
primary_date_format
 Verify the list of supported Date Formats.