Welcome to our Knowledge Base
Tip: Start typing in the input box for immediate search results.
Connection Settings
The “Connection” portion of the AnalyticsGate Ribbon allows you to create and manage the connections AnalyticsGate makes to your Qlik Sense environment(s).
Once a connection is configured, use the “Sign In” and “Sign Out” buttons as described below.
Sign In
Sign In: Pressing the sign in button will attempt to connect to the Connection shown in the dropdown box above.
Sign Out
Sign Out: This will end your active connection to the server.
Edit
Edit: When not connected to a Qlik Server, this will open the Connections property window on the right side and allow
you to create a new manual connection or edit parameters of existing connections
A virtual proxy name that begins with X-Qlik-Session can be used by appending the name of the virtual proxy directly to the Url as follows:
There are two Connection creation techniques available, a manual process as well as a step-by-step Installation Wizard:
Create a Connection Using a Wizard
To use a step-by-step Wizard process to create a new Connection by following the steps below:
-
Go to the “Connection” section of the “AnalyticsGate” ribbon.
-
Sign Out if you are currently connected.
-
Use the Connections dropdown box and select “Create new connection to server” at the bottom of the list.
-
This will open the Wizard process in the AnalyticsGate Property Panel on the right side of your screen, prompt you to input required values and show detailed instructions.
Step 1: Enter a unique name for the connection you would like to create.
Step 2: Enter Url. Type this entry in manually or copy it from the address bar of a browser connected to Qlik Sense.
BEST PRACTICE: Choose a Connection name that will clearly identify the underlying source and be easy to pick out in a dropdown list.
Hitting the “Next” button will first attempt the default strategy of authenticating using the Windows credentials of the current user. If this approach works, a Connection Created! message will be displayed.
If your current, local Windows credentials cannot connect, you will be taken to Step 3. The underlying Connection type will be changed to “Sense Server – Custom authentication (via embedded Browser)” and prompt you for the appropriate credentials.
If you complete all steps of the Wizard and your Connection attempt is unsuccessful, you will need to begin the Wizard process again with different parameter values.
Confirm that your Url, username and password are correct and check with your Qlik Sense administrator for any Virtual Proxy or Header settings that may have been customized in your environment.
Press the Red X at any time to exit the Wizard
Manual Connection Creation
- Sign out of any active connection.
- Press “Edit” below the drop-down box. This will open the Connection control panel on the right side of the screen
- Press the “Add” button
- Fill the fields in the form with the appropriate values as described below
Connection Name
Enter a unique name for the connection.
BEST PRACTICE: Choose a Connection name which you can easily associate with the source system and find within a drop-down list.
Ignore Certificate Errors Checkbox
Sometimes Qlik Sense is run on a server without a valid security certificate. Checking this box will ignore https://certificate errors that are encountered and proceed with the connection anyway. Unchecking the box will allow the https:// chain to remain intact and provides the most security. The default setting is “checked”.
Connection Type
Depending on your Qlik Sense authorization strategy and which browser you are using, this parameter can be set to allow AnalyticsGate to work in any environment.
There are 5 different Connection types available:
Sense Desktop
This setting is included in the default AnalyticsGate installation and points to the local machine using 127.0.0.1 as the IP address.
If do not require use of Qlik Sense Desktop as a data source, this connection can be deleted. It can be re-created if needed by creating a new connection using the following parameters: Type: Qlik Sense Desktop and Url: ws: //127.0.0.1:4848.
Sense Server – Current Windows User
Like Qlik Sense, the default behavior of AnalyticsGate uses Windows authentication which passes the credentials of current Windows user to Qlik Sense. This approach supports Windows based single sign on strategies such as Active Directory.
Sense Server – Enter username/password
This approach is used when you have different credentials for Qlik Sense than your local windows machine. This approach works similar to Qlik Sense Forms authentication and will prompt for Qlik Sense credentials each time you log on. This requires the use of UserDirectory\UserId syntax for the user name.
Sense Server – Custom authentication (via embedded Browser)
This approach is used when you have different credentials for Qlik Sense than your local windows machine. This approach works similar to Qlik Sense Forms authentication and will prompt for Qlik Sense credentials each time you log on. This requires the use of UserDirectory\UserId syntax for the user name.
This technique will open attempt to connect with local Windows credentials first then, if not successful, open new embedded browser window then prompt for credentials and pass them to Qlik Sense via the browser session cookie to log in.
Use this approach when your local Windows credentials are different those used for Qlik or Connecting via a proxy server e.g.
or
When using 3third-party authentication like Okta e.g.
Specify Embedded Browser Type:
New in version 5.0 is the ability use MS Edge or Google Chrome in addition to MS Internet Explorer as the embedded browser type when making Connections to Qlik Sense.
To access this feature, you will need to enable it using the AnalyticsGate Settings panel.
On the AnalyticsGate ribbon, press the small triangle below the Settings button, then choose Settings.
This will open the AnalyticsGate Settings property panel on the right side of your screen.
Navigate to the Enable Browser Selection for Connection Type ‘Browser’ setting and switch it “on”.
Once this setting has been enabled, when choosing the “Sense Server – Custom Authentication via browser” connection type you will see a new parameter for “Browser”. Dropdown to select your preferred browser.
Connect to your Qlik Cloud
Use this connection type when connecting to Qlik Sense Cloud.
Qlik Sense Server Url
Enter the Url of your Qlik Sense cloud tenant e.g.
Session Cookie Header Name
This parameter should already be entered for this connection type. If not, use “-csrfToken” as the value.
API Key
You will need to have your Qlik Cloud administrator create an API Key for you or grant you the privilege to create your own.
If you have API Key creation privileges, from the Qlik Cloud Welcome Screen or the Hub, click on the initials icon on the top right of your screen then Settings>Management>API Keys>Generate New Key
At API key creation time, you will need to copy and paste it into a text file for use later or paste it directly into the AnalyticsGate API key parameter. After initial creation time you cannot access the key again and if you misplace it, you will need to generate a new one.
Additional Connection Information
3rd Party Sigle Sign On
If using OKTA or similar, choose “Sense Server – Custom authentication (via embedded Browser)” as your “Type” and enter your Url including /okta
Session cookie header name
AnalyticsGate supports defining connections that point to different virtual proxy servers in a distributed Qlik Sense environment.
A virtual proxy name that begins with X-Qlik-Session can be used by appending the name of the virtual proxy directly to the Url as follows:
Navigate back to the Connection section of the Ribbon, dropdown to choose the desired Connection and press “Sign In”
to Connect.
If your virtual proxy has a header name that begins with anything other than “X-Qlik-Session” enter it in the “Session cookie header name” field as follows: “Otherheadername” Save your new Connection by pressing the Green Check Button.
To exit the AnalyticsGate Property Panel press the grey “X” at the top right of the window.
Once you have created Connections using either technique you can edit or delete them by doing the following:
1. Press “Sign Out” to close any active connections.
2. Press the “Edit” below the Connections drop down box. This will open the Connection property panel
3. To Delete, select the desired connection and press the “Trash” icon.
4. To Edit, select the desired connection, press the “Pencil” icon and make your edits.
5. Press the Green Check button to save your changes.
6. Press the Grey “X” to exit the AnalyticsGate property panel.