Qlik Sense WebSocket Connectivity Tester

[Lisa_Sun]

Qlik Sense uses HTTP,  HTTPS, and WebSockets to transfer information to and from Qlik Sense.

The attached Webscoket Connectivity tester can be used to verify protocol compliance, indicating if a network policy, firewall, or other perimeter device is blocking any of the required connections.

If the tests return as unsuccessful, please engage your network team. 

The QlikSenseWEbsocketConnectivtyTester is not an officially supported application and is provided as is. It is intended to assist in troubleshooting, but further investigation of an unsuccessful test will require your network team's involvement. To run this tool, the Qlik Sense server must have a working internet connection.

Environment:

Qlik Sense Enterprise on Windows 

For Qlik Sense Enterprise on Windows November 2024 and later:

Since the introduction of extended WebSocket CSRF protection, using the WebSocket Connectivity tester on any version later than November 2024 requires a temporary configuration change.

1. Open the Proxy.exe.config stored in C:\Program Files\Qlik\Sense\Proxy\
2. Locate

   <add key="WebSocketCSWSHCheckEnabled" value="true"/> 

3. Change it to

   <add key="WebSocketCSWSHCheckEnabled" value="false"/> 

4. Restart the proxy
5. Run the WebSocket Connectivity tester
6. Revert the change

How to use the Websocket Connectivity Tester

1. Download the attached package or download the package from GitHub: https://github.com/flautrup/QlikSenseWebsocketConnectivityTester
2. Unzip the file
3. Login to the Qlik Sense Management Console
4. Create a Content Library
   
   
   1. Go to Content libraries 
   2. Click and Create New
   3. Name the Content Library: WebSocketTester
   4. Verify and modify the Security Rule
      
      Note that in our example, any user is allowed to access this WebSocketTester.
      
      
      
      
   5. Click Apply
      
      
5. Click Contents in the Associated items menu
6. Click Upload
7. Upload the QlikSenseWebsocketTest.html file.
8. Copy the correct URL from the URL path
   
   
   
   
9. Open a web browser (from any machine from which you wish to test the WebSocket connection).
10. Paste the URL path and prefix the fully qualified domain name and https. 
    
    Example: https://qlikserver3.domain.local/content/WebSocketTester/QlikSenseWebsocketTest.html
    
    

What to do if any of them fail?

Verify that WebSocket is enabled in the network infrastructure, such as firewalls, browsers, reverse proxies, etc.

See the article below under Related Content for additional steps.

Related Content

• Hub access times out with: Error Connection lost. Make sure that Qlik Sense is running properly 

[vincent_wei]

This will not work with the default setup of Qlik Sense November 2024 with Patch 5.

You must change the config file of the proxy. Otherwise, WebSockets testing will fail.

[Filippo_Nicolussi_P]

As per @vincent_wei 

Starting with introduction of Qlik Sense Enterprise on Windows: Extended WebSock... - Qlik Community - 2509211 and option below:

<add key="WebSocketCSWSHCheckEnabled" value="true"/> 

in "C:\Program Files\Qlik\Sense\Proxy\Proxy.exe.config" the WebSocket tester will fail. 

To be sure no other reasons are preventing the connection set the option to false:

<add key="WebSocketCSWSHCheckEnabled" value="false"/> 

restart the proxy and test again. 

Revert above option as needed once confirmed it is not related to the missed CSRF WebSocket Token.  

[fatinfazrizanor]

Hi,

We have followed the steps to change the Proxy.exe.config. After we revert the change (replace the original proxy.exe.config file) and restart the services, we cant access qlik sense via ssl url link, but able to access via ip address. 

The url link cant be open and stuck at this link 4244 during authentication.

https://abc.com:4244/internal_windows_authentication/?targetId=<guid>

What steps that we missed out during revert?